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.
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Type: Boolean
Required: No
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.
Type: String
Valid Values: disabled | enabled
Required: No
Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.
Type: String
Valid Values: disabled | enabled
Required: No
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
Type: Integer
Required: No
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.
Type: String
Valid Values: optional | required
Required: No
The ID of the instance.
Type: String
Required: Yes
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.
Type: String
Valid Values: disabled | enabled
Required: No
The following elements are returned by the service.
The ID of the instance.
Type: String
The metadata options for the instance.
Type: InstanceMetadataOptionsResponse object
The ID of the request.
Type: String
For information about the errors that are common to all actions, see Common client error codes.
Example 1: Turn on token requirementThe following example disables access to the instance metadata unless a session token is used in the instance metadata request header. To turn on token requirement, specify required
for HttpTokens
.
https://ec2.amazonaws.com/?Action=ModifyInstanceMetadataOptions
&InstanceId=i-1234567890abcdef0
&HttpTokens=required
&AUTHPARAMS
Sample Response
<ModifyInstanceMetadataOptions xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
<instanceId>i-1234567890abcdef0</instanceId>
<MetadataOptions>
<state>pending</state>
<HttpTokens>required</HttpTokens>
<HttpPutResponseHopLimit>1</HttpPutResponseHopLimit>
<HttpEndpoint>enabled</HttpEndpoint>
</MetadataOptions>
</ModifyInstanceMetadataOptions>
Example 2: Turn off access to instance metadata
The following example disables access to the instance metadata by changing the HTTP endpoint state to disabled. To turn off access to instance metadata, specify disabled
for HttpEndpoint
.
https://ec2.amazonaws.com/?Action=ModifyInstanceMetadataOptions
&InstanceId=i-1234567890abcdef0
&HttpEndpoint=disabled
&AUTHPARAMS
Sample Response
<ModifyInstanceMetadataOptions xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
<instanceId>i-1234567890abcdef0</instanceId>
<MetadataOptions>
<state>pending</state>
<HttpTokens>required</HttpTokens>
<HttpPutResponseHopLimit>1</HttpPutResponseHopLimit>
<HttpEndpoint>disabled</HttpEndpoint>
</MetadataOptions>
</ModifyInstanceMetadataOptions>
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4