ecs_composex.kinesis package

Submodules

ecs_composex.kinesis.kcl_helpers module

Module to help with KCL IAM Permissions configuration to the services

ecs_composex.kinesis.kcl_helpers. add_cloudwatch_metric_data_permission ( family ) [source]

Adds permissions to publish metrics data to CloudWatch

Return type :

None

ecs_composex.kinesis.kcl_helpers. add_dynamodb_permissions ( family , dynamodb_definition ) [source]

Adds permissions to access DynamoDB If is boolean, grant all default access to DynamoDB If is dict, applies permissions based on the settings defined by user

Return type :

None

ecs_composex.kinesis.kcl_helpers. define_dynamodb_statement ( dynamodb_definition ) [source]
Return type :

list

ecs_composex.kinesis.kinesis_kinesis_firehose module

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

ecs_composex.kinesis.kinesis_kinesis_firehose. kinesis_to_firehose ( resource , dest_resource , dest_resource_stack , settings ) [source]

Updates :type resource: :param resource: :type dest_resource: :param dest_resource: :type dest_resource_stack: :param dest_resource_stack: :type settings: ecs_composex.common.settings.ComposeXSettings :param settings: :rtype: None :return:

ecs_composex.kinesis.kinesis_module module

ecs_composex.kinesis.kinesis_params module

ecs_composex.kinesis.kinesis_stack module

Module to handle import/create AWS Kinesis Data Streams

class ecs_composex.kinesis.kinesis_stack. Stream ( name , definition , module , settings ) [source]

Bases: ApiXResource

Class to represent a Kinesis Stream

handle_x_dependencies ( settings , root_stack ) [source]

Updates other resources and replace the values for x-kinesis wherever applicable.

Parameters :
Return type :

None

Returns :

init_outputs ( ) [source]

Placeholder method

setup_iam_for_kcl ( settings ) [source]

When SetupIAMForKCL is set in MacroParameters, grant IAM permissions access to other resources

Return type :

None

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

Maps API only based resource to ECS Services

Return type :

None

class ecs_composex.kinesis.kinesis_stack. XStack ( title , settings , module , ** kwargs ) [source]

Bases: ComposeXStack

Class to represent Kinesis Data Streams stack

do_validation : bool
properties : Dict[str, Any]
propnames : Set[str]
resource : Dict[str, Any]
template : Optional[Template]
title : Optional[str]
ecs_composex.kinesis.kinesis_stack. get_stream_config ( stream , account_id , resource_id ) [source]

Function to get the configuration of KMS Stream from API

Parameters :
  • stream ( Stream ) –

  • account_id ( str ) –

  • resource_id ( str ) –

Returns :

ecs_composex.kinesis.kinesis_stack. resolve_lookup ( lookup_resources , settings , module ) [source]

Lookup AWS Kinesis streams and creates CFN Mappings

ecs_composex.kinesis.kinesis_template module

ecs_composex.kinesis.kinesis_template. create_new_stream ( stream ) [source]

Function to create the new Kinesis stream :param ecs_composex.kinesis.kinesis_stack.Stream stream: :param ecs_composex.common.settings.ComposeXSettings settings: :return:

ecs_composex.kinesis.kinesis_template. create_streams_template ( new_resources , settings ) [source]

Function to create the root template for Kinesis streams

Parameters :
Returns :

ecs_composex.kinesis.kinesis_template. handle_encryption ( stream ) [source]

Function to define the encryption

Parameters :

stream

Returns :

Module contents