ecs_composex.compose package

Subpackages

• ecs_composex.compose.compose_secrets package
  • Submodules
  • ecs_composex.compose.compose_secrets.ecs_family_helpers module
    • identify_repo_credentials_secret()
    • set_repository_credentials()
  • ecs_composex.compose.compose_secrets.helpers module
    • define_env_var_name()
    • to_capitalize()
    • to_java_properties()
    • to_title()
  • ecs_composex.compose.compose_secrets.services_helpers module
    • map_secrets()
    • match_secrets_services_config()
  • Module contents
    • ComposeSecret
      • ComposeSecret.add_json_keys()
      • ComposeSecret.define_links()
      • ComposeSecret.define_names_from_import()
      • ComposeSecret.define_names_from_lookup()
      • ComposeSecret.define_secret()
      • ComposeSecret.env_var
      • ComposeSecret.json_keys_key
      • ComposeSecret.links_key
      • ComposeSecret.main_key
      • ComposeSecret.map_arn_name
      • ComposeSecret.map_kms_name
      • ComposeSecret.map_name
      • ComposeSecret.map_name_name
      • ComposeSecret.x_key
• ecs_composex.compose.compose_services package
  • Subpackages
    • ecs_composex.compose.compose_services.service_image package
      • Submodules
      • ecs_composex.compose.compose_services.service_image.docker_opts module
      • ecs_composex.compose.compose_services.service_image.ecr_helpers module
      • ecs_composex.compose.compose_services.service_image.ecr_scans_eval module
      • Module contents
    • ecs_composex.compose.compose_services.service_logging package
      • Submodules
      • ecs_composex.compose.compose_services.service_logging.helpers module
      • Module contents
  • Submodules
  • ecs_composex.compose.compose_services.docker_tools module
    • find_closest_fargate_configuration()
    • find_closest_ram_config()
    • handle_bytes_units()
    • import_time_values_to_seconds()
    • set_compute_resources()
    • set_memory_to_mb()
  • ecs_composex.compose.compose_services.env_files_helpers module
    • add_envfiles_bucket_iam_access()
    • upload_services_env_files()
  • ecs_composex.compose.compose_services.helpers module
    • define_ingress_mappings()
    • define_string_interpolation()
    • extend_container_envvars()
    • extend_container_secrets()
    • import_env_variables()
    • import_secrets()
    • set_environment_dict_from_list()
    • set_validate_environment()
    • sub_generate()
    • validate_healthcheck()
  • ecs_composex.compose.compose_services.kernel_options_helpers module
    • define_kernel_options()
    • set_add_capacities()
    • set_drop_capacities()
  • Module contents
    • ComposeService
      • ComposeService.capacity_provider_strategy
      • ComposeService.command
      • ComposeService.compose_x_arn
      • ComposeService.composed_env_processing()
      • ComposeService.container_name
      • ComposeService.container_start_condition
      • ComposeService.cpu_amount
      • ComposeService.define_port_mappings()
      • ComposeService.definition
      • ComposeService.deploy_labels
      • ComposeService.ecs_healthcheck
      • ComposeService.ecs_plugin_aws_keys
      • ComposeService.ecs_user
      • ComposeService.entrypoint
      • ComposeService.env_files
      • ComposeService.ephemeral_storage
      • ComposeService.families
      • ComposeService.family
      • ComposeService.family_hostname
      • ComposeService.handle_expose_ports()
      • ComposeService.healthcheck
      • ComposeService.import_docker_labels()
      • ComposeService.import_x_aws_settings()
      • ComposeService.is_essential
      • ComposeService.kernel_properties
      • ComposeService.launch_type
      • ComposeService.logical_name
      • ComposeService.main_key
      • ComposeService.memory_limit
      • ComposeService.memory_reservations
      • ComposeService.networks
      • ComposeService.replicas
      • ComposeService.resources
      • ComposeService.runtime_architecture
      • ComposeService.runtime_os_family
      • ComposeService.set_container_definition()
      • ComposeService.set_user_group()
      • ComposeService.set_x_credentials_secret()
      • ComposeService.shm_size
      • ComposeService.stop_grace_period
      • ComposeService.sysctls
      • ComposeService.tmpfs
      • ComposeService.ulimits
      • ComposeService.update_config
      • ComposeService.user_define_essential
      • ComposeService.working_dir
      • ComposeService.x_iam
• ecs_composex.compose.compose_volumes package
  • Submodules
  • ecs_composex.compose.compose_volumes.ecs_family_helpers module
    • define_host_volumes()
    • define_shared_volumes()
    • mount_point_exists()
    • set_services_mount_points()
    • set_volumes()
  • ecs_composex.compose.compose_volumes.helpers module
    • evaluate_plugin_efs_properties()
  • ecs_composex.compose.compose_volumes.services_helpers module
    • handle_tmpfs()
    • handle_volume_dict_config()
    • handle_volume_str_config()
    • is_tmpfs()
    • map_volumes()
    • match_volumes_services_config()
  • Module contents
    • ComposeVolume
      • ComposeVolume.driver_key
      • ComposeVolume.driver_opts_key
      • ComposeVolume.efs_defaults
      • ComposeVolume.import_from_x_efs_settings()
      • ComposeVolume.import_local_volume()
      • ComposeVolume.import_volume_from_definition()
      • ComposeVolume.main_key
• ecs_composex.compose.x_resources package
  • Submodules
  • ecs_composex.compose.x_resources.api_x_resources module
    • ApiXResource
      • ApiXResource.to_ecs()
  • ecs_composex.compose.x_resources.environment_x_resources module
    • AwsEnvironmentResource
  • ecs_composex.compose.x_resources.helpers module
    • get_setting_key()
    • get_top_stack()
    • set_lookup_resources()
    • set_new_resources()
    • set_resources()
  • ecs_composex.compose.x_resources.network_x_resources module
    • DatabaseXResource
      • DatabaseXResource.to_ecs()
    • NetworkXResource
      • NetworkXResource.cleanse_external_targets()
      • NetworkXResource.remove_services_after_family_cleanups()
      • NetworkXResource.set_override_subnets()
      • NetworkXResource.update_from_vpc()
  • ecs_composex.compose.x_resources.services_resources module
    • ServicesXResource
      • ServicesXResource.debug_families_targets()
      • ServicesXResource.define_service_to_associate()
      • ServicesXResource.handle_families_scaling_expansion_dict()
      • ServicesXResource.handle_families_targets_expansion_dict()
      • ServicesXResource.set_services_scaling()
      • ServicesXResource.set_services_targets()
      • ServicesXResource.set_services_targets_from_dict()
      • ServicesXResource.set_services_targets_scaling_from_dict()
  • Module contents
    • XResource
      • XResource.add_attribute_to_another_stack()
      • XResource.add_new_output_attribute()
      • XResource.add_parameter_to_family_stack()
      • XResource.cloud_control_attributes_mapping_lookup()
      • XResource.compose_x_arn
      • XResource.define_export_name()
      • XResource.env_var_prefix
      • XResource.generate_cfn_mappings_from_lookup_properties()
      • XResource.generate_outputs()
      • XResource.generate_ref_env_var()
      • XResource.generate_resource_service_env_vars()
      • XResource.get_resource_attribute_value()
      • XResource.init_outputs()
      • XResource.lookup_resource()
      • XResource.mod_mapping_key
      • XResource.mod_res_key
      • XResource.native_attributes_mapping_lookup()
      • XResource.parameters
      • XResource.post_processing()
      • XResource.property_to_parameter_mapping
      • XResource.set_attributes_from_mapping()
      • XResource.set_new_resource_outputs()
      • XResource.set_update_container_env_var()
      • XResource.uses_default
      • XResource.validate()
      • XResource.validate_schema()
    • validate_input_value()

Submodules

ecs_composex.compose.compose_networks module

Class and functions to interact with the networks: defined in compose files.

class ecs_composex.compose.compose_networks. ComposeNetwork ( name , definition , subnets_list )

Bases: object

Class to keep track of the Docker-compose Volumes

driver_opts_key = 'driver'

main_key = 'networks'

ecs_composex.compose.compose_networks. match_networks_services_config ( service , net_config , networks )

Function to map network config in services and top-level networks

Parameters :

• service –

• net_config ( dict ) –

• networks ( list ) –

Raises :

LookupError –

Module contents