Skip to content
v2.278.0

EksVolumeOptions Struct ​

Options to configure an EksVolume.

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 eksVolumeOptions: batch.EksVolumeOptions = {
  name: 'name',

  // the properties below are optional
  mountPath: 'mountPath',
  readonly: false,
};
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_volume_options = batch.EksVolumeOptions(
    name="name",

    # the properties below are optional
    mount_path="mountPath",
    readonly=False
)
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.*;

EksVolumeOptions eksVolumeOptions = EksVolumeOptions.builder()
        .name("name")

        // the properties below are optional
        .mountPath("mountPath")
        .readonly(false)
        .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 eksVolumeOptions = new EksVolumeOptions {
    Name = "name",

    // the properties below are optional
    MountPath = "mountPath",
    Readonly = false
};
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"

eksVolumeOptions := &EksVolumeOptions{
	Name: jsii.String("name"),

	// the properties below are optional
	MountPath: jsii.String("mountPath"),
	Readonly: jsii.Boolean(false),
}

Properties ​

mountPathoptionalstringmount_pathoptionalstrmountPathoptionalStringMountPathoptionalstringMountPathoptional*string #
The path on the container where the volume is mounted.

Default: the volume is not mounted

namestringnamestrnameStringNamestringName*string required #
The name of this volume.

The name must be a valid DNS subdomain name.

readonlyoptionalbooleanreadonlyoptionalboolreadonlyoptionalBooleanReadonlyoptionalboolReadonlyoptional*bool = false #
If specified, the container has readonly access to the volume.

Otherwise, the container has read/write access.