/AWS1/CL_ECSS3FILESVOLUMECONF¶
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 AWS compute resources for required permissions.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_filesystemarn TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
The full ARN of the S3 Files file system to mount.
Optional arguments:¶
iv_rootdirectory TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
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.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.
iv_transitencryptionport TYPE /AWS1/ECSBOXEDINTEGER /AWS1/ECSBOXEDINTEGER¶
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.
iv_accesspointarn TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
The full ARN of the S3 Files access point to use. If an access point is specified, the root directory value specified in the
S3FilesVolumeConfigurationmust 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.
Queryable Attributes¶
fileSystemArn¶
The full ARN of the S3 Files file system to mount.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FILESYSTEMARN() |
Getter for FILESYSTEMARN, with configurable default |
ASK_FILESYSTEMARN() |
Getter for FILESYSTEMARN w/ exceptions if field has no value |
HAS_FILESYSTEMARN() |
Determine if FILESYSTEMARN has a value |
rootDirectory¶
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.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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROOTDIRECTORY() |
Getter for ROOTDIRECTORY, with configurable default |
ASK_ROOTDIRECTORY() |
Getter for ROOTDIRECTORY w/ exceptions if field has no value |
HAS_ROOTDIRECTORY() |
Determine if ROOTDIRECTORY has a value |
transitEncryptionPort¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TRANSITENCRYPTIONPORT() |
Getter for TRANSITENCRYPTIONPORT, with configurable default |
ASK_TRANSITENCRYPTIONPORT() |
Getter for TRANSITENCRYPTIONPORT w/ exceptions if field has |
HAS_TRANSITENCRYPTIONPORT() |
Determine if TRANSITENCRYPTIONPORT has a value |
accessPointArn¶
The full ARN of the S3 Files access point to use. If an access point is specified, the root directory value specified in the
S3FilesVolumeConfigurationmust 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACCESSPOINTARN() |
Getter for ACCESSPOINTARN, with configurable default |
ASK_ACCESSPOINTARN() |
Getter for ACCESSPOINTARN w/ exceptions if field has no valu |
HAS_ACCESSPOINTARN() |
Determine if ACCESSPOINTARN has a value |