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

Class: Aws::KMS::Types::GrantListEntry

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

Overview

Contains information about an entry in a list of grants.

Instance Attribute Summary collapse

Instance Attribute Details

#constraintsTypes::GrantConstraints

A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1229

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints)
  include Aws::Structure
end

#creation_dateTime

The date and time when the grant was created.

Returns:

  • (Time)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1229

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints)
  include Aws::Structure
end

#grant_idString

The unique identifier for the grant.

Returns:

  • (String)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1229

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints)
  include Aws::Structure
end

#grantee_principalString

The principal that receives the grant's permissions.

Returns:

  • (String)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1229

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints)
  include Aws::Structure
end

#issuing_accountString

The AWS account under which the grant was issued.

Returns:

  • (String)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1229

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints)
  include Aws::Structure
end

#key_idString

The unique identifier for the customer master key (CMK) to which the grant applies.

Returns:

  • (String)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1229

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints)
  include Aws::Structure
end

#nameString

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

Returns:

  • (String)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1229

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints)
  include Aws::Structure
end

#operationsArray<String>

The list of operations permitted by the grant.

Returns:

  • (Array<String>)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1229

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints)
  include Aws::Structure
end

#retiring_principalString

The principal that can retire the grant.

Returns:

  • (String)


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1229

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints)
  include Aws::Structure
end