Interface UpdatePodIdentityAssociationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdatePodIdentityAssociationRequest.Builder,UpdatePodIdentityAssociationRequest>, EksRequest.Builder, SdkBuilder<UpdatePodIdentityAssociationRequest.Builder,UpdatePodIdentityAssociationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdatePodIdentityAssociationRequest
@Mutable @NotThreadSafe public static interface UpdatePodIdentityAssociationRequest.Builder extends EksRequest.Builder, SdkPojo, CopyableBuilder<UpdatePodIdentityAssociationRequest.Builder,UpdatePodIdentityAssociationRequest>

  • Method Details

    • clusterName

      UpdatePodIdentityAssociationRequest.Builder clusterName(String clusterName)

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

      Parameters:
      clusterName - The name of the cluster that you want to update the association in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associationId

      UpdatePodIdentityAssociationRequest.Builder associationId(String associationId)

      The ID of the association to be updated.

      Parameters:
      associationId - The ID of the association to be updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      UpdatePodIdentityAssociationRequest.Builder roleArn(String roleArn)

      The new IAM role to change in the association.

      Parameters:
      roleArn - The new IAM role to change in the association.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientRequestToken

      UpdatePodIdentityAssociationRequest.Builder clientRequestToken(String clientRequestToken)

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

      Parameters:
      clientRequestToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disableSessionTags

      UpdatePodIdentityAssociationRequest.Builder disableSessionTags(Boolean disableSessionTags)

      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.

      Parameters:
      disableSessionTags - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetRoleArn

      UpdatePodIdentityAssociationRequest.Builder targetRoleArn(String targetRoleArn)

      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.

      Parameters:
      targetRoleArn - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      UpdatePodIdentityAssociationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdatePodIdentityAssociationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.