ecs_composex.elbv2.elbv2_stack package

Subpackages

• ecs_composex.elbv2.elbv2_stack.elbv2_listener package
  • Submodules
  • ecs_composex.elbv2.elbv2_stack.elbv2_listener.lookup_listener module
    • LookupListener
      • LookupListener.Certificates
      • LookupListener.Port
      • LookupListener.Protocol
      • LookupListener.certificates
      • LookupListener.define_new_rules()
      • LookupListener.definition
      • LookupListener.handle_cognito_pools()
      • LookupListener.lb
      • LookupListener.map_lb_target_groups_service_to_listener_targets()
      • LookupListener.map_target_group_to_listener()
      • LookupListener.port
      • LookupListener.props
      • LookupListener.targets_keys
      • LookupListener.tidy_targets()
  • Module contents
    • ComposeListener
      • ComposeListener.attributes
      • ComposeListener.def_port
      • ComposeListener.define_default_actions()
      • ComposeListener.handle_certificates()
      • ComposeListener.handle_cognito_pools()
      • ComposeListener.lb
      • ComposeListener.map_lb_target_groups_service_to_listener_targets()
      • ComposeListener.map_target_group_to_listener()
      • ComposeListener.targets_keys

Submodules

ecs_composex.elbv2.elbv2_stack.elbv2 module

class ecs_composex.elbv2.elbv2_stack.elbv2. Elbv2 ( name , definition , module , settings )

Bases: NetworkXResource

Class to handle ELBv2 creation and mapping to ECS Services

associate_to_template ( template )

Method to associate all resources to the template

Parameters :

template ( troposphere.Template ) –

Returns :

define_override_subnets ( subnets , vpc_stack )

Method to define the subnets overrides to use for the LB

Parameters :

• subnets – The original subnets to replace

• vpc_stack ( ecs_composex.vpc.vpc_stack.VpcStack ) –

Returns :

the subnet name to use

Return type :

str

find_lookup_listeners ( )

Method to lookup the listeners defined in the definition and sets them up. Will use them to add to the LB mappings

init_outputs ( )

Placeholder method

is_alb ( )

is_nlb ( )

property lb_type : str

parse_attributes_settings ( )

Method to parse pre-defined settings for shortcuts

Returns :

the lb attributes mappings

Return type :

list

set_eips ( vpc_stack )

Parameters :

vpc_stack ( ecs_composex.vpc.vpc_stack.VpcStack ) –

Returns :

set_lb_attributes ( )

Method to define the LB attributes

Returns :

List of LB Attributes

Return type :

list

set_lb_definition ( )

Function to parse the LB settings and properties and build the LB object

Parameters :

settings ( ecs_composex.common.settings.ComposeXSettings ) –

set_listeners ( template )

Method to define the listeners :return:

set_services_targets ( settings )

Method to map services and families targets of the services defined. TargetStructure: (family, family_wide, services[], access)

Parameters :

settings ( ecs_composex.common.settings.ComposeXSettings ) –

Returns :

set_subnet_mappings ( vpc_stack )

For NLB, defines the EC2 EIP and Subnets Mappings to use. Determines the number of EIP to produce from the VPC Settings.

set_subnets ( vpc_stack )

Method to define which subnets to use for the

Parameters :

vpc_stack ( ecs_composex.vpc.vpc_stack.VpcStack ) –

Returns :

sort_alb_ingress ( settings , stack_template )

Method to handle Ingress to ALB

sort_props ( )

sort_sg ( )

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

update_from_vpc ( vpc_stack , settings = None )

Override to set the specific resources right once we have a VPC Definition

Parameters :

• vpc_stack ( ecs_composex.vpc.vpc_stack.VpcStack ) –

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

validate_services ( )

ecs_composex.elbv2.elbv2_stack.helpers module

ecs_composex.elbv2.elbv2_stack.helpers. add_acm_certs_arn ( listener , src_value , settings , listener_stack )

Function to add Certificate to Listener with input from manual ARN entry :type listener: :param listener: :param str src_value: :type settings: :param settings: :type listener_stack: :param listener_stack: :return:

ecs_composex.elbv2.elbv2_stack.helpers. add_extra_certificate ( listener_stack , listener , cert_arn )

Function to add Certificates to listener

Parameters :

• listener_stack – The stack that “owns” the listener.

• listener – The listener to add the certificate to

• cert_arn – The identifier of the certificate

ecs_composex.elbv2.elbv2_stack.helpers. add_listener_certificate_via_arn ( listener_stack , listener , certificate_arn_id , cert_name )

Adds a new ListenerCertificate for a given listener.

ListenerCertificate can only take 1 certificate in the list !!

Parameters :

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

• listener ( ecs_composex.elbv2.elbv2_stack.elbv2_listener.ComposeListener ) –

• certificate_arn_id ( str ) – the ID to point to the certificate

• cert_name ( str ) –

Return type :

None

ecs_composex.elbv2.elbv2_stack.helpers. define_actions ( listener , target_def , rule_actions = False )

Function to identify the Target definition and create the resulting rule appropriately.

Parameters :

