EfsVolumeConfiguration

class aws_cdk.aws_ecs.EfsVolumeConfiguration(*, authorization_config=None, file_system_id, root_directory=None, transit_encryption=None, transit_encryption_port=None)

Bases: object

The configuration for an Elastic FileSystem volume.

Parameters
  • authorization_config (Optional[AuthorizationConfig]) – The authorization configuration details for the Amazon EFS file system. Default: No configuration.

  • file_system_id (str) – The Amazon EFS file system ID to use.

  • root_directory (Optional[str]) – The directory within the Amazon EFS file system to mount as the root directory inside the host. Specifying / will have the same effect as omitting this parameter. Default: The root of the Amazon EFS volume

  • transit_encryption (Optional[str]) – Whether or not 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. Valid values: ENABLED | DISABLED Default: DISABLED

  • transit_encryption_port (Union[int, float, None]) – The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. EFS mount helper uses. Default: Port selection strategy that the Amazon EFS mount helper uses.

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ecs as ecs

efs_volume_configuration = ecs.EfsVolumeConfiguration(
    file_system_id="fileSystemId",

    # the properties below are optional
    authorization_config=ecs.AuthorizationConfig(
        access_point_id="accessPointId",
        iam="iam"
    ),
    root_directory="rootDirectory",
    transit_encryption="transitEncryption",
    transit_encryption_port=123
)

Attributes

authorization_config

The authorization configuration details for the Amazon EFS file system.

Default

No configuration.

Return type

Optional[AuthorizationConfig]

file_system_id

The Amazon EFS file system ID to use.

Return type

str

root_directory

The directory within the Amazon EFS file system to mount as the root directory inside the host.

Specifying / will have the same effect as omitting this parameter.

Default

The root of the Amazon EFS volume

Return type

Optional[str]

transit_encryption

Whether or not 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.

Valid values: ENABLED | DISABLED

Default

DISABLED

Return type

Optional[str]

transit_encryption_port

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.

EFS mount helper uses.

Default

Port selection strategy that the Amazon EFS mount helper uses.

Return type

Union[int, float, None]