2023/11/27 - Amazon Elastic Kubernetes Service - 5 new api methods
Changes This release adds support for EKS Pod Identity feature. EKS Pod Identity makes it easy for customers to obtain IAM permissions for the applications running in their EKS clusters.
Returns descriptive information about an EKS Pod Identity association.
This action requires the ID of the association. You can get the ID from the response to the CreatePodIdentityAssocation for newly created associations. Or, you can list the IDs for associations with ListPodIdentityAssociations and filter the list by namespace or service account.
See also: AWS API Documentation
Request Syntax
client.describe_pod_identity_association(
clusterName='string',
associationId='string'
)
string
[REQUIRED]
The name of the cluster that the association is in.
string
[REQUIRED]
The ID of the association that you want the description of.
dict
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 the EKS Pod Identity 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) --
The metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.
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
Deletes a EKS Pod Identity association.
The temporary Amazon Web Services credentials from the previous IAM role session might still be valid until the session expiry. If you need to immediately revoke the temporary session credentials, then go to the role in the IAM console.
See also: AWS API Documentation
Request Syntax
client.delete_pod_identity_association(
clusterName='string',
associationId='string'
)
string
[REQUIRED]
The cluster name that
string
[REQUIRED]
The ID of the association to be deleted.
dict
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 the EKS Pod Identity association that was deleted.
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) --
The metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.
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
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 remove the association and then create a new association with your desired settings.
See also: AWS API Documentation
Request Syntax
client.update_pod_identity_association(
clusterName='string',
associationId='string',
roleArn='string',
clientRequestToken='string'
)
string
[REQUIRED]
The name of the cluster that you want to update the association in.
string
[REQUIRED]
The ID of the association to be updated.
string
The new IAM role to change the
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
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 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) --
The metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.
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
List the EKS Pod Identity associations in a cluster. You can filter the list by the namespace that the association is in or the service account that the association uses.
See also: AWS API Documentation
Request Syntax
client.list_pod_identity_associations(
clusterName='string',
namespace='string',
serviceAccount='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The name of the cluster that the associations are in.
string
The name of the Kubernetes namespace inside the cluster that the associations are in.
string
The name of the Kubernetes service account that the associations use.
integer
The maximum number of EKS Pod Identity association results returned by ListPodIdentityAssociations in paginated output. When you use this parameter, ListPodIdentityAssociations returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListPodIdentityAssociations request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListPodIdentityAssociations returns up to 100 results and a nextToken value if applicable.
string
The nextToken value returned from a previous paginated ListUpdates request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
dict
Response Syntax
{
'associations': [
{
'clusterName': 'string',
'namespace': 'string',
'serviceAccount': 'string',
'associationArn': 'string',
'associationId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
associations (list) --
The list of summarized descriptions of the associations that are in the cluster and match any filters that you provided.
Each summary is simplified by removing these fields compared to the full ``PodIdentityAssociation ``:
The IAM role: roleArn
The timestamp that the association was created at: createdAt
The most recent timestamp that the association was modified at:. modifiedAt
The tags on the association: tags
(dict) --
The summarized description of the association.
Each summary is simplified by removing these fields compared to the full ``PodIdentityAssociation ``:
The IAM role: roleArn
The timestamp that the association was created at: createdAt
The most recent timestamp that the association was modified at:. modifiedAt
The tags on the association: tags
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.
associationArn (string) --
The Amazon Resource Name (ARN) of the association.
associationId (string) --
The ID of the association.
nextToken (string) --
The nextToken value to include in a future ListPodIdentityAssociations request. When the results of a ListPodIdentityAssociations request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
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 7EC2l 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
client.create_pod_identity_association(
clusterName='string',
namespace='string',
serviceAccount='string',
roleArn='string',
clientRequestToken='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The name of the cluster to create the association in.
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.
string
[REQUIRED]
The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.
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.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
The metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.
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).
dict
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) --
The metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.
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