• target_def ( dict ) –

• listener ( ecs_composex.elbv2.elbv2_stack.elbv2_listener.ComposeListener ) –

• rule_actions ( bool ) – Whether to use Action or ListenerRuleAction

Return type :

list

Returns :

The action to add or action list for default target

ecs_composex.elbv2.elbv2_stack.helpers. define_listener_rules_actions ( listener , left_services )

Function to identify the Target definition and create the resulting rule appropriately.

Return type :

list [ troposphere.elasticloadbalancingv2.ListenerRule ]

ecs_composex.elbv2.elbv2_stack.helpers. define_target_conditions ( definition )

Function to create the conditions for forward to target

Parameters :

definition ( dict ) –

Returns :

list of conditions

Return type :

list

ecs_composex.elbv2.elbv2_stack.helpers. handle_cross_zone ( value )

Handles MacroParamters for cross-zone.

Return type :

troposphere.elasticloadbalancingv2.LoadBalancerAttributes

ecs_composex.elbv2.elbv2_stack.helpers. handle_default_actions ( listener )

Handles default actions set on the listener

Return type :

None

ecs_composex.elbv2.elbv2_stack.helpers. handle_desync_mitigation_mode ( value )

Handles MacroParamters for desync mitigation.

Return type :

troposphere.elasticloadbalancingv2.LoadBalancerAttributes

ecs_composex.elbv2.elbv2_stack.helpers. handle_drop_invalid_headers ( value )

Handles MacroParamters for drop invalid headers.

Return type :

troposphere.elasticloadbalancingv2.LoadBalancerAttributes

ecs_composex.elbv2.elbv2_stack.helpers. handle_http2 ( value )

Handles MacroParamters for HTTP2.

Return type :

troposphere.elasticloadbalancingv2.LoadBalancerAttributes

ecs_composex.elbv2.elbv2_stack.helpers. handle_import_cognito_pool ( the_pool , listener_stack , settings )

Function to map AWS Cognito Pool to attributes

Return type :

tuple

ecs_composex.elbv2.elbv2_stack.helpers. handle_non_default_services ( listener )

Function to handle define the listener rule and identify

Return type :

list

ecs_composex.elbv2.elbv2_stack.helpers. handle_predefined_redirects ( listener , action_name )

Function to handle predefined redirects

Return type :

None

ecs_composex.elbv2.elbv2_stack.helpers. handle_string_condition_format ( access_string )

Function to parse and understand what type of condition that is. Uses the Access parameter of the Target inside a Listener Supported : * path based * domain name

Parameters :

access_string –

Return type :

list

Returns :

ecs_composex.elbv2.elbv2_stack.helpers. handle_timeout_seconds ( timeout_seconds )

Handles MacroParamters for timeout.

Return type :

troposphere.elasticloadbalancingv2.LoadBalancerAttributes

ecs_composex.elbv2.elbv2_stack.helpers. http_to_https_default ( default_of_all = False )

Predefined rule to redirect HTTP to HTTPS

Return type :

troposphere.elasticloadbalancingv2.Action

ecs_composex.elbv2.elbv2_stack.helpers. import_cognito_pool ( src_name , settings , listener_stack )

Function to Import an Cognito Pool defined in x-cognito_pool

ecs_composex.elbv2.elbv2_stack.helpers. import_new_acm_certs ( listener , src_name , settings , listener_stack )

Function to Import an ACM Certificate defined in x-acm

Parameters :

• listener –

• src_name –

• settings –

• listener_stack –

Returns :

ecs_composex.elbv2.elbv2_stack.helpers. map_service_target ( lb , listener_service_def )

Function to iterate over targets to map the service and its defined TargetGroup ARN

Return type :

None

ecs_composex.elbv2.elbv2_stack.helpers. match_target_group_to_listener_target ( target_group , listener_service_def , target_parts )

Return type :

bool

ecs_composex.elbv2.elbv2_stack.helpers. tea_pot ( default_of_all = False )

Predefined reply for ALB config rule, returning HTTP Tea Pot

Return type :

troposphere.elasticloadbalancingv2.Action

ecs_composex.elbv2.elbv2_stack.helpers. upgrade_listener_to_use_tls ( listener )

Function to rectify the listener type when adding cert

Parameters :

listener ( ecs_composex.elbv2.elbv2_stack.elbv2_listener.ComposeListener ) –

Raises :

ValueError if trying to set TLS for UDP

ecs_composex.elbv2.elbv2_stack.helpers. validate_duplicate_targets ( lb , listener )

Return type :

None

ecs_composex.elbv2.elbv2_stack.helpers. validate_listeners_duplicates ( name , ports )

Ensures values are correct for ports used in Listeners

Parameters :

• name –

• ports –

Return type :

None

Returns :

Module contents

Module to handle elbv2.

class ecs_composex.elbv2.elbv2_stack. XStack ( title , settings , module , ** kwargs )

Bases: ComposeXStack

Class to handle ELBv2 resources

ecs_composex.elbv2.elbv2_stack. init_elbv2_template ( )

Function to create a new root ELBv2 stack :return: