class SecretPathVolume
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Batch.SecretPathVolume |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#SecretPathVolume |
![]() | software.amazon.awscdk.services.batch.SecretPathVolume |
![]() | aws_cdk.aws_batch.SecretPathVolume |
![]() | aws-cdk-lib » aws_batch » SecretPathVolume |
Extends
Eks
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 { 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
new SecretPathVolume(options: SecretPathVolumeOptions)
Parameters
- options
Secret
Path Volume Options
Properties
Name | Type | Description |
---|---|---|
name | string | The name of this volume. |
secret | string | The name of the secret. |
container | string | The path on the container where the container 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
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
Name | Description |
---|---|
static is | 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.