ecs_composex.efs package

Submodules

ecs_composex.efs.efs_ecs module

ecs_composex.efs.efs_ecs. add_efs_definition_to_target_family ( new_efs , target ) [source]
ecs_composex.efs.efs_ecs. add_task_iam_access_to_access_point ( family , access_points , efs ) [source]

Function to add IAM Permissions to mount to EFS via AccessPoint for ECS Task

Parameters
ecs_composex.efs.efs_ecs. efs_to_ecs ( resources , services_stack , res_root_stack , settings ) [source]

Function to associate back the EFS FS to services.

Parameters
Returns

ecs_composex.efs.efs_ecs. expand_family_with_efs_volumes ( efs_root_stack_title , new_efs , settings ) [source]

Function to add the EFS Volume definition to the task definition for the service to use.

Parameters
Returns

ecs_composex.efs.efs_ecs. get_service_mount_points ( service ) [source]

Function to get the MountPoints from the container definition of a service

Parameters

service ( ecs_composex.common.compose_services.ComposeService ) –

Returns

list of mount points or new list

Return type

list

ecs_composex.efs.efs_ecs. get_volumes ( task_definition ) [source]

Function to fetch the volumes from the task definition

Parameters

task_definition ( troposphere.ecs.TaskDefinition ) –

Returns

the volumes list of the task definition or new ones

Return type

list

ecs_composex.efs.efs_ecs. override_efs_settings ( new_efs , target , fs_id_parameter , access_points , volumes ) [source]

Function to determine if access points should be set on a per service of the task definition and update the volumes and mount points accordingly

Parameters
Returns

ecs_composex.efs.efs_ecs. override_service_volume ( new_efs , fs_id , target , access_points , volumes ) [source]

Function to override service volume if a specific definition was set for it

ecs_composex.efs.efs_ecs. set_user_to_access_points ( efs , fs_id , access_points , service ) [source]

Function to set the PosixUser to a specific access point for a specific given service

ecs_composex.efs.efs_params module

ecs_composex.efs.efs_stack module

Module to handle the creation of the root EFS stack

class ecs_composex.efs.efs_stack. Efs ( name , definition , module_name , settings , mapping_key = None ) [source]

Bases: ecs_composex.common.compose_resources.XResource

Class to represent a Filesystem

init_outputs ( ) [source]

Method to init the DocDB output attributes

subnets_param = <ecs_composex.common.cfn_params.Parameter object>
class ecs_composex.efs.efs_stack. XStack ( name , settings , ** kwargs ) [source]

Bases: ecs_composex.common.stacks.ComposeXStack

Class to represent the root for EFS

ecs_composex.efs.efs_stack. create_efs_stack ( settings , new_resources ) [source]

Function to create the root stack and add EFS FS.

Parameters
Returns

Root template for EFS

Return type

troposphere.Template

Module contents

Sub Package to handle x-efs