class EmptyDirVolume
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Batch.EmptyDirVolume |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#EmptyDirVolume |
Java | software.amazon.awscdk.services.batch.EmptyDirVolume |
Python | aws_cdk.aws_batch.EmptyDirVolume |
TypeScript (source) | aws-cdk-lib » aws_batch » EmptyDirVolume |
Extends
Eks
A Kubernetes EmptyDir volume.
See also: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_batch as batch } from 'aws-cdk-lib';
declare const size: cdk.Size;
const emptyDirVolume = new batch.EmptyDirVolume({
name: 'name',
// the properties below are optional
medium: batch.EmptyDirMediumType.DISK,
mountPath: 'mountPath',
readonly: false,
sizeLimit: size,
});
Initializer
new EmptyDirVolume(options: EmptyDirVolumeOptions)
Parameters
- options
Empty
Dir Volume Options
Properties
Name | Type | Description |
---|---|---|
name | string | The name of this volume. |
container | string | The path on the container where the container is mounted. |
medium? | Empty | The storage type to use for this Volume. |
readonly? | boolean | If specified, the container has readonly access to the volume. |
size | Size | The maximum size for this 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
containerPath?
Type:
string
(optional, default: the container is not mounted)
The path on the container where the container is mounted.
medium?
Type:
Empty
(optional, default: EmptyDirMediumType.DISK
)
The storage type to use for this Volume.
readonly?
Type:
boolean
(optional, default: false)
If specified, the container has readonly access to the volume.
Otherwise, the container has read/write access.
sizeLimit?
Type:
Size
(optional, default: no size limit)
The maximum size for this Volume.
Methods
Name | Description |
---|---|
static is | Returns true if x is an EmptyDirVolume, false otherwise. |
EmptyDirVolume(x)
static ispublic static isEmptyDirVolume(x: any): boolean
Parameters
- x
any
Returns
boolean
Returns true
if x
is an EmptyDirVolume, false
otherwise.