/** * 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 EC2 { namespace Model { /** */ class ModifyInstanceMetadataOptionsRequest : public EC2Request { public: AWS_EC2_API ModifyInstanceMetadataOptionsRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "ModifyInstanceMetadataOptions"; } AWS_EC2_API Aws::String SerializePayload() const override; protected: AWS_EC2_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The ID of the instance.

*/ inline const Aws::String& GetInstanceId() const{ return m_instanceId; } /** *

The ID of the instance.

*/ inline bool InstanceIdHasBeenSet() const { return m_instanceIdHasBeenSet; } /** *

The ID of the instance.

*/ inline void SetInstanceId(const Aws::String& value) { m_instanceIdHasBeenSet = true; m_instanceId = value; } /** *

The ID of the instance.

*/ inline void SetInstanceId(Aws::String&& value) { m_instanceIdHasBeenSet = true; m_instanceId = std::move(value); } /** *

The ID of the instance.

*/ inline void SetInstanceId(const char* value) { m_instanceIdHasBeenSet = true; m_instanceId.assign(value); } /** *

The ID of the instance.

*/ inline ModifyInstanceMetadataOptionsRequest& WithInstanceId(const Aws::String& value) { SetInstanceId(value); return *this;} /** *

The ID of the instance.

*/ inline ModifyInstanceMetadataOptionsRequest& WithInstanceId(Aws::String&& value) { SetInstanceId(std::move(value)); return *this;} /** *

The ID of the instance.

*/ inline ModifyInstanceMetadataOptionsRequest& WithInstanceId(const char* value) { SetInstanceId(value); return *this;} /** *

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to * optional (in other words, set the use of IMDSv2 to * optional) or required (in other words, set the use of * IMDSv2 to 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 HttpTokensState& GetHttpTokens() const{ return m_httpTokens; } /** *

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to * optional (in other words, set the use of IMDSv2 to * optional) or required (in other words, set the use of * IMDSv2 to 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; } /** *

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to * optional (in other words, set the use of IMDSv2 to * optional) or required (in other words, set the use of * IMDSv2 to 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 HttpTokensState& value) { m_httpTokensHasBeenSet = true; m_httpTokens = value; } /** *

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to * optional (in other words, set the use of IMDSv2 to * optional) or required (in other words, set the use of * IMDSv2 to 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(HttpTokensState&& value) { m_httpTokensHasBeenSet = true; m_httpTokens = std::move(value); } /** *

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to * optional (in other words, set the use of IMDSv2 to * optional) or required (in other words, set the use of * IMDSv2 to 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 ModifyInstanceMetadataOptionsRequest& WithHttpTokens(const HttpTokensState& value) { SetHttpTokens(value); return *this;} /** *

IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to * optional (in other words, set the use of IMDSv2 to * optional) or required (in other words, set the use of * IMDSv2 to 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 ModifyInstanceMetadataOptionsRequest& WithHttpTokens(HttpTokensState&& 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. If no * parameter is specified, the existing state is maintained.

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. If no * parameter is specified, the existing state is maintained.

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. If no * parameter is specified, the existing state is maintained.

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. If no * parameter is specified, the existing state is maintained.

Possible * values: Integers from 1 to 64

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

Enables or disables the HTTP metadata endpoint on your instances. If this * parameter is not specified, the existing state is maintained.

If you * specify a value of disabled, you cannot access your instance * metadata.

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

Enables or disables the HTTP metadata endpoint on your instances. If this * parameter is not specified, the existing state is maintained.

If you * specify a value of disabled, you cannot access your instance * metadata.

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

Enables or disables the HTTP metadata endpoint on your instances. If this * parameter is not specified, the existing state is maintained.

If you * specify a value of disabled, you cannot access your instance * metadata.

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

Enables or disables the HTTP metadata endpoint on your instances. If this * parameter is not specified, the existing state is maintained.

If you * specify a value of disabled, you cannot access your instance * metadata.

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

Enables or disables the HTTP metadata endpoint on your instances. If this * parameter is not specified, the existing state is maintained.

If you * specify a value of disabled, you cannot access your instance * metadata.

*/ inline ModifyInstanceMetadataOptionsRequest& WithHttpEndpoint(const InstanceMetadataEndpointState& value) { SetHttpEndpoint(value); return *this;} /** *

Enables or disables the HTTP metadata endpoint on your instances. If this * parameter is not specified, the existing state is maintained.

If you * specify a value of disabled, you cannot access your instance * metadata.

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

Checks whether you have the required permissions for the action, without * actually making the request, and provides an error response. If you have the * required permissions, the error response is DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline bool GetDryRun() const{ return m_dryRun; } /** *

Checks whether you have the required permissions for the action, without * actually making the request, and provides an error response. If you have the * required permissions, the error response is DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline bool DryRunHasBeenSet() const { return m_dryRunHasBeenSet; } /** *

Checks whether you have the required permissions for the action, without * actually making the request, and provides an error response. If you have the * required permissions, the error response is DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline void SetDryRun(bool value) { m_dryRunHasBeenSet = true; m_dryRun = value; } /** *

Checks whether you have the required permissions for the action, without * actually making the request, and provides an error response. If you have the * required permissions, the error response is DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline ModifyInstanceMetadataOptionsRequest& WithDryRun(bool value) { SetDryRun(value); return *this;} /** *

Enables or disables the IPv6 endpoint for the instance metadata service. * Applies only if you enabled the HTTP metadata endpoint.

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

Enables or disables the IPv6 endpoint for the instance metadata service. * Applies only if you enabled the HTTP metadata endpoint.

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

Enables or disables the IPv6 endpoint for the instance metadata service. * Applies only if you enabled the HTTP metadata endpoint.

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

Enables or disables the IPv6 endpoint for the instance metadata service. * Applies only if you enabled the HTTP metadata endpoint.

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

Enables or disables the IPv6 endpoint for the instance metadata service. * Applies only if you enabled the HTTP metadata endpoint.

*/ inline ModifyInstanceMetadataOptionsRequest& WithHttpProtocolIpv6(const InstanceMetadataProtocolState& value) { SetHttpProtocolIpv6(value); return *this;} /** *

Enables or disables the IPv6 endpoint for the instance metadata service. * Applies only if you enabled the HTTP metadata endpoint.

*/ inline ModifyInstanceMetadataOptionsRequest& WithHttpProtocolIpv6(InstanceMetadataProtocolState&& 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 InstanceMetadataTagsState& 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 InstanceMetadataTagsState& 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(InstanceMetadataTagsState&& 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 ModifyInstanceMetadataOptionsRequest& WithInstanceMetadataTags(const InstanceMetadataTagsState& 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 ModifyInstanceMetadataOptionsRequest& WithInstanceMetadataTags(InstanceMetadataTagsState&& value) { SetInstanceMetadataTags(std::move(value)); return *this;} private: Aws::String m_instanceId; bool m_instanceIdHasBeenSet = false; HttpTokensState m_httpTokens; bool m_httpTokensHasBeenSet = false; int m_httpPutResponseHopLimit; bool m_httpPutResponseHopLimitHasBeenSet = false; InstanceMetadataEndpointState m_httpEndpoint; bool m_httpEndpointHasBeenSet = false; bool m_dryRun; bool m_dryRunHasBeenSet = false; InstanceMetadataProtocolState m_httpProtocolIpv6; bool m_httpProtocolIpv6HasBeenSet = false; InstanceMetadataTagsState m_instanceMetadataTags; bool m_instanceMetadataTagsHasBeenSet = false; }; } // namespace Model } // namespace EC2 } // namespace Aws