AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.EC2.Model.LaunchTemplateInstanceMetadataOptions

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class LaunchTemplateInstanceMetadataOptions

The LaunchTemplateInstanceMetadataOptions type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property HttpEndpoint Amazon.EC2.LaunchTemplateInstanceMetadataEndpointState

Gets and sets the property 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.

Public Property HttpProtocolIpv6 Amazon.EC2.LaunchTemplateInstanceMetadataProtocolIpv6

Gets and sets the property HttpProtocolIpv6.

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

Default: disabled

Public Property HttpPutResponseHopLimit System.Int32

Gets and sets the property 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

Public Property HttpTokens Amazon.EC2.LaunchTemplateHttpTokensState

Gets and sets the property 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.

Public Property InstanceMetadataTags Amazon.EC2.LaunchTemplateInstanceMetadataTagsState

Gets and sets the property 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

Public Property State Amazon.EC2.LaunchTemplateInstanceMetadataOptionsState

Gets and sets the property 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5