Package software.amazon.awscdk.mixins.preview.services.batch.mixins

Interface CfnComputeEnvironmentPropsMixin.EksConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComputeEnvironmentPropsMixin.EksConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnComputeEnvironmentPropsMixin

@Stability(Stable)
public static interface CfnComputeEnvironmentPropsMixin.EksConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.mixins.preview.services.batch.mixins.*;
 EksConfigurationProperty eksConfigurationProperty = EksConfigurationProperty.builder()
         .eksClusterArn("eksClusterArn")
         .kubernetesNamespace("kubernetesNamespace")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-eksconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnComputeEnvironmentPropsMixin.EksConfigurationProperty.Builder	A builder for CfnComputeEnvironmentPropsMixin.EksConfigurationProperty
static final class	CfnComputeEnvironmentPropsMixin.EksConfigurationProperty.Jsii$Proxy	An implementation for CfnComputeEnvironmentPropsMixin.EksConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnComputeEnvironmentPropsMixin.EksConfigurationProperty.Builder	builder()
default String	getEksClusterArn()	The Amazon Resource Name (ARN) of the Amazon EKS cluster.
default String	getKubernetesNamespace()	The namespace of the Amazon EKS cluster.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEksClusterArn

@Stability(Stable)
@Nullable
default String getEksClusterArn()

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-eksconfiguration.html#cfn-batch-computeenvironment-eksconfiguration-eksclusterarn

getKubernetesNamespace

@Stability(Stable)
@Nullable
default String getKubernetesNamespace()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-eksconfiguration.html#cfn-batch-computeenvironment-eksconfiguration-kubernetesnamespace

builder

@Stability(Stable)
static CfnComputeEnvironmentPropsMixin.EksConfigurationProperty.Builder builder()

Returns:

a CfnComputeEnvironmentPropsMixin.EksConfigurationProperty.Builder of CfnComputeEnvironmentPropsMixin.EksConfigurationProperty