# EksVolumeOptions

Options to configure an EksVolume.

Used as props by: [EksVolume](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_batch.EksVolume.html)

- Source: [`aws-batch/lib/eks-container-definition.ts`](https://github.com/aws/aws-cdk/blob/v2.278.0/packages/aws-cdk-lib/aws-batch/lib/eks-container-definition.ts#L652)
- Type last changed: v2.96.0 · 13 Sep 2023

## Example

TypeScript:

```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:

```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:

```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();
```

C# / .NET:

```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
};
```

Golang:

```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

- `mountPath`: string — The path on the container where the volume is mounted.

  **Default:** the volume is not mounted

- `name`: string (required) — The name of this volume.

  The name must be a valid DNS subdomain name.

- `readonly`: boolean = false — If specified, the container has readonly access to the volume.

  Otherwise, the container has read/write access.
