Package software.amazon.awscdk.services.eks

Interface CfnPodIdentityAssociationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPodIdentityAssociationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:16.467Z")
@Stability(Stable)
public interface CfnPodIdentityAssociationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPodIdentityAssociation.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.eks.*;
 CfnPodIdentityAssociationProps cfnPodIdentityAssociationProps = CfnPodIdentityAssociationProps.builder()
         .clusterName("clusterName")
         .namespace("namespace")
         .roleArn("roleArn")
         .serviceAccount("serviceAccount")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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	CfnPodIdentityAssociationProps.Builder	A builder for CfnPodIdentityAssociationProps
static final class	CfnPodIdentityAssociationProps.Jsii$Proxy	An implementation for CfnPodIdentityAssociationProps

Method Summary

Modifier and Type	Method	Description
static CfnPodIdentityAssociationProps.Builder	builder()
String	getClusterName()	The name of the cluster that the association is in.
String	getNamespace()	The name of the Kubernetes namespace inside the cluster to create the association in.
String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role to associate with the service account.
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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClusterName

@Stability(Stable)
@NotNull
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

getNamespace

@Stability(Stable)
@NotNull
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

getRoleArn

@Stability(Stable)
@NotNull
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)
@NotNull
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

builder

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

Returns:

a CfnPodIdentityAssociationProps.Builder of CfnPodIdentityAssociationProps