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

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::RevokeGrantRequest

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 revoke.

• #key_id ⇒ String

  A unique identifier for the 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 5664

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

#grant_id ⇒ String

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

Returns:

• (String)

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

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

#key_id ⇒ String

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)

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

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