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.

Container for the parameters to the ModifyInstanceMetadataOptions operation. Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.ModifyInstanceMetadataOptionsRequest

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

Syntax

C#
public class ModifyInstanceMetadataOptionsRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The ModifyInstanceMetadataOptionsRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property HttpEndpoint Amazon.EC2.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 existing state is maintained.

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

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. If no parameter is specified, the existing state is maintained.

Possible values: Integers from 1 to 64

Public Property HttpTokens Amazon.EC2.HttpTokensState

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 credential always returns the version 2.0 credentials; the version 1.0 credentials are not available.

Public Property InstanceId System.String

Gets and sets the property InstanceId.

The ID of 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