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

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

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

Overview

Note:

When making an API call, you may pass RevokeGrantRequest data as a hash:

{
  key_id: "KeyIdType", # required
  grant_id: "GrantIdType", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#grant_idString

Identifier of the grant to be revoked.

Returns:

  • (String)


2174
2175
2176
2177
2178
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2174

class RevokeGrantRequest < Struct.new(
  :key_id,
  :grant_id)
  include Aws::Structure
end

#key_idString

A unique identifier for the customer master key associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey.

Returns:

  • (String)


2174
2175
2176
2177
2178
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2174

class RevokeGrantRequest < Struct.new(
  :key_id,
  :grant_id)
  include Aws::Structure
end