aws-cdk-lib.aws_ecs.CfnTaskDefinition.S3FilesVolumeConfigurationProperty

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

Generated code

Type last changed

v2.250.0 · 14 Apr 2026

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,
};

Properties

accessPointArn?optionalstringaccess_point_arn?optionalstraccessPointArn?optionalStringAccessPointArn?optionalstringAccessPointArn?optional*string#

The full ARN of the S3 Files access point to use.

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*stringrequired#

The full ARN of the S3 Files file system to mount.

rootDirectory?optionalstringroot_directory?optionalstrrootDirectory?optionalStringRootDirectory?optionalstringRootDirectory?optional*string#

The directory within the Amazon S3 Files file system to mount as the root directory.

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.

transitEncryptionPort?optionalnumbertransit_encryption_port?optionalint | floattransitEncryptionPort?optionalNumberTransitEncryptionPort?optionaldoubleTransitEncryptionPort?optional*float64#

The port to use for sending encrypted data between the ECS host and the S3 Files file system.

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.