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.

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.HttpTokensState

Gets and sets the property HttpTokens.

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

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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