S3FilesVolumeConfigurationProperty Struct
This parameter is specified when you're using an Amazon S3 Files file system for task storage.
For more information, see Amazon S3 Files volumes in the Amazon Elastic Container Service Developer Guide. Your task definition must include a Task IAM Role. See IAM role for attaching your file system to compute resources for required permissions.
| 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 s3FilesVolumeConfigurationProperty: ecs.CfnTaskDefinition.S3FilesVolumeConfigurationProperty = {
fileSystemArn: 'fileSystemArn',
// the properties below are optional
accessPointArn: 'accessPointArn',
rootDirectory: 'rootDirectory',
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
s3_files_volume_configuration_property = ecs.CfnTaskDefinition.S3FilesVolumeConfigurationProperty(
file_system_arn="fileSystemArn",
# the properties below are optional
access_point_arn="accessPointArn",
root_directory="rootDirectory",
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.*;
S3FilesVolumeConfigurationProperty s3FilesVolumeConfigurationProperty = S3FilesVolumeConfigurationProperty.builder()
.fileSystemArn("fileSystemArn")
// the properties below are optional
.accessPointArn("accessPointArn")
.rootDirectory("rootDirectory")
.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 s3FilesVolumeConfigurationProperty = new S3FilesVolumeConfigurationProperty {
FileSystemArn = "fileSystemArn",
// the properties below are optional
AccessPointArn = "accessPointArn",
RootDirectory = "rootDirectory",
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"
s3FilesVolumeConfigurationProperty := &S3FilesVolumeConfigurationProperty{
FileSystemArn: jsii.String("fileSystemArn"),
// the properties below are optional
AccessPointArn: jsii.String("accessPointArn"),
RootDirectory: jsii.String("rootDirectory"),
TransitEncryptionPort: jsii.Number(123),
}
Properties
accessPointArnoptionalstringaccess_point_arnoptionalstraccessPointArnoptionalStringAccessPointArnoptionalstringAccessPointArnoptional*string #notes
If an access point is specified, the root directory value specified in the S3FilesVolumeConfiguration must either be omitted or set to / which will enforce the path set on the S3 Files access point. For more information, see Creating S3 Files access points.
fileSystemArnstringfile_system_arnstrfileSystemArnStringFileSystemArnstringFileSystemArn*string required #rootDirectoryoptionalstringroot_directoryoptionalstrrootDirectoryoptionalStringRootDirectoryoptionalstringRootDirectoryoptional*string #notes
If this parameter is omitted, the root of the Amazon S3 Files file system will be used. Specifying / will have the same effect as omitting this parameter. If a S3 Files access point is specified in the accessPointArn, the root directory parameter must either be omitted or set to / which will enforce the path set on the S3 Files access point.
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 S3 Files mount helper uses. For more information, see S3 Files mount helper.