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

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::GrantListEntry

Defined in:

gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb

Overview

Contains information about a grant.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #constraints ⇒ Types::GrantConstraints

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

• #creation_date ⇒ Time

  The date and time when the grant was created.

• #grant_id ⇒ String

  The unique identifier for the grant.

• #grantee_principal ⇒ String

  The identity that gets the permissions in the grant.

• #issuing_account ⇒ String

  The Amazon Web Services account under which the grant was issued.

• #key_id ⇒ String

  The unique identifier for the KMS key to which the grant applies.

• #name ⇒ String

  The friendly name that identifies the grant.

• #operations ⇒ Array<String>

  The list of operations permitted by the grant.

• #retiring_principal ⇒ String

  The principal that can retire the grant.

Instance Attribute Details

#constraints ⇒ Types::GrantConstraints

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

Returns:

• (Types::GrantConstraints)

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

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_date ⇒ Time

The date and time when the grant was created.

Returns:

• (Time)

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

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_id ⇒ String

The unique identifier for the grant.

Returns:

• (String)

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

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_principal ⇒ String

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.

Returns:

• (String)

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

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_account ⇒ String

The Amazon Web Services account under which the grant was issued.

Returns:

• (String)

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

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_id ⇒ String

The unique identifier for the KMS key to which the grant applies.

Returns:

• (String)

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

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

#name ⇒ String

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)

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

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

#operations ⇒ Array<String>

The list of operations permitted by the grant.

Returns:

• (Array<String>)

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

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_principal ⇒ String

The principal that can retire the grant.

Returns:

• (String)

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

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