Skip to content

EFSVolumeConfiguration

Source code in docs_src/capo_batch/types/efs_volume_configuration.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class EFSVolumeConfiguration(TypedDict, closed=True):
    file_system_id: NotRequired["capo_batch.types.string.String"]
    """<p>The Amazon EFS file system ID to use.</p>"""
    root_directory: NotRequired["capo_batch.types.string.String"]
    """<p>The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying <code>/</code> has the same effect as omitting this parameter. The maximum length is 4,096 characters.</p> <important> <p>If an EFS access point is specified in the <code>authorizationConfig</code>, the root directory parameter must either be omitted or set to <code>/</code>, which enforces the path set on the Amazon EFS access point.</p> </important>"""
    transit_encryption: NotRequired[
        "capo_batch.types.efs_transit_encryption.EFSTransitEncryption"
    ]
    """<p>Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of <code>DISABLED</code> is used. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html">Encrypting data in transit</a> in the <i>Amazon Elastic File System User Guide</i>.</p>"""
    transit_encryption_port: NotRequired["capo_batch.types.integer.Integer"]
    """<p>The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html">EFS mount helper</a> in the <i>Amazon Elastic File System User Guide</i>.</p>"""
    authorization_config: NotRequired[
        "capo_batch.types.efs_authorization_config.EFSAuthorizationConfig"
    ]
    """<p>The authorization configuration details for the Amazon EFS file system.</p>"""

authorization_config instance-attribute 

authorization_config: NotRequired[EFSAuthorizationConfig]

The authorization configuration details for the Amazon EFS file system.

file_system_id instance-attribute 

file_system_id: NotRequired[String]

The Amazon EFS file system ID to use.

root_directory instance-attribute 

root_directory: NotRequired[String]

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

transit_encryption instance-attribute 

transit_encryption: NotRequired[EFSTransitEncryption]

Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled 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.

transit_encryption_port instance-attribute 

transit_encryption_port: NotRequired[Integer]

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.