EKS / Client / create_pod_identity_association

create_pod_identity_association

EKS.Client.create_pod_identity_association(**kwargs)

Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity. Use EKS Pod Identity to give temporary IAM credentials to pods and the credentials are rotated automatically.

Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.

If a pod uses a service account that has an association, Amazon EKS sets environment variables in the containers of the pod. The environment variables configure the Amazon Web Services SDKs, including the Command Line Interface, to use the EKS Pod Identity credentials.

Pod Identity is a simpler method than IAM roles for service accounts, as this method doesn’t use OIDC identity providers. Additionally, you can configure a role for Pod Identity once, and reuse it across clusters.

See also: AWS API Documentation

Request Syntax

response = client.create_pod_identity_association(
    clusterName='string',
    namespace='string',
    serviceAccount='string',
    roleArn='string',
    clientRequestToken='string',
    tags={
        'string': 'string'
    }
)

Parameters:

• clusterName (string) –

  [REQUIRED]

  The name of the cluster to create the association in.

• namespace (string) –

  [REQUIRED]

  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.

• serviceAccount (string) –

  [REQUIRED]

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

• roleArn (string) –

  [REQUIRED]

  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.

• clientRequestToken (string) –

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

  This field is autopopulated if not provided.

• tags (dict) –

  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 Amazon Web Services 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: + - = . _ : / @.

  • 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 Amazon Web Services 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.

  • (string) –

    One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

    • (string) –

      The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Return type:

dict

Returns:

Response Syntax

{
    'association': {
        'clusterName': 'string',
        'namespace': 'string',
        'serviceAccount': 'string',
        'roleArn': 'string',
        'associationArn': 'string',
        'associationId': 'string',
        'tags': {
            'string': 'string'
        },
        'createdAt': datetime(2015, 1, 1),
        'modifiedAt': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  • association (dict) –

    The full description of your new association.

    The description includes an ID for the association. Use the ID of the association in further actions to manage the association.

    • clusterName (string) –

      The name of the cluster that the association is in.

    • namespace (string) –

      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.

    • serviceAccount (string) –

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

    • roleArn (string) –

      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.

    • associationArn (string) –

      The Amazon Resource Name (ARN) of the association.

    • associationId (string) –

      The ID of the association.

    • tags (dict) –

      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 Amazon Web Services 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: + - = . _ : / @.

      • 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 Amazon Web Services 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.

      • (string) –

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

        • (string) –

          The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

    • createdAt (datetime) –

      The timestamp that the association was created at.

    • modifiedAt (datetime) –

      The most recent timestamp that the association was modified at

Exceptions

• EKS.Client.exceptions.ServerException

• EKS.Client.exceptions.ResourceNotFoundException

• EKS.Client.exceptions.InvalidRequestException

• EKS.Client.exceptions.InvalidParameterException

• EKS.Client.exceptions.ResourceLimitExceededException

• EKS.Client.exceptions.ResourceInUseException