interface SecretPathVolumeOptions

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

Options for a Kubernetes SecretPath Volume.

See also: https://kubernetes.io/docs/concepts/storage/volumes/#secret

Example

declare const jobDefn: batch.EksJobDefinition;
jobDefn.container.addVolume(batch.EksVolume.emptyDir({
  name: 'emptyDir',
  mountPath: '/Volumes/emptyDir',
}));
jobDefn.container.addVolume(batch.EksVolume.hostPath({
  name: 'hostPath',
  hostPath: '/sys',
  mountPath: '/Volumes/hostPath',
}));
jobDefn.container.addVolume(batch.EksVolume.secret({
  name: 'secret',
  optional: true,
  mountPath: '/Volumes/secret',
  secretName: 'mySecret',
}));

Properties

Name	Type	Description
name	string	The name of this volume.
secretName	string	The name of the secret.
mountPath?	string	The path on the container where the volume is mounted.
optional?	boolean	Specifies whether the secret or the secret's keys must be defined.
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.

See also: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names

---

secretName

Type: string

The name of the secret.

Must be a valid DNS subdomain name.

See also: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names

---

mountPath?

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

The path on the container where the volume is mounted.

---

optional?

Type: boolean (optional, default: true)

Specifies whether the secret or the secret's keys must be defined.

---

readonly?

Type: boolean (optional, default: false)

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

Otherwise, the container has read/write access.