S3FilesVolumeConfiguration¶
Structure Class¶
S3FilesVolumeConfiguration
dataclass
¶
Bases: _SerdeShape
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.
Warning
Your task definition must include a Task IAM Role. See IAM role for attaching your file system to Amazon Web Services compute resources for required permissions.
Attributes¶
access_point_arn
class-attribute
instance-attribute
¶
access_point_arn: str | None = ...
The full ARN of the S3 Files access point to use. 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.
file_system_arn
instance-attribute
¶
file_system_arn: str
The full ARN of the S3 Files file system to mount.
root_directory
class-attribute
instance-attribute
¶
root_directory: str | None = ...
The directory within the Amazon S3 Files file system to mount as the
root directory. 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.
Warning
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.
transit_encryption_port
class-attribute
instance-attribute
¶
transit_encryption_port: int | None = ...
The port to use for sending encrypted data between the ECS host and the S3 Files file system. 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.