InstanceMetadataOptionsResponse

The metadata options for the instance.

httpEndpoint

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

Type: String

Valid Values: disabled | enabled

Required: No

httpProtocolIpv6

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

Type: String

Valid Values: disabled | enabled

Required: No

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

Type: Integer

Required: No

httpTokens

IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is optional (in other words, indicates whether the use of IMDSv2 is optional) or required (in other words, indicates whether the use of IMDSv2 is 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

Type: String

Valid Values: optional | required

Required: No

instanceMetadataTags

Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

Type: String

Valid Values: disabled | enabled

Required: No

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.

Type: String

Valid Values: pending | applied

Required: No

InstanceMetadataOptionsResponse

Contents

See Also