Package software.amazon.awscdk.cfnpropertymixins.services.eks

Interface CfnPodIdentityAssociationMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPodIdentityAssociationMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:59.083Z")
@Stability(Stable)
public interface CfnPodIdentityAssociationMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnPodIdentityAssociationPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.eks.*;
 CfnPodIdentityAssociationMixinProps cfnPodIdentityAssociationMixinProps = CfnPodIdentityAssociationMixinProps.builder()
         .clusterName("clusterName")
         .disableSessionTags(false)
         .namespace("namespace")
         .policy("policy")
         .roleArn("roleArn")
         .serviceAccount("serviceAccount")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetRoleArn("targetRoleArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPodIdentityAssociationMixinProps.Builder	A builder for CfnPodIdentityAssociationMixinProps
static final class	CfnPodIdentityAssociationMixinProps.Jsii$Proxy	An implementation for CfnPodIdentityAssociationMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnPodIdentityAssociationMixinProps.Builder	builder()
default String	getClusterName()	The name of the cluster that the association is in.
default Object	getDisableSessionTags()	The state of the automatic sessions tags.
default String	getNamespace()	The name of the Kubernetes namespace inside the cluster to create the association in.
default String	getPolicy()	The policy of the pod identity association.
default String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role to associate with the service account.
default String	getServiceAccount()	The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.
default List<CfnTag>	getTags()	Metadata that assists with categorization and organization.
default String	getTargetRoleArn()	The Amazon Resource Name (ARN) of the target IAM role to associate with the service account.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClusterName

@Stability(Stable)
@Nullable
default String getClusterName()

The name of the cluster that the association is in.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#cfn-eks-podidentityassociation-clustername

getDisableSessionTags

@Stability(Stable)
@Nullable
default Object getDisableSessionTags()

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

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#cfn-eks-podidentityassociation-disablesessiontags

getNamespace

@Stability(Stable)
@Nullable
default String getNamespace()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#cfn-eks-podidentityassociation-namespace

getPolicy

@Stability(Stable)
@Nullable
default String getPolicy()

The policy of the pod identity association.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#cfn-eks-podidentityassociation-policy

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#cfn-eks-podidentityassociation-rolearn

getServiceAccount

@Stability(Stable)
@Nullable
default String getServiceAccount()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#cfn-eks-podidentityassociation-serviceaccount

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 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: + - = . _ : /

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#cfn-eks-podidentityassociation-tags

getTargetRoleArn

@Stability(Stable)
@Nullable
default String getTargetRoleArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-podidentityassociation.html#cfn-eks-podidentityassociation-targetrolearn

builder

@Stability(Stable)
static CfnPodIdentityAssociationMixinProps.Builder builder()

Returns:

a CfnPodIdentityAssociationMixinProps.Builder of CfnPodIdentityAssociationMixinProps