@aws-cdk_aws-batch-alpha.SecretPathVolumeOptions

interface SecretPathVolumeOptions ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Batch.Alpha.SecretPathVolumeOptions
Gogithub.com/aws/aws-cdk-go/awscdkbatchalpha/v2#SecretPathVolumeOptions
Javasoftware.amazon.awscdk.services.batch.alpha.SecretPathVolumeOptions
Pythonaws_cdk.aws_batch_alpha.SecretPathVolumeOptions
TypeScript (source)@aws-cdk/aws-batch-alpha ยป 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

NameTypeDescription
name๐Ÿ”นstringThe name of this volume.
secretName๐Ÿ”นstringThe name of the secret.
mountPath?๐Ÿ”นstringThe path on the container where the volume is mounted.
optional?๐Ÿ”นbooleanSpecifies whether the secret or the secret's keys must be defined.
readonly?๐Ÿ”นbooleanIf 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.