modify_ebs_default_kms_key_id¶
Operation¶
modify_ebs_default_kms_key_id
¶
modify_ebs_default_kms_key_id(request: ModifyEbsDefaultKmsKeyIdInput | ModifyEbsDefaultKmsKeyIdInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyEbsDefaultKmsKeyIdInputDict]) -> ModifyEbsDefaultKmsKeyIdOutput
Changes the default KMS key for EBS encryption by default for your account in this Region.
Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. Amazon EBS does not support asymmetric KMS keys.
If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ModifyEbsDefaultKmsKeyIdInput | ModifyEbsDefaultKmsKeyIdInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ModifyEbsDefaultKmsKeyIdInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ModifyEbsDefaultKmsKeyIdOutput
|
An instance of |
modify_ebs_default_kms_key_id
async
¶
modify_ebs_default_kms_key_id(request: ModifyEbsDefaultKmsKeyIdInput | ModifyEbsDefaultKmsKeyIdInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyEbsDefaultKmsKeyIdInputDict]) -> ModifyEbsDefaultKmsKeyIdOutput
Changes the default KMS key for EBS encryption by default for your account in this Region.
Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. Amazon EBS does not support asymmetric KMS keys.
If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ModifyEbsDefaultKmsKeyIdInput | ModifyEbsDefaultKmsKeyIdInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ModifyEbsDefaultKmsKeyIdInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ModifyEbsDefaultKmsKeyIdOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ModifyEbsDefaultKmsKeyIdInputDict
¶
Bases: TypedDict
Dictionary form of ModifyEbsDefaultKmsKeyIdInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
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.
kms_key_id
instance-attribute
¶
The identifier of the KMS key to use for Amazon EBS encryption. If this
parameter is not specified, your KMS key for Amazon EBS is used. If
KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
-
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
-
Key alias. For example, alias/ExampleAlias.
-
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
-
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
Amazon EBS does not support asymmetric KMS keys.
ModifyEbsDefaultKmsKeyIdInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyEbsDefaultKmsKeyIdInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
kms_key_id
class-attribute
instance-attribute
¶
kms_key_id: str | None = ...
The identifier of the KMS key to use for Amazon EBS encryption. If this
parameter is not specified, your KMS key for Amazon EBS is used. If
KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
-
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
-
Key alias. For example, alias/ExampleAlias.
-
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
-
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
Amazon EBS does not support asymmetric KMS keys.
Output¶
ModifyEbsDefaultKmsKeyIdOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyEbsDefaultKmsKeyIdOutput structure.
Attributes¶
kms_key_id
class-attribute
instance-attribute
¶
kms_key_id: str | None = ...
The Amazon Resource Name (ARN) of the default KMS key for encryption by default.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.