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

Class: Aws::KMS::Types::RetireGrantRequest

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 RetireGrantRequest data as a hash:

{
  grant_token: "GrantTokenType",
  key_id: "KeyIdType",
  grant_id: "GrantIdType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#grant_idString

Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

^

Returns:

  • (String)


2032
2033
2034
2035
2036
2037
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2032

class RetireGrantRequest < Struct.new(
  :grant_token,
  :key_id,
  :grant_id)
  include Aws::Structure
end

#grant_tokenString

Token that identifies the grant to be retired.

Returns:

  • (String)


2032
2033
2034
2035
2036
2037
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2032

class RetireGrantRequest < Struct.new(
  :grant_token,
  :key_id,
  :grant_id)
  include Aws::Structure
end

#key_idString

The Amazon Resource Name of the CMK associated with the grant. Example:

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

^

Returns:

  • (String)


2032
2033
2034
2035
2036
2037
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2032

class RetireGrantRequest < Struct.new(
  :grant_token,
  :key_id,
  :grant_id)
  include Aws::Structure
end