ecs_composex.docdb package

Submodules

ecs_composex.docdb.docdb_ecs module

Module to link DocDB cluster to ECS Services.

ecs_composex.docdb.docdb_ecs. create_docdb_cluster_config_mapping ( resource , db_config )

Parameters

• resource –

• db_config –

Returns

ecs_composex.docdb.docdb_ecs. create_lookup_mappings ( mappings , lookup_dbs , settings )

Function to create the DocumentDB mappings to add to services templates

Parameters

• mappings ( dict ) –

• lookup_dbs ( list ) –

• settings ( ecs_composex.common.settings.ComposeXSettings ) – The settings for ComposeX Execution

ecs_composex.docdb.docdb_ecs. docdb_to_ecs ( resources , services_stack , res_root_stack , settings )

Entrypoint function to map new and lookup resources to ECS Services

Parameters

• resources ( list ) –

• services_stack ( ecs_composex.common.stacks.ComposeXStack ) –

• res_root_stack ( ecs_composex.common.stacks.ComposeXStack ) –

• settings ( ecs_composex.common.settings.ComposeXSettings ) –

ecs_composex.docdb.docdb_params module

ecs_composex.docdb.docdb_stack module

AWS DocumentDB entrypoint for ECS ComposeX

class ecs_composex.docdb.docdb_stack. DocDb ( name , definition , module_name , settings )

Bases: ecs_composex.common.compose_resources.XResource

Class to manage DocDB

init_outputs ( )

Method to init the DocDB output attributes

subnets_param = <ecs_composex.common.cfn_params.Parameter object>

class ecs_composex.docdb.docdb_stack. XStack ( title , settings , ** kwargs )

Bases: ecs_composex.common.stacks.ComposeXStack

Class for the Stack of DocDB

ecs_composex.docdb.docdb_template module

DocDB

ecs_composex.docdb.docdb_template. add_db_instances ( template , db )

Function to add DB Instances either based on properties or default. Default is to add one DB Instance, the smallest size there is.

Parameters

• template ( troposphere.Template ) –

• db ( ecs_composex.docdb.docdb_stack.DocDb ) –

Returns

ecs_composex.docdb.docdb_template. add_parameters_group ( db )

Function to create the DBClusterParameterGroup to associate with the cluster

Parameters

db ( ecs_composex.docdb.docdb_stack.DocDb ) –

Returns

parameter group

Return type

docdb.DBClusterParameterGroup

ecs_composex.docdb.docdb_template. create_docdb_template ( root_template , new_resources , settings , self_stack )

Function to create the root template for DocDB and associate the new resources to it.

Parameters

• root_template ( troposphere.Template ) –

• new_resources ( list ) –

• settings ( ecs_composex.common.settings.ComposeXSettings ) –

• self_stack ( ecs_composex.docdb.docdb_stack.XStack ) –

ecs_composex.docdb.docdb_template. init_doc_db_template ( )

Function to generate the base of the DocDB template. :return: the root template :rtype: troposphere.Template

ecs_composex.docdb.docdb_template. no_value_if_not_set ( props , key , is_bool = False )

ecs_composex.docdb.docdb_template. set_db_cluster ( template , db , secret , sgs )

Function to parse and transform yaml definition to Troposphere

Parameters

• db ( ecs_composex.docdb.docdb_stack.DocDb ) –

• secret ( troposphere.secretsmanager.Secret ) –

• sgs ( list<roposphere.ec2.SecurityGroup> ) –

Module contents