You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::ModifyEbsDefaultKmsKeyIdRequest

Inherits:

Struct

Object
Struct
Aws::EC2::Types::ModifyEbsDefaultKmsKeyIdRequest

show all

Defined in:: (unknown)

Overview

Note:

When passing ModifyEbsDefaultKmsKeyIdRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  kms_key_id: "KmsKeyId", # required
  dry_run: false,
}

Instance Attribute Summary collapse

#dry_run ⇒ Boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
#kms_key_id ⇒ String
The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption.

Instance Attribute Details

#dry_run ⇒ `Boolean`

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.

Returns:

(Boolean) —
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#kms_key_id ⇒ `String`

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK 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.

AWS authenticates the CMK 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 CMKs.