@aws-cdk_aws-batch-alpha.SecretPathVolume

class SecretPathVolume ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Batch.Alpha.SecretPathVolume
Gogithub.com/aws/aws-cdk-go/awscdkbatchalpha/v2#SecretPathVolume
Javasoftware.amazon.awscdk.services.batch.alpha.SecretPathVolume
Pythonaws_cdk.aws_batch_alpha.SecretPathVolume
TypeScript (source)@aws-cdk/aws-batch-alpha ยป SecretPathVolume

Extends EksVolume

Specifies the configuration of a Kubernetes secret volume.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as batch_alpha from '@aws-cdk/aws-batch-alpha';
const secretPathVolume = new batch_alpha.SecretPathVolume({
  name: 'name',
  secretName: 'secretName',

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

Initializer

new SecretPathVolume(options: SecretPathVolumeOptions)

Parameters

  • options SecretPathVolumeOptions

Properties

NameTypeDescription
name๐Ÿ”นstringThe name of this volume.
secretName๐Ÿ”นstringThe name of the secret.
containerPath?๐Ÿ”นstringThe path on the container where the container 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


containerPath?๐Ÿ”น

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

The path on the container where the container 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.

Methods

NameDescription
static isSecretPathVolume(x)๐Ÿ”นreturns true if x is a SecretPathVolume and false otherwise.

static isSecretPathVolume(x)๐Ÿ”น

public static isSecretPathVolume(x: any): boolean

Parameters

  • x any

Returns

  • boolean

returns true if x is a SecretPathVolume and false otherwise.