ecs_composex.neptune package

Submodules

ecs_composex.neptune.neptune_module module

ecs_composex.neptune.neptune_params module

ecs_composex.neptune.neptune_stack module

AWS DocumentDB entrypoint for ECS ComposeX

class ecs_composex.neptune.neptune_stack. NeptuneDBCluster ( name , definition , module , settings )

Bases: DatabaseXResource

Class to manage Neptune Cluster

init_outputs ( )

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 )

Method to self-identify properties :return:

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

to_ecs ( settings , modules , root_stack = None )

Maps a database service to ECS services

Parameters :

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

• modules ( ModManager ) –

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

Return type :

None

class ecs_composex.neptune.neptune_stack. XStack ( title , settings , module , ** kwargs )

Bases: ComposeXStack

Class for the Stack of x-neptune

ecs_composex.neptune.neptune_stack. get_db_cluster_config ( db , account_id , resource_id )

ecs_composex.neptune.neptune_template module

ecs_composex.neptune.neptune_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_stack.DocDb ) –

Returns :

ecs_composex.neptune.neptune_template. add_parameters_group ( db )

Function to create the DBClusterParameterGroup to associate with the cluster

Parameters :

db ( ecs_composex.docdb_stack.DocDb ) –

Returns :

parameter group

Return type :

DBClusterParameterGroup

ecs_composex.neptune.neptune_template. create_neptune_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_stack.XStack ) –

ecs_composex.neptune.neptune_template. set_db_cluster ( template , db , sgs )

Function to parse and transform yaml definition to Troposphere

Parameters :

• template ( troposphere.Template ) –

• db ( ecs_composex.docdb_stack.DocDb ) –

• secret ( troposphere.secretsmanager.Secret ) –

• sgs ( list ) –

Module contents