ecs_composex.opensearch package

Submodules

ecs_composex.opensearch.opensearch_aws module

ecs_composex.opensearch.opensearch_aws. create_opensearch_mappings ( lookup_resources , settings ) [source]

Updates the mappings for the Lookup resources

Parameters :
ecs_composex.opensearch.opensearch_aws. get_domain_config ( arn , session ) [source]

Function to retrieve the Domain settings

Parameters :

  • arn –

  • session –

Returns :

ecs_composex.opensearch.opensearch_aws. lookup_resource ( lookup , session ) [source]

ecs_composex.opensearch.opensearch_module module

ecs_composex.opensearch.opensearch_params module

OpenSearch parameters

ecs_composex.opensearch.opensearch_stack module

class ecs_composex.opensearch.opensearch_stack. OpenSearchDomain ( name , definition , module , settings ) [source]

Bases: DatabaseXResource

Class to represent the OpenSearch domain

init_outputs ( ) [source]

Initializes the output properties

to_ecs ( settings , modules , root_stack = None ) [source]

Mapping for OpenSearch domains override from default RDS DB access

Return type :

None

class ecs_composex.opensearch.opensearch_stack. XStack ( title , settings , module , ** kwargs ) [source]

Bases: ComposeXStack

Class for KMS Root stack

ecs_composex.opensearch.opensearch_stack. define_default_key_policy ( ) [source]

Function to return the default KMS management policy allowing root account access. :return: policy :rtype: dict

ecs_composex.opensearch.opensearch_template module

OpenSearch module to manage creation of new OpenSearch domains

ecs_composex.opensearch.opensearch_template. add_new_security_group ( domain , properties , stack ) [source]

Function to create a new Security Group :param ecs_composex.opensearch.opensearch_stack.OpenSearchDomain domain: :param dict properties: :param ecs_composex.common.stacks.ComposeXStack stack:

ecs_composex.opensearch.opensearch_template. apply_domain_parameters ( domain , stack , props ) [source]
Parameters :
ecs_composex.opensearch.opensearch_template. correct_properties ( domain , props ) [source]

Function to rectify settings in case invalid options were set with each other.

Parameters :
ecs_composex.opensearch.opensearch_template. correcting_required_settings ( domain , props ) [source]
Parameters :
Returns :

ecs_composex.opensearch.opensearch_template. create_log_groups ( domain , stack , props ) [source]
Parameters :
Returns :

ecs_composex.opensearch.opensearch_template. create_new_domains ( new_domains , stack ) [source]

Function to create the new CFN Template for the OS Domains to create

Parameters :
ecs_composex.opensearch.opensearch_template. define_domain_security_group ( domain , stack ) [source]

Create a new Security Group for the Domain

Parameters :
Returns :

The security Group

ecs_composex.opensearch.opensearch_template. generate_master_user ( domain , stack , props ) [source]
Parameters :
Returns :

ecs_composex.opensearch.opensearch_template. validate_instance_types ( domain , props ) [source]

Validates that the settings set are compatible with one another

Parameters :
ecs_composex.opensearch.opensearch_template. validate_instance_types_config ( domain , props , instance_type , config ) [source]
Parameters :
Raises :

ValueError if features are not compatible withe the instance type

ecs_composex.opensearch.opensearch_template. validate_no_architecture_mix ( domain , types ) [source]

Function to ensure there is no Graviton instances mixed with non-graviton ones

Parameters :
Raises :

ValueError if not all instances are of the same architecture

ecs_composex.opensearch.opensearch_template. validate_security_groups ( domain , groups ) [source]
ecs_composex.opensearch.opensearch_template. validate_version_support ( domain , props , instance_type , config ) [source]
Parameters :
Raises :

ValueError if features are not compatible withe the instance type

Module contents