ModifyInstanceMetadataDefaults
Modifies the default instance metadata service (IMDS) settings at the account level in the specified AWS Region.
Note
To remove a parameter's account-level default setting, specify
no-preference. If an account-level setting is cleared with
no-preference, then the instance launch considers the other
instance metadata settings. For more information, see Order of precedence for instance metadata options in the
Amazon EC2 User Guide.
Request Parameters
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.
- DryRun
-
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation. Otherwise, it isUnauthorizedOperation.Type: Boolean
Required: No
- HttpEndpoint
-
Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can't be accessed.
Type: String
Valid Values:
disabled | enabled | no-preferenceRequired: No
- HttpPutResponseHopLimit
-
The maximum number of hops that the metadata token can travel. To indicate no preference, specify
-1.Possible values: Integers from
1to64, and-1to indicate no preferenceType: Integer
Required: No
- HttpTokens
-
Indicates whether IMDSv2 is required.
-
optional– IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1. -
required– IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.
Type: String
Valid Values:
optional | required | no-preferenceRequired: No
-
- InstanceMetadataTags
-
Enables or disables access to an instance's tags from the instance metadata. For more information, see Work with instance tags using the instance metadata in the Amazon EC2 User Guide.
Type: String
Valid Values:
disabled | enabled | no-preferenceRequired: No
Response Elements
The following elements are returned by the service.
- requestId
-
The ID of the request.
Type: String
- return
-
If the request succeeds, the response returns
true. If the request fails, no response is returned, and instead an error message is returned.Type: Boolean
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
