class EfsVolume
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Batch.EfsVolume |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#EfsVolume |
![]() | software.amazon.awscdk.services.batch.EfsVolume |
![]() | aws_cdk.aws_batch.EfsVolume |
![]() | aws-cdk-lib » aws_batch » EfsVolume |
Extends
Ecs
A Volume that uses an AWS Elastic File System (EFS);
this volume can grow and shrink as needed
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';
import { aws_efs as efs } from 'aws-cdk-lib';
declare const fileSystem: efs.FileSystem;
const efsVolume = new batch.EfsVolume({
containerPath: 'containerPath',
fileSystem: fileSystem,
name: 'name',
// the properties below are optional
accessPointId: 'accessPointId',
enableTransitEncryption: false,
readonly: false,
rootDirectory: 'rootDirectory',
transitEncryptionPort: 123,
useJobRole: false,
});
Initializer
new EfsVolume(options: EfsVolumeOptions)
Parameters
- options
Efs
Volume Options
Properties
Name | Type | Description |
---|---|---|
container | string | The path on the container that this volume will be mounted to. |
file | IFile | The EFS File System that supports this volume. |
name | string | The name of this volume. |
access | string | The Amazon EFS access point ID to use. |
enable | boolean | Enables encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. |
readonly? | boolean | Whether or not the container has readonly access to this volume. |
root | string | The directory within the Amazon EFS file system to mount as the root directory inside the host. |
transit | number | The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. |
use | boolean | Whether or not to use the AWS Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. |
containerPath
Type:
string
The path on the container that this volume will be mounted to.
fileSystem
Type:
IFile
The EFS File System that supports this volume.
name
Type:
string
The name of this volume.
accessPointId?
Type:
string
(optional, default: no accessPointId)
The Amazon EFS access point ID to use.
If an access point is specified, rootDirectory
must either be omitted or set to /
which enforces the path set on the EFS access point.
If an access point is used, enableTransitEncryption
must be true
.
See also: https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html
enableTransitEncryption?
Type:
boolean
(optional, default: false)
Enables encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
See also: https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html
readonly?
Type:
boolean
(optional, default: false)
Whether or not the container has readonly access to this volume.
rootDirectory?
Type:
string
(optional, default: root of the EFS File System)
The directory within the Amazon EFS file system to mount as the root directory inside the host.
If this parameter is omitted, the root of the Amazon EFS volume is used instead.
Specifying /
has the same effect as omitting this parameter.
The maximum length is 4,096 characters.
transitEncryptionPort?
Type:
number
(optional, default: chosen by the EFS Mount Helper)
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.
The value must be between 0 and 65,535.
See also: https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html
useJobRole?
Type:
boolean
(optional, default: false)
Whether or not to use the AWS Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.
If specified, enableTransitEncryption
must be true
.
Methods
Name | Description |
---|---|
static is | Returns true if x is an EfsVolume, false otherwise. |
static isEfsVolume(x)
public static isEfsVolume(x: any): boolean
Parameters
- x
any
Returns
boolean
Returns true if x is an EfsVolume, false otherwise.