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.

Inheritance Hierarchy

System.Object
  Amazon.EC2.Model.InstanceMetadataOptionsRequest

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

Syntax

C#
public class InstanceMetadataOptionsRequest

The InstanceMetadataOptionsRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property HttpEndpoint Amazon.EC2.InstanceMetadataEndpointState

Gets and sets the property HttpEndpoint.

Enables or disables the HTTP metadata endpoint on your instances.

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

Default: enabled

Public Property HttpProtocolIpv6 Amazon.EC2.InstanceMetadataProtocolState

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 maximum number of hops that the metadata token can travel.

Possible values: Integers from 1 to 64

Public Property HttpTokens Amazon.EC2.HttpTokensState

Gets and sets the property HttpTokens.

Indicates whether IMDSv2 is required.

  • optional - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.

  • required - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.

Default:

  • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0 and the account level default is set to no-preference, the default is required.

  • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

Public Property InstanceMetadataTags Amazon.EC2.InstanceMetadataTagsState

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5