CfnPodIdentityAssociationProps

class aws_cdk.aws_eks.CfnPodIdentityAssociationProps(*, cluster_name, namespace, role_arn, service_account, tags=None)

Bases: object

Properties for defining a CfnPodIdentityAssociation.

Parameters:
  • cluster_name (str) – The name of the cluster that the association is in.

  • namespace (str) – 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.

  • role_arn (str) – 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.

  • service_account (str) – The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_eks as eks

cfn_pod_identity_association_props = eks.CfnPodIdentityAssociationProps(
    cluster_name="clusterName",
    namespace="namespace",
    role_arn="roleArn",
    service_account="serviceAccount",

    # the properties below are optional
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

cluster_name

The name of the cluster that the association is in.

See:

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

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.

See:

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

role_arn

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:

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

service_account

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

See:

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

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

See:

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

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