InstanceMetadataOptions Class | AWS SDK for .NET V3

The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.

Inheritance Hierarchy

System.Object
Amazon.AutoScaling.Model.InstanceMetadataOptions

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

Syntax

public class InstanceMetadataOptions

The InstanceMetadataOptions type exposes the following members

Constructors

	Name	Description
	InstanceMetadataOptions()

Properties

Name Type Description

Name	Type	Description
HttpEndpoint	Amazon.AutoScaling.InstanceMetadataEndpointState	Gets and sets the property HttpEndpoint. This parameter 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.
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
HttpTokens	Amazon.AutoScaling.InstanceMetadataHttpTokensState	Gets and sets the property HttpTokens. The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is `optional`. If the state is `optional`, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned. If the state is `required`, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

HttpEndpoint

Amazon.AutoScaling.InstanceMetadataEndpointState

Gets and sets the property HttpEndpoint.

This parameter 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.

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

HttpTokens

Amazon.AutoScaling.InstanceMetadataHttpTokensState

Gets and sets the property HttpTokens.

The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

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