interface EksConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Batch.CfnComputeEnvironment.EksConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#CfnComputeEnvironment_EksConfigurationProperty`
Java	`software.amazon.awscdk.services.batch.CfnComputeEnvironment.EksConfigurationProperty`
Python	`aws_cdk.aws_batch.CfnComputeEnvironment.EksConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_batch` » `CfnComputeEnvironment` » `EksConfigurationProperty`

Configuration for the Amazon EKS cluster that supports the AWS Batch compute environment.

The cluster must exist before the compute environment can be created.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_batch as batch } from 'aws-cdk-lib';
const eksConfigurationProperty: batch.CfnComputeEnvironment.EksConfigurationProperty = {
  eksClusterArn: 'eksClusterArn',
  kubernetesNamespace: 'kubernetesNamespace',

  // the properties below are optional
  accessEntry: {
    desiredState: 'desiredState',
    status: 'status',
  },
};

Properties

Name	Type	Description
eksClusterArn	`string`	The Amazon Resource Name (ARN) of the Amazon EKS cluster.
kubernetesNamespace	`string`	The namespace of the Amazon EKS cluster.
accessEntry?	`IResolvable` `\|` `EksAccessEntryProperty`	The EKS access entry configuration for the compute environment.

eksClusterArn

Type: string

The Amazon Resource Name (ARN) of the Amazon EKS cluster.

An example is arn: *aws* :eks: *us-east-1* : *123456789012* :cluster/ *ClusterForBatch* .

kubernetesNamespace

Type: string

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.

accessEntry?

Type: IResolvable | EksAccessEntryProperty (optional)

The EKS access entry configuration for the compute environment.

Controls whether AWS Batch manages the EKS access entry for the compute environment's service role, or inherits it from the cluster.

AWS CDK