Modify Instance Metadata Defaults
ec2_modify_instance_metadata_defaults | R Documentation |
Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region¶
Description¶
Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.
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.
Usage¶
ec2_modify_instance_metadata_defaults(HttpTokens,
HttpPutResponseHopLimit, HttpEndpoint, InstanceMetadataTags, DryRun)
Arguments¶
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.
HttpPutResponseHopLimit
The maximum number of hops that the metadata token can travel. To indicate no preference, specify
-1
.Possible values: Integers from
1
to64
, and-1
to indicate no preferenceHttpEndpoint
Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can't be accessed.
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.
DryRun
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 isUnauthorizedOperation
.
Value¶
A list with the following syntax: