ecs_composex.kms package

Submodules

ecs_composex.kms.kms_ecs_cluster module

Functions to allow the S3 Bucket to interpolate x-s3 values for ECS Cluster

ecs_composex.kms.kms_ecs_cluster. handle_ecs_cluster ( settings , kms_key ) [source]

Entrypoint function to updating the ECS Cluster properties

Parameters :
Return type :

None

ecs_composex.kms.kms_ecs_cluster. interpolate_s3_kms_key_id ( exec_config , kms_key ) [source]

Replaces the value for x-s3::<kms_key_name> for the log configuration with the appropriate parameters

Parameters :
Return type :

None

ecs_composex.kms.kms_ecs_cluster. update_cluster_kms_property ( ecs_cluster , kms_key ) [source]
Parameters :
Return type :

None

ecs_composex.kms.kms_kinesis_firehose module

Updates x-kinesis_firehose fields and properties, IAM policies for Firehose::DeliveryStream

ecs_composex.kms.kms_kinesis_firehose. kms_to_firehose ( resource , dest_resource , dest_resource_stack , settings ) [source]

Updates properties of the Firehose Delivery Stream with KMS key settings

Parameters :
Return type :

None

ecs_composex.kms.kms_kinesis_firehose. set_for_lookup_kms_key ( prop_attr , resource , resource_id , dest_resource , settings ) [source]
Return type :

troposphere.AWSHelperFn

ecs_composex.kms.kms_kinesis_firehose. set_for_new_kms_key ( prop_attr , resource_id , dest_resource , dest_resource_stack ) [source]
Return type :

troposphere.AWSHelperFn

ecs_composex.kms.kms_module module

ecs_composex.kms.kms_params module

ecs_composex.kms.kms_s3 module

Handle x-kms in S3 buckets

ecs_composex.kms.kms_s3. assign_kms_key_to_bucket ( kms_key , bucket_rule , bucket_stack ) [source]

Assigns the KMS Key pointer to the bucket property

Parameters :
Returns :

ecs_composex.kms.kms_s3. handle_bucket_kms ( kms_key , bucket , bucket_stack , settings ) [source]

Goes over the properties of the bucket and if the KMSMasterKeyID points to the kms_key, assigns the value accordingly in the template

Parameters :
Returns :

ecs_composex.kms.kms_sqs module

Handle x-kms in x-sqs

ecs_composex.kms.kms_sqs. assign_kms_key_to_queue ( kms_key , queue , queue_stack , settings ) [source]

Assigns the KMS Key pointer to the queue property

Parameters :
Returns :

ecs_composex.kms.kms_sqs. handle_queue_kms ( kms_key , queue , queue_stack , settings ) [source]

Goes over the properties of the queue and if the KEY points to the kms_key, assigns the value accordingly in the template

Parameters :
Returns :

ecs_composex.kms.kms_stack module

Manage Creation/Deletion of AWS KMS Keys

class ecs_composex.kms.kms_stack. KmsKey ( name , definition , module , settings ) [source]

Bases: AwsEnvironmentResource , ApiXResource

Class to represent a KMS Key

define_kms_key ( ) [source]

Method to set the KMS Key

handle_key_settings ( template ) [source]

Method to add to the template for additional KMS key related resources.

Parameters :

template ( troposphere.Template ) –

handle_x_dependencies ( settings , root_stack = None ) [source]

WIll go over all the new resources to create in the execution and search for properties that can be updated with itself

Parameters :
Return type :

None

init_outputs ( ) [source]

Placeholder method

property is_cmk
class ecs_composex.kms.kms_stack. XStack ( title , settings , module , ** kwargs ) [source]

Bases: ComposeXStack

Class for KMS Root stack

do_validation : bool
properties : Dict[str, Any]
propnames : Set[str]
resource : Dict[str, Any]
template : Optional[Template]
title : Optional[str]
ecs_composex.kms.kms_stack. define_default_key_policy ( ) [source]

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

ecs_composex.kms.kms_stack. get_key_config ( key , account_id , resource_id ) [source]
Parameters :
  • key ( KmsKey ) –

  • account_id ( str ) – unused

  • resource_id ( str ) – unused

Return type :

dict | None

Returns :

ecs_composex.kms.kms_template module

ecs_composex.kms.kms_template. create_kms_template ( template , new_keys , xstack ) [source]

Function to create all the KMS Keys based on their definition

Parameters :

settings ( ecs_composex.common.settings.ComposeXSettings ) –

Module contents