Skip to content

/AWS1/CL_BTCEKSCONFIGURATION

Configuration for the Amazon EKS cluster that supports the Batch compute environment. The cluster must exist before the compute environment can be created.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_eksclusterarn TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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

iv_kubernetesnamespace TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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?$. For more information, see Namespaces in the Kubernetes documentation.

Optional arguments:

io_accessentry TYPE REF TO /AWS1/CL_BTCEKSACCESSENTRY /AWS1/CL_BTCEKSACCESSENTRY

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.


Queryable Attributes

eksClusterArn

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

Accessible with the following methods

Method Description
GET_EKSCLUSTERARN() Getter for EKSCLUSTERARN, with configurable default
ASK_EKSCLUSTERARN() Getter for EKSCLUSTERARN w/ exceptions if field has no value
HAS_EKSCLUSTERARN() Determine if EKSCLUSTERARN has a value

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?$. For more information, see Namespaces in the Kubernetes documentation.

Accessible with the following methods

Method Description
GET_KUBERNETESNAMESPACE() Getter for KUBERNETESNAMESPACE, with configurable default
ASK_KUBERNETESNAMESPACE() Getter for KUBERNETESNAMESPACE w/ exceptions if field has no
HAS_KUBERNETESNAMESPACE() Determine if KUBERNETESNAMESPACE has a value

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.

Accessible with the following methods

Method Description
GET_ACCESSENTRY() Getter for ACCESSENTRY