/AWS1/CL_EKS=>UPDATEPODIDENTITYASSOCIATION()

About UpdatePodIdentityAssociation

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.

Method Signature

IMPORTING

Required arguments:

iv_clustername TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING

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

iv_associationid TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING

The ID of the association to be updated.

Optional arguments:

iv_rolearn TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING

The new IAM role to change in the association.

iv_clientrequesttoken TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING

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

iv_disablesessiontags TYPE /AWS1/EKSBOXEDBOOLEAN /AWS1/EKSBOXEDBOOLEAN

Disable the automatic sessions tags that are appended by EKS Pod Identity.

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.

Amazon Web Services compresses inline session policies, managed policy ARNs, and session tags into a packed binary format that has a separate limit. If you receive a PackedPolicyTooLarge error indicating the packed binary format has exceeded the size limit, you can attempt to reduce the size by disabling the session tags added by EKS Pod Identity.

iv_targetrolearn TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING

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.

When you run applications on Amazon EKS, your application might need to access Amazon Web Services resources from a different role that exists in the same or different Amazon Web Services account. For example, your application running in “Account A” might need to access resources, such as buckets in “Account B” or within “Account A” itself. You can create a association to access Amazon Web Services resources in “Account B” by creating two IAM roles: a role in “Account A” and a role in “Account B” (which can be the same or different account), each with the necessary trust and permission policies. After you provide these roles in the IAM role and Target IAM role fields, EKS will perform role chaining to ensure your application gets the required permissions. This means Role A will assume Role B, allowing your Pods to securely access resources like S3 buckets in the target account.

RETURNING

oo_output TYPE REF TO /aws1/cl_eksuppodidassociati01 /AWS1/CL_EKSUPPODIDASSOCIATI01

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_eks~updatepodidentityassociation(
  iv_associationid = |string|
  iv_clientrequesttoken = |string|
  iv_clustername = |string|
  iv_disablesessiontags = ABAP_TRUE
  iv_rolearn = |string|
  iv_targetrolearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_podidentityassociation = lo_result->get_association( ).
  IF lo_podidentityassociation IS NOT INITIAL.
    lv_string = lo_podidentityassociation->get_clustername( ).
    lv_string = lo_podidentityassociation->get_namespace( ).
    lv_string = lo_podidentityassociation->get_serviceaccount( ).
    lv_string = lo_podidentityassociation->get_rolearn( ).
    lv_string = lo_podidentityassociation->get_associationarn( ).
    lv_string = lo_podidentityassociation->get_associationid( ).
    LOOP AT lo_podidentityassociation->get_tags( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lv_tagvalue = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_timestamp = lo_podidentityassociation->get_createdat( ).
    lv_timestamp = lo_podidentityassociation->get_modifiedat( ).
    lv_string = lo_podidentityassociation->get_ownerarn( ).
    lv_boxedboolean = lo_podidentityassociation->get_disablesessiontags( ).
    lv_string = lo_podidentityassociation->get_targetrolearn( ).
    lv_string = lo_podidentityassociation->get_externalid( ).
  ENDIF.
ENDIF.