modify_instance_metadata_defaults¶
Operation¶
async
¶
modify_instance_metadata_defaults(input: ModifyInstanceMetadataDefaultsInput, plugins: list[Plugin] | None = None) -> ModifyInstanceMetadataDefaultsOutput
Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services
 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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyInstanceMetadataDefaultsInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ModifyInstanceMetadataDefaultsOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyInstanceMetadataDefaultsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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 is UnauthorizedOperation.
class-attribute
instance-attribute
¶
http_endpoint: str | None = ...
Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can't be accessed.
class-attribute
instance-attribute
¶
http_put_response_hop_limit: int | None = ...
The maximum number of hops that the metadata token can travel. To
indicate no preference, specify -1.
Possible values: Integers from 1 to 64, and -1 to indicate no
preference
class-attribute
instance-attribute
¶
http_tokens: str | None = ...
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.
class-attribute
instance-attribute
¶
http_tokens_enforced: str | None = ...
Specifies whether to enforce the requirement of IMDSv2 on an instance at
the time of launch. When enforcement is enabled, the instance can't
launch unless IMDSv2 (HttpTokens) is set to required. For more
information, see Enforce IMDSv2 at the account
level
in the Amazon EC2 User Guide.
class-attribute
instance-attribute
¶
instance_metadata_tags: str | None = ...
Enables or disables access to an instance's tags from the instance metadata. For more information, see View tags for your EC2 instances using instance metadata in the Amazon EC2 User Guide.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyInstanceMetadataDefaultsOutput structure.