Class: Aws::EKS::Types::PodIdentityAssociation

Inherits:

Struct

• Object
• Struct
• Aws::EKS::Types::PodIdentityAssociation

Includes:

Structure

Defined in:

lib/aws-sdk-eks/types.rb

Overview

Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #association_arn ⇒ String

  The Amazon Resource Name (ARN) of the association.

• #association_id ⇒ String

  The ID of the association.

• #cluster_name ⇒ String

  The name of the cluster that the association is in.

• #created_at ⇒ Time

  The timestamp that the association was created at.

• #disable_session_tags ⇒ Boolean

  The state of the automatic sessions tags.

• #external_id ⇒ String

  The unique identifier for this EKS Pod Identity association for a target IAM role.

• #modified_at ⇒ Time

  The most recent timestamp that the association was modified at.

• #namespace ⇒ String

  The name of the Kubernetes namespace inside the cluster to create the association in.

• #owner_arn ⇒ String

  If defined, the EKS Pod Identity association is owned by an Amazon EKS add-on.

• #policy ⇒ String

  An optional IAM policy in JSON format (as an escaped string) that applies additional restrictions to this pod identity association beyond the IAM policies attached to the IAM role.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role to associate with the service account.

• #service_account ⇒ String

  The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

• #tags ⇒ Hash<String,String>

  Metadata that assists with categorization and organization.

• #target_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the target IAM role to associate with the service account.

Instance Attribute Details

#association_arn ⇒ String

The Amazon Resource Name (ARN) of the association.

# File 'lib/aws-sdk-eks/types.rb', line 6781

