@aws-cdk_aws-batch-alpha.EmptyDirVolume

class EmptyDirVolume ๐Ÿ”น

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

Extends EksVolume

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 batch_alpha from '@aws-cdk/aws-batch-alpha';
import * as cdk from 'aws-cdk-lib';

declare const size: cdk.Size;
const emptyDirVolume = new batch_alpha.EmptyDirVolume({
  name: 'name',

  // the properties below are optional
  medium: batch_alpha.EmptyDirMediumType.DISK,
  mountPath: 'mountPath',
  readonly: false,
  sizeLimit: size,
});

Initializer

new EmptyDirVolume(options: EmptyDirVolumeOptions)

Parameters

  • options EmptyDirVolumeOptions

Properties

NameTypeDescription
name๐Ÿ”นstringThe name of this volume.
containerPath?๐Ÿ”นstringThe path on the container where the container is mounted.
medium?๐Ÿ”นEmptyDirMediumTypeThe storage type to use for this Volume.
readonly?๐Ÿ”นbooleanIf specified, the container has readonly access to the volume.
sizeLimit?๐Ÿ”นSizeThe 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: EmptyDirMediumType (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

NameDescription
static isEmptyDirVolume(x)๐Ÿ”นReturns true if x is an EmptyDirVolume, false otherwise.

static isEmptyDirVolume(x)๐Ÿ”น

public static isEmptyDirVolume(x: any): boolean

Parameters

  • x any

Returns

  • boolean

Returns true if x is an EmptyDirVolume, false otherwise.