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 | |
|---|---|
| Type last changed |
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 eFSVolumeConfigurationProperty: ecs.CfnTaskDefinition.EFSVolumeConfigurationProperty = {
filesystemId: 'filesystemId',
// the properties below are optional
authorizationConfig: {
accessPointId: 'accessPointId',
iam: 'iam',
},
rootDirectory: 'rootDirectory',
transitEncryption: 'transitEncryption',
transitEncryptionPort: 123,
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ecs as ecs
e_fs_volume_configuration_property = ecs.CfnTaskDefinition.EFSVolumeConfigurationProperty(
filesystem_id="filesystemId",
# the properties below are optional
authorization_config=ecs.CfnTaskDefinition.AuthorizationConfigProperty(
access_point_id="accessPointId",
iam="iam"
),
root_directory="rootDirectory",
transit_encryption="transitEncryption",
transit_encryption_port=123
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ecs.*;
EFSVolumeConfigurationProperty eFSVolumeConfigurationProperty = EFSVolumeConfigurationProperty.builder()
.filesystemId("filesystemId")
// the properties below are optional
.authorizationConfig(AuthorizationConfigProperty.builder()
.accessPointId("accessPointId")
.iam("iam")
.build())
.rootDirectory("rootDirectory")
.transitEncryption("transitEncryption")
.transitEncryptionPort(123)
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;
var eFSVolumeConfigurationProperty = new EFSVolumeConfigurationProperty {
FilesystemId = "filesystemId",
// the properties below are optional
AuthorizationConfig = new AuthorizationConfigProperty {
AccessPointId = "accessPointId",
Iam = "iam"
},
RootDirectory = "rootDirectory",
TransitEncryption = "transitEncryption",
TransitEncryptionPort = 123
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
eFSVolumeConfigurationProperty := &EFSVolumeConfigurationProperty{
FilesystemId: jsii.String("filesystemId"),
// the properties below are optional
AuthorizationConfig: &AuthorizationConfigProperty{
AccessPointId: jsii.String("accessPointId"),
Iam: jsii.String("iam"),
},
RootDirectory: jsii.String("rootDirectory"),
TransitEncryption: jsii.String("transitEncryption"),
TransitEncryptionPort: jsii.Number(123),
}
Properties
authorizationConfigoptionalIResolvable | CfnTaskDefinition.authorization_configoptionaltyping.Union[IResolvable, AuthorizationConfigProperty]authorizationConfigoptionalIResolvableAuthorizationConfigoptionalIResolvableAuthorizationConfigoptionalinterface{} #filesystemIdstringfilesystem_idstrfilesystemIdStringFilesystemIdstringFilesystemId*string required #rootDirectoryoptionalstringroot_directoryoptionalstrrootDirectoryoptionalStringRootDirectoryoptionalstringRootDirectoryoptional*string #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 #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 #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 .