Package software.amazon.awscdk.services.eks

Class CfnPodIdentityAssociation.Builder

java.lang.Object

software.amazon.awscdk.services.eks.CfnPodIdentityAssociation.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPodIdentityAssociation>

Enclosing class:

CfnPodIdentityAssociation

@Stability(Stable)
public static final class CfnPodIdentityAssociation.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPodIdentityAssociation>

A fluent builder for CfnPodIdentityAssociation.

Method Summary

Modifier and Type	Method	Description
CfnPodIdentityAssociation	build()
CfnPodIdentityAssociation.Builder	clusterName(String clusterName)	The name of the cluster that the association is in.
static CfnPodIdentityAssociation.Builder	create(software.constructs.Construct scope, String id)
CfnPodIdentityAssociation.Builder	disableSessionTags(Boolean disableSessionTags)	The state of the automatic sessions tags.
CfnPodIdentityAssociation.Builder	disableSessionTags(IResolvable disableSessionTags)	The state of the automatic sessions tags.
CfnPodIdentityAssociation.Builder	namespace(String namespace)	The name of the Kubernetes namespace inside the cluster to create the association in.
CfnPodIdentityAssociation.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM role to associate with the service account.
CfnPodIdentityAssociation.Builder	serviceAccount(String serviceAccount)	The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.
CfnPodIdentityAssociation.Builder	tags(List<? extends CfnTag> tags)	Metadata that assists with categorization and organization.
CfnPodIdentityAssociation.Builder	targetRoleArn(String targetRoleArn)	The Amazon Resource Name (ARN) of the target IAM role to associate with the service account.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnPodIdentityAssociation.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnPodIdentityAssociation.Builder.

clusterName

@Stability(Stable)
public CfnPodIdentityAssociation.Builder clusterName(String clusterName)

The name of the cluster that the association is in.

Parameters:

clusterName - The name of the cluster that the association is in. This parameter is required.

Returns:

this

See Also:

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

namespace

@Stability(Stable)
public CfnPodIdentityAssociation.Builder namespace(String namespace)

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.

Parameters:

namespace - The name of the Kubernetes namespace inside the cluster to create the association in. This parameter is required.

Returns:

this

See Also:

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

roleArn

@Stability(Stable)
public CfnPodIdentityAssociation.Builder roleArn(String roleArn)

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.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role to associate with the service account. This parameter is required.

Returns:

this

See Also:

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

serviceAccount

@Stability(Stable)
public CfnPodIdentityAssociation.Builder serviceAccount(String serviceAccount)

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

Parameters:

serviceAccount - The name of the Kubernetes service account inside the cluster to associate the IAM credentials with. This parameter is required.

Returns:

this

See Also:

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

disableSessionTags

@Stability(Stable)
public CfnPodIdentityAssociation.Builder disableSessionTags(Boolean disableSessionTags)

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 .

Parameters:

disableSessionTags - The state of the automatic sessions tags. The value of true disables these tags. This parameter is required.

Returns:

this

See Also:

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

disableSessionTags

@Stability(Stable)
public CfnPodIdentityAssociation.Builder disableSessionTags(IResolvable disableSessionTags)

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 .

Parameters:

disableSessionTags - The state of the automatic sessions tags. The value of true disables these tags. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnPodIdentityAssociation.Builder tags(List<? extends CfnTag> tags)

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

Parameters:

tags - Metadata that assists with categorization and organization. This parameter is required.

Returns:

this

See Also:

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

targetRoleArn

@Stability(Stable)
public CfnPodIdentityAssociation.Builder targetRoleArn(String targetRoleArn)

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.

Parameters:

targetRoleArn - The Amazon Resource Name (ARN) of the target IAM role to associate with the service account. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnPodIdentityAssociation build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnPodIdentityAssociation>

Returns:

a newly built instance of CfnPodIdentityAssociation.