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

  The constraints on the grant, such as encryption context pairs or a SourceArn, that restrict the subsequent operations 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.

• #grantee_service_principal ⇒ String

  The Amazon Web Services [service principal][1] 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.

• #retiring_service_principal ⇒ String

  The Amazon Web Services [service principal][1] that can retire the grant.

Instance Attribute Details

#constraints ⇒ Types::GrantConstraints

The constraints on the grant, such as encryption context pairs or a SourceArn, that restrict the subsequent operations the grant allows.

Returns:

• (Types::GrantConstraints)

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

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints,
  :grantee_service_principal,
  :retiring_service_principal)
  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 4069

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints,
  :grantee_service_principal,
  :retiring_service_principal)
  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 4069

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

#grantee_principal ⇒ String

The identity that gets the permissions in the grant.

When a grant is created with the GranteePrincipal field, the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, if the grantee principal is an Amazon Web Services service, the GranteePrincipal field contains an Amazon Web Services service principal, which might correspond to several different grantee principals, such as an IAM user, IAM role, or Amazon Web Services account.

Returns:

• (String)

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

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

#grantee_service_principal ⇒ String

The Amazon Web Services service principal that gets the permissions in the grant.

Returns:

• (String)

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

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints,
  :grantee_service_principal,
  :retiring_service_principal)
  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 4069

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints,
  :grantee_service_principal,
  :retiring_service_principal)
  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 4069

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints,
  :grantee_service_principal,
  :retiring_service_principal)
  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 4069

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints,
  :grantee_service_principal,
  :retiring_service_principal)
  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 4069

class GrantListEntry < Struct.new(
  :key_id,
  :grant_id,
  :name,
  :creation_date,
  :grantee_principal,
  :retiring_principal,
  :issuing_account,
  :operations,
  :constraints,
  :grantee_service_principal,
  :retiring_service_principal)
  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 4069

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

#retiring_service_principal ⇒ String

The Amazon Web Services service principal that can retire the grant.

Returns:

• (String)

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

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