ecs_composex.acm package ¶
Submodules ¶
ecs_composex.acm.acm_module module ¶
ecs_composex.acm.acm_params module ¶
Parameters specific to AWS ACM
ecs_composex.acm.acm_stack module ¶
Main module for ACM
- class ecs_composex.acm.acm_stack. Certificate ( name , definition , module , settings ) [source] ¶
-
Bases:
AwsEnvironmentResource
Class specifically for ACM Certificate
- define_parameters_props ( ) [source] ¶
-
Determines the Properties to use for new ACM Certificate
- Returns :
-
properties dict
- Return type :
-
dict
- handle_x_dependencies ( settings , root_stack ) [source] ¶
-
- Parameters :
-
-
settings ( ecs_composex.common.settings.ComposeXSettings ) –
-
root_stack ( ComposeXStack ) –
-
- class ecs_composex.acm.acm_stack. XStack ( name , settings , module , ** kwargs ) [source] ¶
-
Bases:
ComposeXStack
Root stack for x-acm new certificates
- Parameters :
-
settings ( ecs_composex.common.settings.ComposeXSettings ) –
ecs_composex.acm.acm_stack_helpers module ¶
- ecs_composex.acm.acm_stack_helpers. define_acm_certs ( new_resources , acm_stack ) [source] ¶
-
Function to create the certificates
- Parameters :
-
-
new_resources ( list [ Certificate ] ) –
-
acm_stack ( ecs_composex.common.stacks.ComposeXStack ) –
-
- ecs_composex.acm.acm_stack_helpers. get_cert_config ( certificate , account_id , resource_id ) [source] ¶
-
Retrieves the AWS ACM Certificate details using AWS API
- Return type :
-
typing.Optional
[dict
]
- ecs_composex.acm.acm_stack_helpers. resolve_lookup ( lookup_resources , settings , module ) [source] ¶
-
Lookup the ACM certificates in AWS and creates the CFN mappings for them
- Parameters :
-
-
lookup_resources ( list [ Certificate ] ) – List of resources to lookup
-
settings ( ecs_composex.common.settings.ComposeXSettings ) –
-
module ( ecs_composex.mod_manager.XResourceModule ) –
-
- Return type :
-
None
- ecs_composex.acm.acm_stack_helpers. update_property_stack_with_resource ( x_certificate , property_stack , properties_to_update , property_name , settings ) [source] ¶
-
Function to associate the resource
- Parameters :
-
-
x_certificate ( Certificate ) –
-
property_stack ( ecs_composex.common.stacks.ComposeXStack ) –
-
properties_to_update ( list ) –
-
property_name ( str ) –
-
settings ( ecs_composex.common.settings.ComposeXSettings ) –
-
- Return type :
-
None
- ecs_composex.acm.acm_stack_helpers. update_stack_with_resource_settings ( property_stack , the_resource , the_property , property_name , settings ) [source] ¶
-
Assigns the CFN pointer to the value to replace. If it is a new certificate, it will add the parameter to get the cert ARN and set the parameter stack value If it is a Lookup certificate, it will add the mapping to the stack and set FindInMap to the certificate ARN
- Parameters :
-
-
property_stack ( ComposeXStack ) –
-
the_resource ( Certificate ) –
-
the_property –
-
property_name (
str
) – -
settings ( ecs_composex.common.settings.ComposeXSettings ) –
-
- Return type :
-
None
Module contents ¶
Root module for ACM