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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass ModifyEbsDefaultKmsKeyIdRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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)


34680
34681
34682
34683
34684
34685
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34680

class ModifyEbsDefaultKmsKeyIdRequest < Struct.new(
  :kms_key_id,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • 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.

Returns:

  • (String)


34680
34681
34682
34683
34684
34685
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34680

class ModifyEbsDefaultKmsKeyIdRequest < Struct.new(
  :kms_key_id,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end