# SecretPathVolume

Specifies the configuration of a Kubernetes secret volume.

Extends: EksVolume › SecretPathVolume

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

## 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 secretPathVolume = new batch.SecretPathVolume({
  name: 'name',
  secretName: 'secretName',

  // the properties below are optional
  mountPath: 'mountPath',
  optional: false,
  readonly: false,
});
```

## Initializer

```ts
new SecretPathVolume(options: SecretPathVolumeOptions)
```

## Properties

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

  **Default:** the container is not mounted

- `name`: string — The name of this volume.

  The name must be a valid DNS subdomain name.

- `optional`: boolean = true — Specifies whether the secret or the secret's keys must be defined.

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

  Otherwise, the container has read/write access.

- `secretName`: string — The name of the secret.

  Must be a valid DNS subdomain name.

## Methods

- `emptyDir(options: EmptyDirVolumeOptions): EmptyDirVolume` (static) — Creates a Kubernetes EmptyDir volume.

- `hostPath(options: HostPathVolumeOptions): HostPathVolume` (static) — Creates a Kubernetes HostPath volume.

- `isSecretPathVolume(x: any): boolean` (static) — returns `true` if `x` is a `SecretPathVolume` and `false` otherwise.

- `secret(options: SecretPathVolumeOptions): SecretPathVolume // chainable` (static) — Creates a Kubernetes Secret volume.