ecs_composex.docdb package

Submodules

ecs_composex.docdb.docdb_module module

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 , settings ) [source]

Bases: DatabaseXResource

Class to manage DocDB

init_outputs ( ) [source]

Method to init the DocDB output attributes

lookup_resource ( arn_re , native_lookup_function , cfn_resource_type , tagging_api_id , subattribute_key = None , use_arn_for_id = False ) [source]

Method to self-identify properties :return:

subnets_param = <ecs_composex.common.cfn_params.Parameter object>
class ecs_composex.docdb.docdb_stack. XStack ( title , settings , module , ** kwargs ) [source]

Bases: ComposeXStack

Class for the Stack of DocDB

ecs_composex.docdb.docdb_stack. get_db_cluster_config ( db , account_id , resource_id ) [source]
Para DocDb db :

Parameters :

  • account_id –

  • resource_id –

Returns :

ecs_composex.docdb.docdb_stack. resolve_lookup ( lookup_resources , settings , module ) [source]

Lookup AWS Resources

Parameters :

ecs_composex.docdb.docdb_template module

DocDB

ecs_composex.docdb.docdb_template. add_db_instances ( template , db ) [source]

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

Parameters :
Returns :

ecs_composex.docdb.docdb_template. add_parameters_group ( db ) [source]

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 ) [source]

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

Parameters :
ecs_composex.docdb.docdb_template. init_doc_db_template ( ) [source]

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 ) [source]
ecs_composex.docdb.docdb_template. set_db_cluster ( template , db , secret , sgs ) [source]

Function to parse and transform yaml definition to Troposphere

Parameters :

Module contents