AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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 a grant.

Constant Summary collapse

SENSITIVE =
[]

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.



2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2717

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

#creation_dateTime

The date and time when the grant was created.

Returns:

  • (Time)


2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2717

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

#grant_idString

The unique identifier for the grant.

Returns:

  • (String)


2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2717

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

#grantee_principalString

The identity that gets the permissions in the grant.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

Returns:

  • (String)


2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2717

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

#issuing_accountString

The AWS account under which the grant was issued.

Returns:

  • (String)


2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2717

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

#key_idString

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

Returns:

  • (String)


2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2717

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints)
  SENSITIVE = []
  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)


2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2717

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

#operationsArray<String>

The list of operations permitted by the grant.

Returns:

  • (Array<String>)


2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2717

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

#retiring_principalString

The principal that can retire the grant.

Returns:

  • (String)


2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2717

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