class PodIdentityAssociation < Struct.new(
  :cluster_name,
  :namespace,
  :service_account,
  :role_arn,
  :association_arn,
  :association_id,
  :tags,
  :created_at,
  :modified_at,
  :owner_arn,
  :disable_session_tags,
  :target_role_arn,
  :external_id,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#association_id ⇒ String

The ID of the association.

# File 'lib/aws-sdk-eks/types.rb', line 6781

class PodIdentityAssociation < Struct.new(
  :cluster_name,
  :namespace,
  :service_account,
  :role_arn,
  :association_arn,
  :association_id,
  :tags,
  :created_at,
  :modified_at,
  :owner_arn,
  :disable_session_tags,
  :target_role_arn,
  :external_id,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_name ⇒ String

The name of the cluster that the association is in.

# File 'lib/aws-sdk-eks/types.rb', line 6781

class PodIdentityAssociation < Struct.new(
  :cluster_name,
  :namespace,
  :service_account,
  :role_arn,
  :association_arn,
  :association_id,
  :tags,
  :created_at,
  :modified_at,
  :owner_arn,
  :disable_session_tags,
  :target_role_arn,
  :external_id,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp that the association was created at.

# File 'lib/aws-sdk-eks/types.rb', line 6781

class PodIdentityAssociation < Struct.new(
  :cluster_name,
  :namespace,
  :service_account,
  :role_arn,
  :association_arn,
  :association_id,
  :tags,
  :created_at,
  :modified_at,
  :owner_arn,
  :disable_session_tags,
  :target_role_arn,
  :external_id,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#disable_session_tags ⇒ Boolean

The state of the automatic sessions tags. The value of true disables these tags.

EKS Pod Identity adds a pre-defined set of session tags when it assumes the role. You can use these tags to author a single role that can work across resources by allowing access to Amazon Web Services resources based on matching tags. By default, EKS Pod Identity attaches six tags, including tags for cluster name, namespace, and service account name. For the list of tags added by EKS Pod Identity, see [List of session tags added by EKS Pod Identity] in the *Amazon EKS User Guide*.

[1]: docs.aws.amazon.com/eks/latest/userguide/pod-id-abac.html#pod-id-abac-tags

# File 'lib/aws-sdk-eks/types.rb', line 6781

class PodIdentityAssociation < Struct.new(
  :cluster_name,
  :namespace,
  :service_account,
  :role_arn,
  :association_arn,
  :association_id,
  :tags,
  :created_at,
  :modified_at,
  :owner_arn,
  :disable_session_tags,
  :target_role_arn,
  :external_id,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#external_id ⇒ String

The unique identifier for this EKS Pod Identity association for a target IAM role. You put this value in the trust policy of the target role, in a Condition to match the sts.ExternalId. This ensures that the target role can only be assumed by this association. This prevents the *confused deputy problem*. For more information about the confused deputy problem, see [The confused deputy problem] in the *IAM User Guide*.

If you want to use the same target role with multiple associations or other roles, use independent statements in the trust policy to allow sts:AssumeRole access from each role.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html

# File 'lib/aws-sdk-eks/types.rb', line 6781

class PodIdentityAssociation < Struct.new(
  :cluster_name,
  :namespace,
  :service_account,
  :role_arn,
  :association_arn,
  :association_id,
  :tags,
  :created_at,
  :modified_at,
  :owner_arn,
  :disable_session_tags,
  :target_role_arn,
  :external_id,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#modified_at ⇒ Time

The most recent timestamp that the association was modified at.

# File 'lib/aws-sdk-eks/types.rb', line 6781

class PodIdentityAssociation < Struct.new(
  :cluster_name,
  :namespace,
  :service_account,
  :role_arn,
  :association_arn,
  :association_id,
  :tags,
  :created_at,
  :modified_at,
  :owner_arn,
  :disable_session_tags,
  :target_role_arn,
  :external_id,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The name of the Kubernetes namespace inside the cluster to create the association in. The service account and the Pods that use the service account must be in this namespace.

# File 'lib/aws-sdk-eks/types.rb', line 6781

class PodIdentityAssociation < Struct.new(
  :cluster_name,
  :namespace,
  :service_account,
  :role_arn,
  :association_arn,
  :association_id,
  :tags,
  :created_at,
  :modified_at,
  :owner_arn,
  :disable_session_tags,
  :target_role_arn,
  :external_id,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#owner_arn ⇒ String

If defined, the EKS Pod Identity association is owned by an Amazon EKS add-on.

# File 'lib/aws-sdk-eks/types.rb', line 6781

class PodIdentityAssociation < Struct.new(
  :cluster_name,
  :namespace,
  :service_account,
  :role_arn,
  :association_arn,
  :association_id,
  :tags,
  :created_at,
  :modified_at,
  :owner_arn,
  :disable_session_tags,
  :target_role_arn,
  :external_id,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#policy ⇒ String

An optional IAM policy in JSON format (as an escaped string) that applies additional restrictions to this pod identity association beyond the IAM policies attached to the IAM role. This policy is applied as the intersection of the role’s policies and this policy, allowing you to reduce the permissions that applications in the pods can use. Use this policy to enforce least privilege access while still leveraging a shared IAM role across multiple applications.

# File 'lib/aws-sdk-eks/types.rb', line 6781

class PodIdentityAssociation < Struct.new(
  :cluster_name,
  :namespace,
  :service_account,
  :role_arn,
  :association_arn,
  :association_id,
  :tags,
  :created_at,
  :modified_at,
  :owner_arn,
  :disable_session_tags,
  :target_role_arn,
  :external_id,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity agent manages credentials to assume this role for applications in the containers in the Pods that use this service account.

# File 'lib/aws-sdk-eks/types.rb', line 6781

class PodIdentityAssociation < Struct.new(
  :cluster_name,
  :namespace,
  :service_account,
  :role_arn,
  :association_arn,
  :association_id,
  :tags,
  :created_at,
  :modified_at,
  :owner_arn,
  :disable_session_tags,
  :target_role_arn,
  :external_id,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#service_account ⇒ String

The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

# File 'lib/aws-sdk-eks/types.rb', line 6781

class PodIdentityAssociation < Struct.new(
  :cluster_name,
  :namespace,
  :service_account,
  :role_arn,
  :association_arn,
  :association_id,
  :tags,
  :created_at,
  :modified_at,
  :owner_arn,
  :disable_session_tags,
  :target_role_arn,
  :external_id,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don’t propagate to any other cluster or Amazon Web Services resources.

The following basic restrictions apply to tags:

• Maximum number of tags per resource – 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length – 128 Unicode characters in UTF-8

• Maximum value length – 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

# File 'lib/aws-sdk-eks/types.rb', line 6781

class PodIdentityAssociation < Struct.new(
  :cluster_name,
  :namespace,
  :service_account,
  :role_arn,
  :association_arn,
  :association_id,
  :tags,
  :created_at,
  :modified_at,
  :owner_arn,
  :disable_session_tags,
  :target_role_arn,
  :external_id,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#target_role_arn ⇒ String

The Amazon Resource Name (ARN) of the target IAM role to associate with the service account. This role is assumed by using the EKS Pod Identity association role, then the credentials for this role are injected into the Pod.

# File 'lib/aws-sdk-eks/types.rb', line 6781

class PodIdentityAssociation < Struct.new(
  :cluster_name,
  :namespace,
  :service_account,
  :role_arn,
  :association_arn,
  :association_id,
  :tags,
  :created_at,
  :modified_at,
  :owner_arn,
  :disable_session_tags,
  :target_role_arn,
  :external_id,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end