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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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

To learn more about how to use this parameter, see Testing your permissions in the Key Management Service Developer Guide.

Returns:

  • (Boolean)


5823
5824
5825
5826
5827
5828
5829
5830
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5823

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

#grant_idString

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

  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

^

Returns:

  • (String)


5823
5824
5825
5826
5827
5828
5829
5830
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5823

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

#grant_tokenString

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.

Returns:

  • (String)


5823
5824
5825
5826
5827
5828
5829
5830
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5823

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

#key_idString

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)


5823
5824
5825
5826
5827
5828
5829
5830
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5823

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