Skip to content
v2.275.0

EfsVolumeConfiguration Struct ​

The configuration for an Elastic FileSystem volume.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const efsVolumeConfiguration: ecs.EfsVolumeConfiguration = {
  fileSystemId: 'fileSystemId',

  // the properties below are optional
  authorizationConfig: {
    accessPointId: 'accessPointId',
    iam: 'iam',
  },
  rootDirectory: 'rootDirectory',
  transitEncryption: 'transitEncryption',
  transitEncryptionPort: 123,
};

Properties ​

authorizationConfigoptionalAuthorizationConfigauthorization_configoptionalAuthorizationConfigauthorizationConfigoptionalAuthorizationConfigAuthorizationConfigoptionalAuthorizationConfigAuthorizationConfigoptionalAuthorizationConfig#
The authorization configuration details for the Amazon EFS file system.

Default: No configuration.

fileSystemIdstringfile_system_idstrfileSystemIdStringFileSystemIdstringFileSystemId*stringrequired#
The Amazon EFS file system ID to use.
rootDirectoryoptionalstringroot_directoryoptionalstrrootDirectoryoptionalStringRootDirectoryoptionalstringRootDirectoryoptional*string#
The directory within the Amazon EFS file system to mount as the root directory inside the host.

Default: The root of the Amazon EFS volume

Specifying / will have the same effect as omitting this parameter.

transitEncryptionoptionalstringtransit_encryptionoptionalstrtransitEncryptionoptionalStringTransitEncryptionoptionalstringTransitEncryptionoptional*string= DISABLED#
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.

Transit encryption must be enabled if Amazon EFS IAM authorization is used.

Valid values: ENABLED | DISABLED

transitEncryptionPortoptionalnumbertransit_encryption_portoptionalint | floattransitEncryptionPortoptionalNumberTransitEncryptionPortoptionaldoubleTransitEncryptionPortoptional*float64#
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.

Default: Port selection strategy that the Amazon EFS mount helper uses.

EFS mount helper uses.