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

Class: Aws::KMS::Types::CancelKeyDeletionRequest

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

Overview

Note:

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

{
  key_id: "KeyIdType", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#key_idString

The unique identifier for the customer master key (CMK) for which to cancel deletion.

To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

  • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.

Returns:

  • (String)


59
60
61
62
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 59

class CancelKeyDeletionRequest < Struct.new(
  :key_id)
  include Aws::Structure
end