pod_identity_associations

Creates, updates, deletes, gets or lists a pod_identity_associations resource.

Overview

Name	`pod_identity_associations`
Type	Resource
Id	`aws.eks.pod_identity_associations`

Fields

The following fields are returned by SELECT queries:

describe_pod_identity_association
list_pod_identity_associations

Name	Datatype	Description
`association_arn`	`string`	The Amazon Resource Name (ARN) of the association.
`association_id`	`string`	The ID of the association.
`cluster_name`	`string`	The name of the cluster that the association is in.
`created_at`	`string (date-time)`	The timestamp that the association was created at.
`disable_session_tags`	`boolean`	The state of the automatic sessions tags. The value of true disables these tags. EKS Pod Identity adds a pre-defined set of session tags when it assumes the role. You can use these tags to author a single role that can work across resources by allowing access to Amazon Web Services resources based on matching tags. By default, EKS Pod Identity attaches six tags, including tags for cluster name, namespace, and service account name. For the list of tags added by EKS Pod Identity, see List of session tags added by EKS Pod Identity in the Amazon EKS User Guide.
`external_id`	`string`	The unique identifier for this EKS Pod Identity association for a target IAM role. You put this value in the trust policy of the target role, in a Condition to match the sts.ExternalId. This ensures that the target role can only be assumed by this association. This prevents the confused deputy problem. For more information about the confused deputy problem, see The confused deputy problem in the IAM User Guide. If you want to use the same target role with multiple associations or other roles, use independent statements in the trust policy to allow sts:AssumeRole access from each role.
`modified_at`	`string (date-time)`	The most recent timestamp that the association was modified at.
`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.
`owner_arn`	`string`	If defined, the EKS Pod Identity association is owned by an Amazon EKS add-on.
`policy`	`string`	An optional IAM policy in JSON format (as an escaped string) that applies additional restrictions to this pod identity association beyond the IAM policies attached to the IAM role. This policy is applied as the intersection of the role's policies and this policy, allowing you to reduce the permissions that applications in the pods can use. Use this policy to enforce least privilege access while still leveraging a shared IAM role across multiple applications.
`role_arn`	`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.
`service_account`	`string`	The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.
`tags`	`object`	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.
`target_role_arn`	`string`	The Amazon Resource Name (ARN) of the target IAM role to associate with the service account. This role is assumed by using the EKS Pod Identity association role, then the credentials for this role are injected into the Pod.

