Interface PodIdentityAssociation.Builder

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

  • Method Details

    • clusterName

      PodIdentityAssociation.Builder clusterName(String clusterName)

      The name of the cluster that the association is in.

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

    • namespace

      PodIdentityAssociation.Builder namespace(String namespace)

      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.

      Parameters:
      namespace - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceAccount

      PodIdentityAssociation.Builder serviceAccount(String serviceAccount)

      The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

      Parameters:
      serviceAccount - The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      PodIdentityAssociation.Builder roleArn(String roleArn)

      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.

      Parameters:
      roleArn - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associationArn

      PodIdentityAssociation.Builder associationArn(String associationArn)

      The Amazon Resource Name (ARN) of the association.

      Parameters:
      associationArn - The Amazon Resource Name (ARN) of the association.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associationId

      PodIdentityAssociation.Builder associationId(String associationId)

      The ID of the association.

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

    • tags

      PodIdentityAssociation.Builder tags(Map<String,String> tags)

      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.

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

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

    • createdAt

      PodIdentityAssociation.Builder createdAt(Instant createdAt)

      The timestamp that the association was created at.

      Parameters:
      createdAt - The timestamp that the association was created at.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modifiedAt

      PodIdentityAssociation.Builder modifiedAt(Instant modifiedAt)

      The most recent timestamp that the association was modified at.

      Parameters:
      modifiedAt - The most recent timestamp that the association was modified at.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ownerArn

      PodIdentityAssociation.Builder ownerArn(String ownerArn)

      If defined, the EKS Pod Identity association is owned by an Amazon EKS add-on.

      Parameters:
      ownerArn - If defined, the EKS Pod Identity association is owned by an Amazon EKS add-on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disableSessionTags

      PodIdentityAssociation.Builder disableSessionTags(Boolean disableSessionTags)

      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.

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

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

    • targetRoleArn

      PodIdentityAssociation.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.

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • externalId

      PodIdentityAssociation.Builder externalId(String externalId)

      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.

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

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