interface EfsVolumeConfiguration
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.ECS.EfsVolumeConfiguration |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsecs#EfsVolumeConfiguration |
![]() | software.amazon.awscdk.services.ecs.EfsVolumeConfiguration |
![]() | aws_cdk.aws_ecs.EfsVolumeConfiguration |
![]() | aws-cdk-lib » aws_ecs » EfsVolumeConfiguration |
The configuration for an Elastic FileSystem volume.
Example
// 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
Name | Type | Description |
---|---|---|
file | string | The Amazon EFS file system ID to use. |
authorization | 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 | Whether or not to enable 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:
Authorization
(optional, default: No configuration.)
The authorization configuration details for the Amazon EFS file system.
rootDirectory?
Type:
string
(optional, default: The root of the Amazon EFS volume)
The directory within the Amazon EFS file system to mount as the root directory inside the host.
Specifying / will have the same effect as omitting this parameter.
transitEncryption?
Type:
string
(optional, default: 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
transitEncryptionPort?
Type:
number
(optional, default: Port selection strategy that the Amazon EFS mount helper uses.)
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.
EFS mount helper uses.