Class: Aws::KMS::Types::RevokeGrantRequest

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 KMS API calls in the Key Management Service Developer Guide.

Returns:

  • (Boolean)


5322
5323
5324
5325
5326
5327
5328
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5322

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

#grant_idString

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

Returns:

  • (String)


5322
5323
5324
5325
5326
5327
5328
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5322

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

#key_idString

A unique identifier for the KMS key associated with the grant. To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

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

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

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Returns:

  • (String)


5322
5323
5324
5325
5326
5327
5328
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5322

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