Name	Datatype	Description
`association_arn`	`string`	The Amazon Resource Name (ARN) of the association.
`association_id`	`string`	The ID of the association.
`cluster_name`	`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.
`owner_arn`	`string`	If defined, the association is owned by an Amazon EKS add-on.
`service_account`	`string`	The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`describe_pod_identity_association`	`select`	`name`, `association_id`, `region`		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.
`list_pod_identity_associations`	`select`	`name`, `region`	`namespace`, `serviceAccount`, `maxResults`, `nextToken`	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.
`create_pod_identity_association`	`insert`	`name`, `region`, `namespace`, `serviceAccount`, `roleArn`		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. EKS 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 EKS Pod Identity once, and reuse it across clusters. Similar to Amazon Web Services IAM behavior, EKS Pod Identity associations are eventually consistent, and may take several seconds to be effective after the initial API call returns successfully. You must design your applications to account for these potential delays. We recommend that you don’t include association create/updates in the critical, high-availability code paths of your application. Instead, make changes in a separate initialization or setup routine that you run less frequently. You can set a target IAM role in the same or a different account for advanced scenarios. With a target role, EKS Pod Identity automatically performs two role assumptions in sequence: first assuming the role in the association that is in this account, then using those credentials to assume the target IAM role. This process provides your Pod with temporary credentials that have the permissions defined in the target role, allowing secure access to resources in another Amazon Web Services account.
`update_pod_identity_association`	`update`	`name`, `association_id`, `region`		Updates a EKS Pod Identity association. In an update, you can change the IAM role, the target IAM role, or disableSessionTags. You must change at least one of these in an update. 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. Similar to Amazon Web Services IAM behavior, EKS Pod Identity associations are eventually consistent, and may take several seconds to be effective after the initial API call returns successfully. You must design your applications to account for these potential delays. We recommend that you don’t include association create/updates in the critical, high-availability code paths of your application. Instead, make changes in a separate initialization or setup routine that you run less frequently. You can set a target IAM role in the same or a different account for advanced scenarios. With a target role, EKS Pod Identity automatically performs two role assumptions in sequence: first assuming the role in the association that is in this account, then using those credentials to assume the target IAM role. This process provides your Pod with temporary credentials that have the permissions defined in the target role, allowing secure access to resources in another Amazon Web Services account.
`delete_pod_identity_association`	`delete`	`name`, `association_id`, `region`		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`association_id`	`string`	The ID of the association to be deleted.
`name`	`string`	The cluster name that
`region`	`string`	AWS region (default: us-east-1)
`maxResults`	`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.
`namespace`	`string`	The name of the Kubernetes namespace inside the cluster that the associations are in.
`nextToken`	`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. This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
`serviceAccount`	`string`	The name of the Kubernetes service account that the associations use.

`SELECT` examples

describe_pod_identity_association
list_pod_identity_associations

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.

SELECT
association_arn,
association_id,
cluster_name,
created_at,
disable_session_tags,
external_id,
modified_at,
namespace,
owner_arn,
policy,
role_arn,
service_account,
tags,
target_role_arn
FROM aws.eks.pod_identity_associations
WHERE name = '{{ name }}' -- required
AND association_id = '{{ association_id }}' -- required
AND region = '{{ region }}' -- required
;

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.

SELECT
association_arn,
association_id,
cluster_name,
namespace,
owner_arn,
service_account
FROM aws.eks.pod_identity_associations
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
AND namespace = '{{ namespace }}'
AND serviceAccount = '{{ serviceAccount }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

`INSERT` examples

create_pod_identity_association
Manifest

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. EKS 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 EKS Pod Identity once, and reuse it across clusters. Similar to Amazon Web Services IAM behavior, EKS Pod Identity associations are eventually consistent, and may take several seconds to be effective after the initial API call returns successfully. You must design your applications to account for these potential delays. We recommend that you don’t include association create/updates in the critical, high-availability code paths of your application. Instead, make changes in a separate initialization or setup routine that you run less frequently. You can set a target IAM role in the same or a different account for advanced scenarios. With a target role, EKS Pod Identity automatically performs two role assumptions in sequence: first assuming the role in the association that is in this account, then using those credentials to assume the target IAM role. This process provides your Pod with temporary credentials that have the permissions defined in the target role, allowing secure access to resources in another Amazon Web Services account.

INSERT INTO aws.eks.pod_identity_associations (
namespace,
serviceAccount,
roleArn,
clientRequestToken,
tags,
disableSessionTags,
targetRoleArn,
policy,
name,
region
)
SELECT 
'{{ namespace }}' /* required */,
'{{ serviceAccount }}' /* required */,
'{{ roleArn }}' /* required */,
'{{ clientRequestToken }}',
'{{ tags }}',
{{ disableSessionTags }},
'{{ targetRoleArn }}',
'{{ policy }}',
'{{ name }}',
'{{ region }}'
RETURNING
association
;

# Description fields are for documentation purposes
- name: pod_identity_associations
props:
  - name: name
    value: "{{ name }}"
    description: Required parameter for the pod_identity_associations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the pod_identity_associations resource.
  - name: namespace
    value: "{{ namespace }}"
  - name: serviceAccount
    value: "{{ serviceAccount }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: clientRequestToken
    value: "{{ clientRequestToken }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them. 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.
  - name: disableSessionTags
    value: {{ disableSessionTags }}
  - name: targetRoleArn
    value: "{{ targetRoleArn }}"
  - name: policy
    value: "{{ policy }}"

`UPDATE` examples

update_pod_identity_association

Updates a EKS Pod Identity association. In an update, you can change the IAM role, the target IAM role, or disableSessionTags. You must change at least one of these in an update. 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. Similar to Amazon Web Services IAM behavior, EKS Pod Identity associations are eventually consistent, and may take several seconds to be effective after the initial API call returns successfully. You must design your applications to account for these potential delays. We recommend that you don’t include association create/updates in the critical, high-availability code paths of your application. Instead, make changes in a separate initialization or setup routine that you run less frequently. You can set a target IAM role in the same or a different account for advanced scenarios. With a target role, EKS Pod Identity automatically performs two role assumptions in sequence: first assuming the role in the association that is in this account, then using those credentials to assume the target IAM role. This process provides your Pod with temporary credentials that have the permissions defined in the target role, allowing secure access to resources in another Amazon Web Services account.

UPDATE aws.eks.pod_identity_associations
SET 
roleArn = '{{ roleArn }}',
clientRequestToken = '{{ clientRequestToken }}',
disableSessionTags = {{ disableSessionTags }},
targetRoleArn = '{{ targetRoleArn }}',
policy = '{{ policy }}'
WHERE 
name = '{{ name }}' --required
AND association_id = '{{ association_id }}' --required
AND region = '{{ region }}' --required
RETURNING
association;

`DELETE` examples

delete_pod_identity_association

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.

DELETE FROM aws.eks.pod_identity_associations
WHERE name = '{{ name }}' --required
AND association_id = '{{ association_id }}' --required
AND region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​