Interface EksConfiguration.Builder

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

  • Method Details

    • eksClusterArn

      EksConfiguration.Builder eksClusterArn(String eksClusterArn)

      The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch .

      Parameters:
      eksClusterArn - The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch .
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kubernetesNamespace

      EksConfiguration.Builder kubernetesNamespace(String kubernetesNamespace)

      The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value can't left empty or null. It must be fewer than 64 characters long, can't be set to default, can't start with " kube-," and must match this regular expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more information, see Namespaces in the Kubernetes documentation.

      Parameters:
      kubernetesNamespace - The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value can't left empty or null. It must be fewer than 64 characters long, can't be set to default, can't start with "kube-," and must match this regular expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more information, see Namespaces in the Kubernetes documentation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessEntry

      EksConfiguration.Builder accessEntry(EksAccessEntry accessEntry)

      The Batch-managed Amazon EKS access entry for the compute environment. Set desiredState to declare whether Batch manages an access entry on the cluster. In a DescribeComputeEnvironments response, desiredState is the value that Batch recorded for the compute environment and status is the observed state of the access entry on the cluster. To change the access entry on an existing compute environment, use EksConfigurationUpdate.accessEntry .

      Whether the entry is provisioned on the cluster depends on the cluster's authenticationMode and the desiredState recorded for each Batch compute environment targeting the cluster. For more information, see Amazon EKS access entry authentication in the Batch User Guide.

      If you don't specify this field, Batch doesn't record a desiredState for the compute environment and DescribeComputeEnvironments doesn't return one. For the purpose of provisioning the access entry, Batch behaves as it does for INHERIT_FROM_CLUSTER.

      Parameters:
      accessEntry - The Batch-managed Amazon EKS access entry for the compute environment. Set desiredState to declare whether Batch manages an access entry on the cluster. In a DescribeComputeEnvironments response, desiredState is the value that Batch recorded for the compute environment and status is the observed state of the access entry on the cluster. To change the access entry on an existing compute environment, use EksConfigurationUpdate.accessEntry .

      Whether the entry is provisioned on the cluster depends on the cluster's authenticationMode and the desiredState recorded for each Batch compute environment targeting the cluster. For more information, see Amazon EKS access entry authentication in the Batch User Guide.

      If you don't specify this field, Batch doesn't record a desiredState for the compute environment and DescribeComputeEnvironments doesn't return one. For the purpose of provisioning the access entry, Batch behaves as it does for INHERIT_FROM_CLUSTER.

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

    • accessEntry

      default EksConfiguration.Builder accessEntry(Consumer<EksAccessEntry.Builder> accessEntry)

      The Batch-managed Amazon EKS access entry for the compute environment. Set desiredState to declare whether Batch manages an access entry on the cluster. In a DescribeComputeEnvironments response, desiredState is the value that Batch recorded for the compute environment and status is the observed state of the access entry on the cluster. To change the access entry on an existing compute environment, use EksConfigurationUpdate.accessEntry .

      Whether the entry is provisioned on the cluster depends on the cluster's authenticationMode and the desiredState recorded for each Batch compute environment targeting the cluster. For more information, see Amazon EKS access entry authentication in the Batch User Guide.

      If you don't specify this field, Batch doesn't record a desiredState for the compute environment and DescribeComputeEnvironments doesn't return one. For the purpose of provisioning the access entry, Batch behaves as it does for INHERIT_FROM_CLUSTER.

      This is a convenience method that creates an instance of the EksAccessEntry.Builder avoiding the need to create one manually via EksAccessEntry.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accessEntry(EksAccessEntry).

      Parameters:
      accessEntry - a consumer that will call methods on EksAccessEntry.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: