ModifyInstanceMetadataOptionsRequest Class

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

public class ModifyInstanceMetadataOptionsRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The ModifyInstanceMetadataOptionsRequest type exposes the following members

Constructors

	Name	Description
	ModifyInstanceMetadataOptionsRequest()

Properties

Name	Type	Description
HttpEndpoint	Amazon.EC2.InstanceMetadataEndpointState	Gets and sets the property HttpEndpoint. Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained. If you specify a value of `disabled`, you cannot access your instance metadata.
HttpProtocolIpv6	Amazon.EC2.InstanceMetadataProtocolState	Gets and sets the property HttpProtocolIpv6. Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.
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
HttpTokens	Amazon.EC2.HttpTokensState	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. 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.
InstanceId	System.String	Gets and sets the property InstanceId. The ID of the instance.
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.

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