/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Xml { class XmlNode; } // namespace Xml } // namespace Utils namespace EC2 { namespace Model { /** *

The metadata options for the instance. For more information, see Instance * metadata and user data in the Amazon Elastic Compute Cloud User * Guide.

See Also:

AWS * API Reference

*/ class LaunchTemplateInstanceMetadataOptions { public: AWS_EC2_API LaunchTemplateInstanceMetadataOptions(); AWS_EC2_API LaunchTemplateInstanceMetadataOptions(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_EC2_API LaunchTemplateInstanceMetadataOptions& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_EC2_API void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const; AWS_EC2_API void OutputToStream(Aws::OStream& oStream, const char* location) const; /** *

The state of the metadata option changes.

pending - The * metadata options are being updated and the instance is not ready to process * metadata traffic with the new selection.

applied - The * metadata options have been successfully applied on the instance.

*/ inline const LaunchTemplateInstanceMetadataOptionsState& GetState() const{ return m_state; } /** *

The state of the metadata option changes.

pending - The * metadata options are being updated and the instance is not ready to process * metadata traffic with the new selection.

applied - The * metadata options have been successfully applied on the instance.

*/ inline bool StateHasBeenSet() const { return m_stateHasBeenSet; } /** *

The state of the metadata option changes.

pending - The * metadata options are being updated and the instance is not ready to process * metadata traffic with the new selection.

applied - The * metadata options have been successfully applied on the instance.

*/ inline void SetState(const LaunchTemplateInstanceMetadataOptionsState& value) { m_stateHasBeenSet = true; m_state = value; } /** *

The state of the metadata option changes.

pending - The * metadata options are being updated and the instance is not ready to process * metadata traffic with the new selection.

applied - The * metadata options have been successfully applied on the instance.

*/ inline void SetState(LaunchTemplateInstanceMetadataOptionsState&& value) { m_stateHasBeenSet = true; m_state = std::move(value); } /** *

The state of the metadata option changes.

pending - The * metadata options are being updated and the instance is not ready to process * metadata traffic with the new selection.

applied - The * metadata options have been successfully applied on the instance.

*/ inline LaunchTemplateInstanceMetadataOptions& WithState(const LaunchTemplateInstanceMetadataOptionsState& value) { SetState(value); return *this;} /** *

The state of the metadata option changes.

pending - The * metadata options are being updated and the instance is not ready to process * metadata traffic with the new selection.

applied - The * metadata options have been successfully applied on the instance.

*/ inline LaunchTemplateInstanceMetadataOptions& WithState(LaunchTemplateInstanceMetadataOptionsState&& value) { SetState(std::move(value)); return *this;} /** *

Indicates whether IMDSv2 is optional or * required.

optional - When IMDSv2 is optional, * you can choose to retrieve instance metadata with or without a session token in * your request. If you retrieve the IAM role credentials without a token, the * IMDSv1 role credentials are returned. If you retrieve the IAM role credentials * using a valid session token, the IMDSv2 role credentials are returned.

* required - When IMDSv2 is required, you must send a session token * with any instance metadata retrieval requests. In this state, retrieving the IAM * role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not * available.

Default: optional

*/ inline const LaunchTemplateHttpTokensState& GetHttpTokens() const{ return m_httpTokens; } /** *

Indicates whether IMDSv2 is optional or * required.

optional - When IMDSv2 is optional, * you can choose to retrieve instance metadata with or without a session token in * your request. If you retrieve the IAM role credentials without a token, the * IMDSv1 role credentials are returned. If you retrieve the IAM role credentials * using a valid session token, the IMDSv2 role credentials are returned.

* required - When IMDSv2 is required, you must send a session token * with any instance metadata retrieval requests. In this state, retrieving the IAM * role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not * available.

Default: optional

*/ inline bool HttpTokensHasBeenSet() const { return m_httpTokensHasBeenSet; } /** *

Indicates whether IMDSv2 is optional or * required.

optional - When IMDSv2 is optional, * you can choose to retrieve instance metadata with or without a session token in * your request. If you retrieve the IAM role credentials without a token, the * IMDSv1 role credentials are returned. If you retrieve the IAM role credentials * using a valid session token, the IMDSv2 role credentials are returned.

* required - When IMDSv2 is required, you must send a session token * with any instance metadata retrieval requests. In this state, retrieving the IAM * role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not * available.

Default: optional

*/ inline void SetHttpTokens(const LaunchTemplateHttpTokensState& value) { m_httpTokensHasBeenSet = true; m_httpTokens = value; } /** *

Indicates whether IMDSv2 is optional or * required.

optional - When IMDSv2 is optional, * you can choose to retrieve instance metadata with or without a session token in * your request. If you retrieve the IAM role credentials without a token, the * IMDSv1 role credentials are returned. If you retrieve the IAM role credentials * using a valid session token, the IMDSv2 role credentials are returned.

* required - When IMDSv2 is required, you must send a session token * with any instance metadata retrieval requests. In this state, retrieving the IAM * role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not * available.

Default: optional

*/ inline void SetHttpTokens(LaunchTemplateHttpTokensState&& value) { m_httpTokensHasBeenSet = true; m_httpTokens = std::move(value); } /** *

Indicates whether IMDSv2 is optional or * required.

optional - When IMDSv2 is optional, * you can choose to retrieve instance metadata with or without a session token in * your request. If you retrieve the IAM role credentials without a token, the * IMDSv1 role credentials are returned. If you retrieve the IAM role credentials * using a valid session token, the IMDSv2 role credentials are returned.

* required - When IMDSv2 is required, you must send a session token * with any instance metadata retrieval requests. In this state, retrieving the IAM * role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not * available.

Default: optional

*/ inline LaunchTemplateInstanceMetadataOptions& WithHttpTokens(const LaunchTemplateHttpTokensState& value) { SetHttpTokens(value); return *this;} /** *

Indicates whether IMDSv2 is optional or * required.

optional - When IMDSv2 is optional, * you can choose to retrieve instance metadata with or without a session token in * your request. If you retrieve the IAM role credentials without a token, the * IMDSv1 role credentials are returned. If you retrieve the IAM role credentials * using a valid session token, the IMDSv2 role credentials are returned.

* required - When IMDSv2 is required, you must send a session token * with any instance metadata retrieval requests. In this state, retrieving the IAM * role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not * available.

Default: optional

*/ inline LaunchTemplateInstanceMetadataOptions& WithHttpTokens(LaunchTemplateHttpTokensState&& value) { SetHttpTokens(std::move(value)); return *this;} /** *

The desired HTTP PUT response hop limit for instance metadata requests. The * larger the number, the further instance metadata requests can travel.

*

Default: 1

Possible values: Integers from 1 to 64

*/ inline int GetHttpPutResponseHopLimit() const{ return m_httpPutResponseHopLimit; } /** *

The desired HTTP PUT response hop limit for instance metadata requests. The * larger the number, the further instance metadata requests can travel.

*

Default: 1

Possible values: Integers from 1 to 64

*/ inline bool HttpPutResponseHopLimitHasBeenSet() const { return m_httpPutResponseHopLimitHasBeenSet; } /** *

The desired HTTP PUT response hop limit for instance metadata requests. The * larger the number, the further instance metadata requests can travel.

*

Default: 1

Possible values: Integers from 1 to 64

*/ inline void SetHttpPutResponseHopLimit(int value) { m_httpPutResponseHopLimitHasBeenSet = true; m_httpPutResponseHopLimit = value; } /** *

The desired HTTP PUT response hop limit for instance metadata requests. The * larger the number, the further instance metadata requests can travel.

*

Default: 1

Possible values: Integers from 1 to 64

*/ inline LaunchTemplateInstanceMetadataOptions& WithHttpPutResponseHopLimit(int value) { SetHttpPutResponseHopLimit(value); return *this;} /** *

Enables or disables the HTTP metadata endpoint on your instances. If the * parameter is not specified, the default state is enabled.

*

If you specify a value of disabled, you will not be able * to access your instance metadata.

*/ inline const LaunchTemplateInstanceMetadataEndpointState& GetHttpEndpoint() const{ return m_httpEndpoint; } /** *

Enables or disables the HTTP metadata endpoint on your instances. If the * parameter is not specified, the default state is enabled.

*

If you specify a value of disabled, you will not be able * to access your instance metadata.

*/ inline bool HttpEndpointHasBeenSet() const { return m_httpEndpointHasBeenSet; } /** *

Enables or disables the HTTP metadata endpoint on your instances. If the * parameter is not specified, the default state is enabled.

*

If you specify a value of disabled, you will not be able * to access your instance metadata.

*/ inline void SetHttpEndpoint(const LaunchTemplateInstanceMetadataEndpointState& value) { m_httpEndpointHasBeenSet = true; m_httpEndpoint = value; } /** *

Enables or disables the HTTP metadata endpoint on your instances. If the * parameter is not specified, the default state is enabled.

*

If you specify a value of disabled, you will not be able * to access your instance metadata.

*/ inline void SetHttpEndpoint(LaunchTemplateInstanceMetadataEndpointState&& value) { m_httpEndpointHasBeenSet = true; m_httpEndpoint = std::move(value); } /** *

Enables or disables the HTTP metadata endpoint on your instances. If the * parameter is not specified, the default state is enabled.

*

If you specify a value of disabled, you will not be able * to access your instance metadata.

*/ inline LaunchTemplateInstanceMetadataOptions& WithHttpEndpoint(const LaunchTemplateInstanceMetadataEndpointState& value) { SetHttpEndpoint(value); return *this;} /** *

Enables or disables the HTTP metadata endpoint on your instances. If the * parameter is not specified, the default state is enabled.

*

If you specify a value of disabled, you will not be able * to access your instance metadata.

*/ inline LaunchTemplateInstanceMetadataOptions& WithHttpEndpoint(LaunchTemplateInstanceMetadataEndpointState&& value) { SetHttpEndpoint(std::move(value)); return *this;} /** *

Enables or disables the IPv6 endpoint for the instance metadata service.

*

Default: disabled

*/ inline const LaunchTemplateInstanceMetadataProtocolIpv6& GetHttpProtocolIpv6() const{ return m_httpProtocolIpv6; } /** *

Enables or disables the IPv6 endpoint for the instance metadata service.

*

Default: disabled

*/ inline bool HttpProtocolIpv6HasBeenSet() const { return m_httpProtocolIpv6HasBeenSet; } /** *

Enables or disables the IPv6 endpoint for the instance metadata service.

*

Default: disabled

*/ inline void SetHttpProtocolIpv6(const LaunchTemplateInstanceMetadataProtocolIpv6& value) { m_httpProtocolIpv6HasBeenSet = true; m_httpProtocolIpv6 = value; } /** *

Enables or disables the IPv6 endpoint for the instance metadata service.

*

Default: disabled

*/ inline void SetHttpProtocolIpv6(LaunchTemplateInstanceMetadataProtocolIpv6&& value) { m_httpProtocolIpv6HasBeenSet = true; m_httpProtocolIpv6 = std::move(value); } /** *

Enables or disables the IPv6 endpoint for the instance metadata service.

*

Default: disabled

*/ inline LaunchTemplateInstanceMetadataOptions& WithHttpProtocolIpv6(const LaunchTemplateInstanceMetadataProtocolIpv6& value) { SetHttpProtocolIpv6(value); return *this;} /** *

Enables or disables the IPv6 endpoint for the instance metadata service.

*

Default: disabled

*/ inline LaunchTemplateInstanceMetadataOptions& WithHttpProtocolIpv6(LaunchTemplateInstanceMetadataProtocolIpv6&& value) { SetHttpProtocolIpv6(std::move(value)); return *this;} /** *

Set to enabled to allow access to instance tags from the * instance metadata. Set to disabled to turn off access to instance * tags from the instance metadata. For more information, see Work * with instance tags using the instance metadata.

Default: * disabled

*/ inline const LaunchTemplateInstanceMetadataTagsState& GetInstanceMetadataTags() const{ return m_instanceMetadataTags; } /** *

Set to enabled to allow access to instance tags from the * instance metadata. Set to disabled to turn off access to instance * tags from the instance metadata. For more information, see Work * with instance tags using the instance metadata.

Default: * disabled

*/ inline bool InstanceMetadataTagsHasBeenSet() const { return m_instanceMetadataTagsHasBeenSet; } /** *

Set to enabled to allow access to instance tags from the * instance metadata. Set to disabled to turn off access to instance * tags from the instance metadata. For more information, see Work * with instance tags using the instance metadata.

Default: * disabled

*/ inline void SetInstanceMetadataTags(const LaunchTemplateInstanceMetadataTagsState& value) { m_instanceMetadataTagsHasBeenSet = true; m_instanceMetadataTags = value; } /** *

Set to enabled to allow access to instance tags from the * instance metadata. Set to disabled to turn off access to instance * tags from the instance metadata. For more information, see Work * with instance tags using the instance metadata.

Default: * disabled

*/ inline void SetInstanceMetadataTags(LaunchTemplateInstanceMetadataTagsState&& value) { m_instanceMetadataTagsHasBeenSet = true; m_instanceMetadataTags = std::move(value); } /** *

Set to enabled to allow access to instance tags from the * instance metadata. Set to disabled to turn off access to instance * tags from the instance metadata. For more information, see Work * with instance tags using the instance metadata.

Default: * disabled

*/ inline LaunchTemplateInstanceMetadataOptions& WithInstanceMetadataTags(const LaunchTemplateInstanceMetadataTagsState& value) { SetInstanceMetadataTags(value); return *this;} /** *

Set to enabled to allow access to instance tags from the * instance metadata. Set to disabled to turn off access to instance * tags from the instance metadata. For more information, see Work * with instance tags using the instance metadata.

Default: * disabled

*/ inline LaunchTemplateInstanceMetadataOptions& WithInstanceMetadataTags(LaunchTemplateInstanceMetadataTagsState&& value) { SetInstanceMetadataTags(std::move(value)); return *this;} private: LaunchTemplateInstanceMetadataOptionsState m_state; bool m_stateHasBeenSet = false; LaunchTemplateHttpTokensState m_httpTokens; bool m_httpTokensHasBeenSet = false; int m_httpPutResponseHopLimit; bool m_httpPutResponseHopLimitHasBeenSet = false; LaunchTemplateInstanceMetadataEndpointState m_httpEndpoint; bool m_httpEndpointHasBeenSet = false; LaunchTemplateInstanceMetadataProtocolIpv6 m_httpProtocolIpv6; bool m_httpProtocolIpv6HasBeenSet = false; LaunchTemplateInstanceMetadataTagsState m_instanceMetadataTags; bool m_instanceMetadataTagsHasBeenSet = false; }; } // namespace Model } // namespace EC2 } // namespace Aws