AWS CDK Reference

Appearance

v2.273.0

SecretPathVolumeOptions Struct ​

Options for a Kubernetes SecretPath Volume.

Source
aws-batch/lib/eks-container-definition.ts
Type last changed
v2.96.0 · 13 Sep 2023

Example ​

ts
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 ​

mountPathstringmount_pathstrmountPathStringMountPathstringMountPath*string= the volume is not mounted#
The path on the container where the volume is mounted.
namestringnamestrnameStringNamestringName*stringrequired#
The name of this volume.

The name must be a valid DNS subdomain name.

optionalbooleanoptionalbooloptionalBooleanOptionalboolOptional*bool= true#
Specifies whether the secret or the secret's keys must be defined.
readonlybooleanreadonlyboolreadonlyBooleanReadonlyboolReadonly*bool= false#
If specified, the container has readonly access to the volume.

Otherwise, the container has read/write access.

secretNamestringsecret_namestrsecretNameStringSecretNamestringSecretName*stringrequired#
The name of the secret.

Must be a valid DNS subdomain name.

Used as props by ​