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

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::RetireGrantRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kms/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks if your request will succeed.

• #grant_id ⇒ String

  Identifies the grant to retire.

• #grant_token ⇒ String

  Identifies the grant to be retired.

• #key_id ⇒ String

  The key ARN KMS key associated with the grant.

Instance Attribute Details

#dry_run ⇒ Boolean

Checks if your request will succeed. ‘DryRun` is an optional parameter.

To learn more about how to use this parameter, see [Testing your KMS API calls] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html

Returns:

• (Boolean)

# File 'lib/aws-sdk-kms/types.rb', line 5616

class RetireGrantRequest < Struct.new(
  :grant_token,
  :key_id,
  :grant_id,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#grant_id ⇒ String

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

^

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 5616

class RetireGrantRequest < Struct.new(
  :grant_token,
  :key_id,
  :grant_id,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#grant_token ⇒ String

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see [Grant token] and [Eventual consistency] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token [2]: docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 5616

class RetireGrantRequest < Struct.new(
  :grant_token,
  :key_id,
  :grant_id,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#key_id ⇒ String

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

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

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 5616

class RetireGrantRequest < Struct.new(
  :grant_token,
  :key_id,
  :grant_id,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end