View a markdown version of this page

AWS::Batch::ComputeEnvironment EksConfiguration - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Batch::ComputeEnvironment 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.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "AccessEntry" : EksAccessEntry,
  "EksClusterArn" : String,
  "KubernetesNamespace" : String
}

Properties

AccessEntry

The AWS Batch-managed Amazon EKS access entry for the compute environment. Set desiredState to declare whether AWS Batch manages an access entry on the cluster. In a DescribeComputeEnvironments response, desiredState is the value that AWS 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 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 desiredState for the compute environment and DescribeComputeEnvironments doesn't return one. For the purpose of provisioning the access entry, AWS Batch behaves as it does for INHERIT_FROM_CLUSTER.

Required: No

Type: EksAccessEntry

Update requires: No interruption

EksClusterArn

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

Required: Yes

Type: String

Update requires: Replacement

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 Namespaces in the Kubernetes documentation.

Required: Yes

Type: String

Update requires: Replacement