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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.



3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
# File 'lib/aws-sdk-kms/types.rb', line 3756

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)


3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
# File 'lib/aws-sdk-kms/types.rb', line 3756

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)


3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
# File 'lib/aws-sdk-kms/types.rb', line 3756

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 Amazon Web Services service, the `GranteePrincipal` field contains the [service principal], which might represent several different grantee principals.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services

Returns:

  • (String)


3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
# File 'lib/aws-sdk-kms/types.rb', line 3756

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 Amazon Web Services account under which the grant was issued.

Returns:

  • (String)


3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
# File 'lib/aws-sdk-kms/types.rb', line 3756

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 KMS key to which the grant applies.

Returns:

  • (String)


3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
# File 'lib/aws-sdk-kms/types.rb', line 3756

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)


3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
# File 'lib/aws-sdk-kms/types.rb', line 3756

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>)


3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
# File 'lib/aws-sdk-kms/types.rb', line 3756

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)


3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
# File 'lib/aws-sdk-kms/types.rb', line 3756

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