AWS CDK Reference

Appearance

v2.275.0

EFSVolumeConfigurationProperty Struct ​

This parameter is specified when you're using an Amazon Elastic File System file system for task storage.

For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide .

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

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 eFSVolumeConfigurationProperty: ecs.CfnTaskDefinition.EFSVolumeConfigurationProperty = {
  filesystemId: 'filesystemId',

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

Properties ​

authorizationConfigoptionalIResolvable | CfnTaskDefinition.AuthorizationConfigPropertyauthorization_configoptionaltyping.Union[IResolvable, AuthorizationConfigProperty]authorizationConfigoptionalIResolvableAuthorizationConfigoptionalIResolvableAuthorizationConfigoptionalinterface{}#
The authorization configuration details for the Amazon EFS file system.
filesystemIdstringfilesystem_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.
notes

If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig , the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

transitEncryptionoptionalstringtransit_encryptionoptionalstrtransitEncryptionoptionalStringTransitEncryptionoptionalstringTransitEncryptionoptional*string#
Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
notes

Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide .

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

If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide .