aws-cdk-lib.aws_eks_v2.CfnPodIdentityAssociationProps

CfnPodIdentityAssociationProps Struct

Properties for defining a CfnPodIdentityAssociation.

CfnPodIdentityAssociationProps

used as props by

• CfnPodIdentityAssociation

Source

Generated code

Type last changed

v2.268.0 · 2 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eks_v2 as eks_v2 } from 'aws-cdk-lib';
const cfnPodIdentityAssociationProps: eks_v2.CfnPodIdentityAssociationProps = {
  clusterName: 'clusterName',
  namespace: 'namespace',
  roleArn: 'roleArn',
  serviceAccount: 'serviceAccount',

  // the properties below are optional
  disableSessionTags: false,
  policy: 'policy',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  targetRoleArn: 'targetRoleArn',
};

Properties

clusterNamestringcluster_namestrclusterNameStringClusterNamestringClusterName*stringrequired#

The name of the cluster that the association is in.

disableSessionTags?optionalboolean | IResolvabledisable_session_tags?optionaltyping.Union[bool, IResolvable]disableSessionTags?optionalBooleanDisableSessionTags?optionalboolDisableSessionTags?optionalinterface{}#

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

notes

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 AWS 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 .

namespacestringnamespacestrnamespaceStringNamespacestringNamespace*stringrequired#

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.

policy?optionalstringpolicy?optionalstrpolicy?optionalStringPolicy?optionalstringPolicy?optional*string#

The policy of the pod identity association.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#

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.

serviceAccountstringservice_accountstrserviceAccountStringServiceAccountstringServiceAccount*stringrequired#

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

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

Metadata that assists with categorization and organization.

notes

Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS 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: + - = . _ : /

targetRoleArn?optionalstringtarget_role_arn?optionalstrtargetRoleArn?optionalStringTargetRoleArn?optionalstringTargetRoleArn?optional*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.