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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RetireGrantRequest as input to an Aws::Client method, you can use a vanilla 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)

    Unique identifier of the grant to retire.

#grant_tokenString

Token that identifies the grant to be retired.

Returns:

  • (String)

    Token that identifies the grant to be retired.

#key_idString

The Amazon Resource Name (ARN) of the CMK associated with the grant.

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

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the CMK associated with the grant.