LaunchTemplateInstanceMetadataOptions - Amazon Elastic Compute Cloud
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

LaunchTemplateInstanceMetadataOptions

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

Contents

httpEndpoint

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

Note

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

Type: String

Valid Values: disabled | enabled

Required: No

httpProtocolIpv6

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

Default: 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

Indicates whether IMDSv2 is required.

  • optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

  • required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

Type: String

Valid Values: optional | required

Required: No

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

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

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: