Skip to content
v2.278.0

EksConfigurationProperty Struct ​

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 ​

ts
// 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',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_batch as batch

eks_configuration_property = batch.CfnComputeEnvironment.EksConfigurationProperty(
    eks_cluster_arn="eksClusterArn",
    kubernetes_namespace="kubernetesNamespace",

    # the properties below are optional
    access_entry=batch.CfnComputeEnvironment.EksAccessEntryProperty(
        desired_state="desiredState",
        status="status"
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.batch.*;

EksConfigurationProperty eksConfigurationProperty = EksConfigurationProperty.builder()
        .eksClusterArn("eksClusterArn")
        .kubernetesNamespace("kubernetesNamespace")

        // the properties below are optional
        .accessEntry(EksAccessEntryProperty.builder()
                .desiredState("desiredState")
                .status("status")
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Batch;

var eksConfigurationProperty = new EksConfigurationProperty {
    EksClusterArn = "eksClusterArn",
    KubernetesNamespace = "kubernetesNamespace",

    // the properties below are optional
    AccessEntry = new EksAccessEntryProperty {
        DesiredState = "desiredState",
        Status = "status"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

eksConfigurationProperty := &EksConfigurationProperty{
	EksClusterArn: jsii.String("eksClusterArn"),
	KubernetesNamespace: jsii.String("kubernetesNamespace"),

	// the properties below are optional
	AccessEntry: &EksAccessEntryProperty{
		DesiredState: jsii.String("desiredState"),
		Status: jsii.String("status"),
	},
}

Properties ​

accessEntryoptionalIResolvable | CfnComputeEnvironment.EksAccessEntryPropertyaccess_entryoptionaltyping.Union[IResolvable, EksAccessEntryProperty]accessEntryoptionalIResolvableAccessEntryoptionalIResolvableAccessEntryoptionalinterface{} #
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.

eksClusterArnstringeks_cluster_arnstreksClusterArnStringEksClusterArnstringEksClusterArn*string required #
The Amazon Resource Name (ARN) of the Amazon EKS cluster.

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

kubernetesNamespacestringkubernetes_namespacestrkubernetesNamespaceStringKubernetesNamespacestringKubernetesNamespace*string required #
The namespace of the Amazon EKS cluster.
notes

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.