EKS / Client / update_pod_identity_association

update_pod_identity_association

EKS.Client.update_pod_identity_association(**kwargs)

Updates a EKS Pod Identity association. Only the IAM role can be changed; an association can’t be moved between clusters, namespaces, or service accounts. If you need to edit the namespace or service account, you need to delete the association and then create a new association with your desired settings.

See also: AWS API Documentation

Request Syntax

response = client.update_pod_identity_association(
    clusterName='string',
    associationId='string',
    roleArn='string',
    clientRequestToken='string'
)

Parameters:

• clusterName (string) –

  [REQUIRED]

  The name of the cluster that you want to update the association in.

• associationId (string) –

  [REQUIRED]

  The ID of the association to be updated.

• roleArn (string) – The new IAM role to change the

• clientRequestToken (string) –

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

  This field is autopopulated if not provided.

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),
        'ownerArn': 'string'
    }
}

Response Structure

• (dict) –

  • association (dict) –

    The full description of the EKS Pod Identity association that was updated.

    • 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

    • ownerArn (string) –

      If defined, the Pod Identity Association is owned by an Amazon EKS Addon.

Exceptions

• EKS.Client.exceptions.ServerException

• EKS.Client.exceptions.ResourceNotFoundException

• EKS.Client.exceptions.InvalidRequestException

• EKS.Client.exceptions.InvalidParameterException