interface EFSVolumeConfigurationProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.ECS.CfnTaskDefinition.EFSVolumeConfigurationProperty |
Java | software.amazon.awscdk.services.ecs.CfnTaskDefinition.EFSVolumeConfigurationProperty |
Python | aws_cdk.aws_ecs.CfnTaskDefinition.EFSVolumeConfigurationProperty |
TypeScript | @aws-cdk/aws-ecs » CfnTaskDefinition » EFSVolumeConfigurationProperty |
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 .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ecs from '@aws-cdk/aws-ecs';
const eFSVolumeConfigurationProperty: ecs.CfnTaskDefinition.EFSVolumeConfigurationProperty = {
filesystemId: 'filesystemId',
// the properties below are optional
authorizationConfig: {
accessPointId: 'accessPointId',
iam: 'iam',
},
rootDirectory: 'rootDirectory',
transitEncryption: 'transitEncryption',
transitEncryptionPort: 123,
};
Properties
Name | Type | Description |
---|---|---|
filesystem | string | The Amazon EFS file system ID to use. |
authorization | IResolvable | Authorization | The authorization configuration details for the Amazon EFS file system. |
root | string | The directory within the Amazon EFS file system to mount as the root directory inside the host. |
transit | string | Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. |
transit | number | The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. |
filesystemId
Type:
string
The Amazon EFS file system ID to use.
authorizationConfig?
Type:
IResolvable
|
Authorization
(optional)
The authorization configuration details for the Amazon EFS file system.
rootDirectory?
Type:
string
(optional)
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 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.
transitEncryption?
Type:
string
(optional)
Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
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 .
transitEncryptionPort?
Type:
number
(optional)
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.
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 .