EksConfiguration
Configuration for the Amazon EKS cluster that supports the AWS Batch compute environment. The cluster must exist before the compute environment can be created.
Contents
- eksClusterArn
-
The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is
arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch.Type: String
Required: Yes
- kubernetesNamespace
-
The namespace of the Amazon EKS cluster. AWS 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 Namespacesin the Kubernetes documentation. Type: String
Required: Yes
- accessEntry
-
The AWS Batch-managed Amazon EKS access entry for the compute environment. Set
desiredStateto declare whether AWS Batch manages an access entry on the cluster. In aDescribeComputeEnvironmentsresponse,desiredStateis the value that AWS Batch recorded for the compute environment andstatusis the observed state of the access entry on the cluster. To change the access entry on an existing compute environment, useEksConfigurationUpdate.accessEntry.Whether the entry is provisioned on the cluster depends on the cluster's
authenticationModeand thedesiredStaterecorded for each AWS Batch compute environment targeting the cluster. For more information, see Amazon EKS access entry authentication in the AWS Batch User Guide.If you don't specify this field, AWS Batch doesn't record a
desiredStatefor the compute environment andDescribeComputeEnvironmentsdoesn't return one. For the purpose of provisioning the access entry, AWS Batch behaves as it does forINHERIT_FROM_CLUSTER.Type: EksAccessEntry object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: