class EksVolume

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

Implemented by EmptyDirVolume, HostPathVolume, SecretPathVolume

A Volume that can be mounted to a container supported by EKS.

Example

const jobDefn = new batch.EksJobDefinition(this, 'eksf2', {
  container: new batch.EksContainerDefinition(this, 'container', {
    image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),
    volumes: [batch.EksVolume.emptyDir({
      name: 'myEmptyDirVolume',
      mountPath: '/mount/path',
      medium: batch.EmptyDirMediumType.MEMORY,
      readonly: true,
      sizeLimit: cdk.Size.mebibytes(2048),
    })],
  }),
});

Initializer

new EksVolume(options: EksVolumeOptions)

Parameters

options EksVolumeOptions

Properties

Name	Type	Description
name	`string`	The name of this volume.
containerPath?	`string`	The path on the container where the container is mounted.
readonly?	`boolean`	If specified, the container has readonly access to the volume.

name

Type: string

The name of this volume.

The name must be a valid DNS subdomain name.

containerPath?

Type: string (optional, default: the container is not mounted)

The path on the container where the container is mounted.

readonly?

Type: boolean (optional, default: false)

If specified, the container has readonly access to the volume.

Otherwise, the container has read/write access.

Methods

Name	Description
static emptyDir(options)	Creates a Kubernetes EmptyDir volume.
static hostPath(options)	Creates a Kubernetes HostPath volume.
static secret(options)	Creates a Kubernetes Secret volume.

static emptyDir(options)

public static emptyDir(options: EmptyDirVolumeOptions): EmptyDirVolume

Parameters

options EmptyDirVolumeOptions

Returns

EmptyDirVolume

Creates a Kubernetes EmptyDir volume.

static hostPath(options)

public static hostPath(options: HostPathVolumeOptions): HostPathVolume

Parameters

options HostPathVolumeOptions

Returns

HostPathVolume

Creates a Kubernetes HostPath volume.

static secret(options)

public static secret(options: SecretPathVolumeOptions): SecretPathVolume

Parameters

options SecretPathVolumeOptions

Returns

SecretPathVolume

Creates a Kubernetes Secret volume.