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

The metadata options for the instances. For more information, see Configuring * the Instance Metadata Options in the Amazon EC2 Auto Scaling User * Guide.

See Also:

AWS * API Reference

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

The state of token usage for your instance metadata requests. If the * parameter is not specified in the request, the default state is * optional.

If the state is optional, you can * choose to retrieve instance metadata with or without a signed token header on * your request. If you retrieve the IAM role credentials without a token, the * version 1.0 role credentials are returned. If you retrieve the IAM role * credentials using a valid signed token, the version 2.0 role credentials are * returned.

If the state is required, you must send a signed * token header with any instance metadata retrieval requests. In this state, * retrieving the IAM role credentials always returns the version 2.0 credentials; * the version 1.0 credentials are not available.

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

The state of token usage for your instance metadata requests. If the * parameter is not specified in the request, the default state is * optional.

If the state is optional, you can * choose to retrieve instance metadata with or without a signed token header on * your request. If you retrieve the IAM role credentials without a token, the * version 1.0 role credentials are returned. If you retrieve the IAM role * credentials using a valid signed token, the version 2.0 role credentials are * returned.

If the state is required, you must send a signed * token header with any instance metadata retrieval requests. In this state, * retrieving the IAM role credentials always returns the version 2.0 credentials; * the version 1.0 credentials are not available.

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

The state of token usage for your instance metadata requests. If the * parameter is not specified in the request, the default state is * optional.

If the state is optional, you can * choose to retrieve instance metadata with or without a signed token header on * your request. If you retrieve the IAM role credentials without a token, the * version 1.0 role credentials are returned. If you retrieve the IAM role * credentials using a valid signed token, the version 2.0 role credentials are * returned.

If the state is required, you must send a signed * token header with any instance metadata retrieval requests. In this state, * retrieving the IAM role credentials always returns the version 2.0 credentials; * the version 1.0 credentials are not available.

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

The state of token usage for your instance metadata requests. If the * parameter is not specified in the request, the default state is * optional.

If the state is optional, you can * choose to retrieve instance metadata with or without a signed token header on * your request. If you retrieve the IAM role credentials without a token, the * version 1.0 role credentials are returned. If you retrieve the IAM role * credentials using a valid signed token, the version 2.0 role credentials are * returned.

If the state is required, you must send a signed * token header with any instance metadata retrieval requests. In this state, * retrieving the IAM role credentials always returns the version 2.0 credentials; * the version 1.0 credentials are not available.

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

The state of token usage for your instance metadata requests. If the * parameter is not specified in the request, the default state is * optional.

If the state is optional, you can * choose to retrieve instance metadata with or without a signed token header on * your request. If you retrieve the IAM role credentials without a token, the * version 1.0 role credentials are returned. If you retrieve the IAM role * credentials using a valid signed token, the version 2.0 role credentials are * returned.

If the state is required, you must send a signed * token header with any instance metadata retrieval requests. In this state, * retrieving the IAM role credentials always returns the version 2.0 credentials; * the version 1.0 credentials are not available.

*/ inline InstanceMetadataOptions& WithHttpTokens(const InstanceMetadataHttpTokensState& value) { SetHttpTokens(value); return *this;} /** *

The state of token usage for your instance metadata requests. If the * parameter is not specified in the request, the default state is * optional.

If the state is optional, you can * choose to retrieve instance metadata with or without a signed token header on * your request. If you retrieve the IAM role credentials without a token, the * version 1.0 role credentials are returned. If you retrieve the IAM role * credentials using a valid signed token, the version 2.0 role credentials are * returned.

If the state is required, you must send a signed * token header with any instance metadata retrieval requests. In this state, * retrieving the IAM role credentials always returns the version 2.0 credentials; * the version 1.0 credentials are not available.

*/ inline InstanceMetadataOptions& WithHttpTokens(InstanceMetadataHttpTokensState&& 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

*/ 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

*/ 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

*/ 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

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

This parameter 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 InstanceMetadataEndpointState& GetHttpEndpoint() const{ return m_httpEndpoint; } /** *

This parameter 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; } /** *

This parameter 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 InstanceMetadataEndpointState& value) { m_httpEndpointHasBeenSet = true; m_httpEndpoint = value; } /** *

This parameter 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(InstanceMetadataEndpointState&& value) { m_httpEndpointHasBeenSet = true; m_httpEndpoint = std::move(value); } /** *

This parameter 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 InstanceMetadataOptions& WithHttpEndpoint(const InstanceMetadataEndpointState& value) { SetHttpEndpoint(value); return *this;} /** *

This parameter 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 InstanceMetadataOptions& WithHttpEndpoint(InstanceMetadataEndpointState&& value) { SetHttpEndpoint(std::move(value)); return *this;} private: InstanceMetadataHttpTokensState m_httpTokens; bool m_httpTokensHasBeenSet = false; int m_httpPutResponseHopLimit; bool m_httpPutResponseHopLimitHasBeenSet = false; InstanceMetadataEndpointState m_httpEndpoint; bool m_httpEndpointHasBeenSet = false; }; } // namespace Model } // namespace AutoScaling } // namespace Aws