aws-solutions-constructs.aws-sqs-pipes-stepfunctions 2.73.0__py3-none-any.whl

aws_solutions_constructs/aws_sqs_pipes_stepfunctions/__init__.py

@@ -0,0 +1,639 @@
+r'''
+# aws-sqs-pipes-stepfunctions module
+
+<!--BEGIN STABILITY BANNER-->---
+
+
+![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
+
+---
+<!--END STABILITY BANNER-->
+
+| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
+|:-------------|:-------------|
+
+<div style="height:8px"></div>
+
+| **Language**     | **Package**        |
+|:-------------|-----------------|
+|![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_sqs_pipes_stepfunctions`|
+|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-sqs-pipes-stepfunctions`|
+|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.sqspipesstepfunctions`|
+
+## Overview
+
+This AWS Solutions Construct implements an AWS SQS queue whose messages are passed to an AWS Step Functions state machine by an Amazon Eventbridge pipe.
+
+Here is a minimal deployable pattern definition:
+
+Typescript
+
+```python
+import { Construct } from 'constructs';
+import { Stack, StackProps } from 'aws-cdk-lib';
+import * as stepfunctions from 'aws-cdk-lib/aws-stepfunctions';
+import { SqsToPipesToStepfunctions, SqsToPipesToStepfunctionsProps } from "@aws-solutions-constructs/aws-sqs-pipes-stepfunctions";
+
+const startState = new stepfunctions.Pass(this, 'StartState');
+
+new SqsToPipesToStepfunctions(this, 'SqsToLambdaToStepfunctionsPattern', {
+  stateMachineProps: {
+    definition: startState
+  }
+});
+```
+
+## Pattern Construct Props
+
+| **Name**     | **Type**        | **Description** |
+|:-------------|:----------------|-----------------|
+|existingQueueObj?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|An optional, existing SQS queue to be used instead of the default queue. Providing both this and `queueProps` will cause an error.|
+|queueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional user provided properties to override the default properties for the SQS queue.|
+|encryptQueueWithCmk|`boolean`|Whether to encrypt the Queue with a customer managed KMS key (CMK). This is the default behavior, and this property defaults to true - if it is explicitly set to false then the Queue is encrypted with an Amazon managed KMS key. For a completely unencrypted Queue (not recommended), create the Queue separately from the construct and pass it in using the existingQueueObject. Since SNS subscriptions do not currently support SQS queues with AWS managed encryption keys, setting this to false will always result in an error from the underlying CDK - we have still included this property for consistency with topics and to be ready if the services one day support this functionality.|
+|queueEncryptionKeyProps?|[`kms.KeyProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html#construct-props)|An optional subset of key properties to override the default properties used by constructs (`enableKeyRotation: true`). These properties will be used in constructing the CMK used to encrypt the SQS queue.|
+|existingQueueEncryptionKey?|[`kms.Key`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html)|An optional CMK that will be used by the construct to encrypt the new SQS queue.|
+|deployDeadLetterQueue?|`boolean`|Whether to create a secondary queue to be used as a dead letter queue. Defaults to true.|
+|deadLetterQueueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional user-provided props to override the default props for the dead letter SQS queue.|
+|maxReceiveCount?|`number`|The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to 15.|
+|stateMachineProps|[`sfn.StateMachineProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachineProps.html)|User provided props for the sfn.StateMachine.|
+|createCloudWatchAlarms?|`boolean`|Whether to create recommended CloudWatch alarms|
+| logGroupProps? | [logs.logGroupProps ](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroupProps.html)| Optional user provided props to override the default props for for the CloudWatchLogs LogGroup for the state machine. |
+|pipeProps?|[ pipes.CfnPipeProps ](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_pipes.CfnPipeProps.html)|Optional customer provided settings for the EventBridge pipe. source, target, roleArn and enrichment settings are set by the construct and cannot be overriden here. The construct will generate default sourceParameters, targetParameters and logConfiguration (found [here](link)) that can be overriden by populating those values in these props. If the client wants to implement enrichment or a filter, this is where that information can be provided. Any other props can be freely overridden. If a client wants to set values such as batchSize, that can be done here in the sourceParameters property.|
+| enrichmentFunction? | [lambda.Function ](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html) | Optional - Lambda function that the construct will configure to be called to enrich the message between source and target. The construct will configure the pipe IAM role to allow invoking the function (but will not affect the IArole assigned to the function). Specifying both this and enrichmentStateMachine is an error. Default - undefined |
+| enrichmentStateMachine? | [sfn.StateMachine ](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachine.html) | Optional - Step Functions state machine that the construct will configure to be called to enrich the message between source and target. The construct will configure the pipe IAM role to allow executing the state machine (but will not affect the IAM role assigned to the state machine). Specifying both this and enrichmentStateMachine is an error. Default - undefined |
+|logLevel?|PipesLogLevel|Threshold for what messages the new pipe sends to the log, PipesLogLevel.OFF, PipesLogLevel.ERROR, PipesLogLevel.INFO, PipesLogLevel.TRACE. The default is INFO. Setting the level to OFF will prevent any log group from being created. Providing pipeProps.logConfiguration will controls all aspects of logging and any construct provided log configuration is disabled. If pipeProps.logConfiguration is provided then specifying this or pipeLogProps is an error. |
+|pipeLogProps?|[logs.LogGroupProps]()| Default behavior is for the this construct to create a new CloudWatch Logs log group for the pipe. These props are used to override defaults set by AWS or this construct. If there are concerns about the cost of log storage, this is where a client can specify a shorter retention duration (in days) |
+
+## Pattern Properties
+
+| **Name**     | **Type**        | **Description** |
+|:-------------|:----------------|-----------------|
+|stateMachine|[`sfn.StateMachine`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachine.html)|Returns an instance of StateMachine created by the construct.|
+|stateMachineLogGroup|[`logs.ILogGroup`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.ILogGroup.html)|Returns an instance of the ILogGroup created by the construct for StateMachine|
+|cloudwatchAlarms?|[`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html)|Returns a list of alarms created by the construct.|
+|sqsQueue|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of the SQS queue created by the pattern. |
+|deadLetterQueue?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of the dead letter queue created by the pattern, if one is deployed.|
+|encryptionKey?|[kms.IKey](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html)|Returns an instance of kms.Key used for the SQS queue if key is customer managed.|
+|pipe|[ pipes.CfnPipe](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_pipes.CfnPipe.html)| The L1 pipe construct created by this Solutions Construct. |
+| pipeRole | [iam.Role ](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html) | The role created that allows the pipe to access both the source and the target. |
+
+## Default settings
+
+Out of the box implementation of the Construct without any override will set the following defaults:
+
+### Amazon SQS Queue
+
+* Deploy SQS dead-letter queue for the source SQS Queue.
+* Enable server-side encryption for source SQS Queue using AWS Managed KMS Key.
+* Enforce encryption of data in transit
+
+### AWS Step Functions State Machine
+
+* Deploy Step Functions standard state machine
+* Create CloudWatch log group with /vendedlogs/ prefix in name
+* Deploy best practices CloudWatch Alarms for the Step Functions
+
+### AWS EventBridge Pipe
+
+* Pipe configured with an SQS queue source and state machine target
+* A least privilege IAM role assigned to the pipe to access the queue and state machine
+* CloudWatch logs set up at the 'INFO' level
+* Encrypted with an AWS managed KMS key
+
+## Architecture
+
+![Architecture Diagram](architecture.png)
+
+---
+
+
+© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+'''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
+import abc
+import builtins
+import datetime
+import enum
+import typing
+
+import jsii
+import publication
+import typing_extensions
+
+import typeguard
+from importlib.metadata import version as _metadata_package_version
+TYPEGUARD_MAJOR_VERSION = int(_metadata_package_version('typeguard').split('.')[0])
+
+def check_type(argname: str, value: object, expected_type: typing.Any) -> typing.Any:
+    if TYPEGUARD_MAJOR_VERSION <= 2:
+        return typeguard.check_type(argname=argname, value=value, expected_type=expected_type) # type:ignore
+    else:
+        if isinstance(value, jsii._reference_map.InterfaceDynamicProxy): # pyright: ignore [reportAttributeAccessIssue]
+           pass
+        else:
+            if TYPEGUARD_MAJOR_VERSION == 3:
+                typeguard.config.collection_check_strategy = typeguard.CollectionCheckStrategy.ALL_ITEMS # type:ignore
+                typeguard.check_type(value=value, expected_type=expected_type) # type:ignore
+            else:
+                typeguard.check_type(value=value, expected_type=expected_type, collection_check_strategy=typeguard.CollectionCheckStrategy.ALL_ITEMS) # type:ignore
+
+from ._jsii import *
+
+import aws_cdk.aws_cloudwatch as _aws_cdk_aws_cloudwatch_ceddda9d
+import aws_cdk.aws_iam as _aws_cdk_aws_iam_ceddda9d
+import aws_cdk.aws_kms as _aws_cdk_aws_kms_ceddda9d
+import aws_cdk.aws_lambda as _aws_cdk_aws_lambda_ceddda9d
+import aws_cdk.aws_logs as _aws_cdk_aws_logs_ceddda9d
+import aws_cdk.aws_pipes as _aws_cdk_aws_pipes_ceddda9d
+import aws_cdk.aws_sqs as _aws_cdk_aws_sqs_ceddda9d
+import aws_cdk.aws_stepfunctions as _aws_cdk_aws_stepfunctions_ceddda9d
+import aws_solutions_constructs.core as _aws_solutions_constructs_core_ac4f6ab9
+import constructs as _constructs_77d1e7e8
+
+
+@jsii.enum(
+    jsii_type="@aws-solutions-constructs/aws-sqs-pipes-stepfunctions.PipesLogLevel"
+)
+class PipesLogLevel(enum.Enum):
+    OFF = "OFF"
+    TRACE = "TRACE"
+    INFO = "INFO"
+    ERROR = "ERROR"
+
+
+class SqsToPipesToStepfunctions(
+    _constructs_77d1e7e8.Construct,
+    metaclass=jsii.JSIIMeta,
+    jsii_type="@aws-solutions-constructs/aws-sqs-pipes-stepfunctions.SqsToPipesToStepfunctions",
+):
+    def __init__(
+        self,
+        scope: _constructs_77d1e7e8.Construct,
+        id: builtins.str,
+        *,
+        state_machine_props: typing.Union[_aws_cdk_aws_stepfunctions_ceddda9d.StateMachineProps, typing.Dict[builtins.str, typing.Any]],
+        create_cloud_watch_alarms: typing.Optional[builtins.bool] = None,
+        dead_letter_queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        deploy_dead_letter_queue: typing.Optional[builtins.bool] = None,
+        encrypt_queue_with_cmk: typing.Optional[builtins.bool] = None,
+        enrichment_function: typing.Optional[_aws_cdk_aws_lambda_ceddda9d.Function] = None,
+        enrichment_state_machine: typing.Optional[_aws_cdk_aws_stepfunctions_ceddda9d.StateMachine] = None,
+        existing_queue_encryption_key: typing.Optional[_aws_cdk_aws_kms_ceddda9d.Key] = None,
+        existing_queue_obj: typing.Optional[_aws_cdk_aws_sqs_ceddda9d.Queue] = None,
+        log_group_props: typing.Optional[typing.Union[_aws_cdk_aws_logs_ceddda9d.LogGroupProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        log_level: typing.Optional[_aws_solutions_constructs_core_ac4f6ab9.PipesLogLevel] = None,
+        max_receive_count: typing.Optional[jsii.Number] = None,
+        pipe_log_props: typing.Optional[typing.Union[_aws_cdk_aws_logs_ceddda9d.LogGroupProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        pipe_props: typing.Any = None,
+        queue_encryption_key_props: typing.Optional[typing.Union[_aws_cdk_aws_kms_ceddda9d.KeyProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    ) -> None:
+        '''
+        :param scope: - represents the scope for all the resources.
+        :param id: - this is a a scope-unique id.
+        :param state_machine_props: User provided props for the sfn.StateMachine.
+        :param create_cloud_watch_alarms: Whether to create recommended CloudWatch alarms. default = true
+        :param dead_letter_queue_props: Optional user-provided props to override the default props for the dead letter SQS queue.
+        :param deploy_dead_letter_queue: Whether to create a secondary queue to be used as a dead letter queue. default = true.
+        :param encrypt_queue_with_cmk: Whether to encrypt the Queue with a customer managed KMS key (CMK). This is the default behavior, and this property defaults to true - if it is explicitly set to false then the Queue is encrypted with an Amazon managed KMS key. For a completely unencrypted Queue (not recommended), create the Queue separately from the construct and pass it in using the existingQueueObject. Since SNS subscriptions do not currently support SQS queues with AWS managed encryption keys, setting this to false will always result in an error from the underlying CDK - we have still included this property for consistency with topics and to be ready if the services one day support this functionality.
+        :param enrichment_function: Optional - Lambda function that the construct will configure to be called to enrich the message between source and target. The construct will configure the pipe IAM role to allow invoking the function (but will not affect the IArole assigned to the function). Specifying both this and enrichmentStateMachine is an error. Default - undefined
+        :param enrichment_state_machine: Optional - Step Functions state machine that the construct will configure to be called to enrich the message between source and target. The construct will configure the pipe IAM role to allow executing the state machine (but will not affect the IAM role assigned to the state machine). Specifying both this and enrichmentStateMachine is an error. Enrichment is invoked synchronously, so this must be an EXPRESS state machin. Default - undefined
+        :param existing_queue_encryption_key: An optional CMK that will be used by the construct to encrypt the new SQS queue.
+        :param existing_queue_obj: An optional, existing SQS queue to be used instead of the default queue. Providing both this and queueProps will cause an error.
+        :param log_group_props: Optional user provided props to override the default props for for the CloudWatchLogs LogGroup.
+        :param log_level: Threshold for what messages the new pipe sends to the log, PipesLogLevel.OFF, PipesLogLevel.ERROR, PipesLogLevel.INFO, PipesLogLevel.TRACE. The default is INFO. Setting the level to OFF will prevent any log group from being created. Providing pipeProps.logConfiguration will controls all aspects of logging and any construct provided log configuration is disabled. If pipeProps.logConfiguration is provided then specifying this or pipeLogProps is an error.
+        :param max_receive_count: The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to 15.
+        :param pipe_log_props: Default behavior is for the this construct to create a new CloudWatch Logs log group for the pipe. These props are used to override defaults set by AWS or this construct. If there are concerns about the cost of log storage, this is where a client can specify a shorter retention duration (in days)
+        :param pipe_props: Optional customer provided settings for the EventBridge pipe. source, target and roleArn are set by the construct and cannot be overriden. The construct will generate default sourceParameters, targetParameters and logConfiguration that can be overriden by populating those values in these props. If the client wants to implement enrichment or a filter, this is where that information can be provided. Any other props can be freely overridden.
+        :param queue_encryption_key_props: An optional subset of key properties to override the default properties used by constructs (enableKeyRotation: true). These properties will be used in constructing the CMK used to encrypt the SQS queue.
+        :param queue_props: Optional user provided properties to override the default properties for the SQS queue.
+
+        :access: public
+        :summary: Constructs a new instance of the SqsToPipesToStepfunctions class.
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__ceb1c3c4d051238d574ab5b99dbf3c5e745042f472b80f152d0f11b3d56c0c1b)
+            check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
+            check_type(argname="argument id", value=id, expected_type=type_hints["id"])
+        props = SqsToPipesToStepfunctionsProps(
+            state_machine_props=state_machine_props,
+            create_cloud_watch_alarms=create_cloud_watch_alarms,
+            dead_letter_queue_props=dead_letter_queue_props,
+            deploy_dead_letter_queue=deploy_dead_letter_queue,
+            encrypt_queue_with_cmk=encrypt_queue_with_cmk,
+            enrichment_function=enrichment_function,
+            enrichment_state_machine=enrichment_state_machine,
+            existing_queue_encryption_key=existing_queue_encryption_key,
+            existing_queue_obj=existing_queue_obj,
+            log_group_props=log_group_props,
+            log_level=log_level,
+            max_receive_count=max_receive_count,
+            pipe_log_props=pipe_log_props,
+            pipe_props=pipe_props,
+            queue_encryption_key_props=queue_encryption_key_props,
+            queue_props=queue_props,
+        )
+
+        jsii.create(self.__class__, self, [scope, id, props])
+
+    @builtins.property
+    @jsii.member(jsii_name="pipe")
+    def pipe(self) -> _aws_cdk_aws_pipes_ceddda9d.CfnPipe:
+        return typing.cast(_aws_cdk_aws_pipes_ceddda9d.CfnPipe, jsii.get(self, "pipe"))
+
+    @builtins.property
+    @jsii.member(jsii_name="pipeRole")
+    def pipe_role(self) -> _aws_cdk_aws_iam_ceddda9d.Role:
+        return typing.cast(_aws_cdk_aws_iam_ceddda9d.Role, jsii.get(self, "pipeRole"))
+
+    @builtins.property
+    @jsii.member(jsii_name="sqsQueue")
+    def sqs_queue(self) -> _aws_cdk_aws_sqs_ceddda9d.Queue:
+        return typing.cast(_aws_cdk_aws_sqs_ceddda9d.Queue, jsii.get(self, "sqsQueue"))
+
+    @builtins.property
+    @jsii.member(jsii_name="stateMachine")
+    def state_machine(self) -> _aws_cdk_aws_stepfunctions_ceddda9d.StateMachine:
+        return typing.cast(_aws_cdk_aws_stepfunctions_ceddda9d.StateMachine, jsii.get(self, "stateMachine"))
+
+    @builtins.property
+    @jsii.member(jsii_name="stateMachineLogGroup")
+    def state_machine_log_group(self) -> _aws_cdk_aws_logs_ceddda9d.ILogGroup:
+        return typing.cast(_aws_cdk_aws_logs_ceddda9d.ILogGroup, jsii.get(self, "stateMachineLogGroup"))
+
+    @builtins.property
+    @jsii.member(jsii_name="cloudwatchAlarms")
+    def cloudwatch_alarms(
+        self,
+    ) -> typing.Optional[typing.List[_aws_cdk_aws_cloudwatch_ceddda9d.Alarm]]:
+        return typing.cast(typing.Optional[typing.List[_aws_cdk_aws_cloudwatch_ceddda9d.Alarm]], jsii.get(self, "cloudwatchAlarms"))
+
+    @builtins.property
+    @jsii.member(jsii_name="deadLetterQueue")
+    def dead_letter_queue(
+        self,
+    ) -> typing.Optional[_aws_cdk_aws_sqs_ceddda9d.DeadLetterQueue]:
+        return typing.cast(typing.Optional[_aws_cdk_aws_sqs_ceddda9d.DeadLetterQueue], jsii.get(self, "deadLetterQueue"))
+
+    @builtins.property
+    @jsii.member(jsii_name="encryptionKey")
+    def encryption_key(self) -> typing.Optional[_aws_cdk_aws_kms_ceddda9d.IKey]:
+        return typing.cast(typing.Optional[_aws_cdk_aws_kms_ceddda9d.IKey], jsii.get(self, "encryptionKey"))
+
+
+@jsii.data_type(
+    jsii_type="@aws-solutions-constructs/aws-sqs-pipes-stepfunctions.SqsToPipesToStepfunctionsProps",
+    jsii_struct_bases=[],
+    name_mapping={
+        "state_machine_props": "stateMachineProps",
+        "create_cloud_watch_alarms": "createCloudWatchAlarms",
+        "dead_letter_queue_props": "deadLetterQueueProps",
+        "deploy_dead_letter_queue": "deployDeadLetterQueue",
+        "encrypt_queue_with_cmk": "encryptQueueWithCmk",
+        "enrichment_function": "enrichmentFunction",
+        "enrichment_state_machine": "enrichmentStateMachine",
+        "existing_queue_encryption_key": "existingQueueEncryptionKey",
+        "existing_queue_obj": "existingQueueObj",
+        "log_group_props": "logGroupProps",
+        "log_level": "logLevel",
+        "max_receive_count": "maxReceiveCount",
+        "pipe_log_props": "pipeLogProps",
+        "pipe_props": "pipeProps",
+        "queue_encryption_key_props": "queueEncryptionKeyProps",
+        "queue_props": "queueProps",
+    },
+)
+class SqsToPipesToStepfunctionsProps:
+    def __init__(
+        self,
+        *,
+        state_machine_props: typing.Union[_aws_cdk_aws_stepfunctions_ceddda9d.StateMachineProps, typing.Dict[builtins.str, typing.Any]],
+        create_cloud_watch_alarms: typing.Optional[builtins.bool] = None,
+        dead_letter_queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        deploy_dead_letter_queue: typing.Optional[builtins.bool] = None,
+        encrypt_queue_with_cmk: typing.Optional[builtins.bool] = None,
+        enrichment_function: typing.Optional[_aws_cdk_aws_lambda_ceddda9d.Function] = None,
+        enrichment_state_machine: typing.Optional[_aws_cdk_aws_stepfunctions_ceddda9d.StateMachine] = None,
+        existing_queue_encryption_key: typing.Optional[_aws_cdk_aws_kms_ceddda9d.Key] = None,
+        existing_queue_obj: typing.Optional[_aws_cdk_aws_sqs_ceddda9d.Queue] = None,
+        log_group_props: typing.Optional[typing.Union[_aws_cdk_aws_logs_ceddda9d.LogGroupProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        log_level: typing.Optional[_aws_solutions_constructs_core_ac4f6ab9.PipesLogLevel] = None,
+        max_receive_count: typing.Optional[jsii.Number] = None,
+        pipe_log_props: typing.Optional[typing.Union[_aws_cdk_aws_logs_ceddda9d.LogGroupProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        pipe_props: typing.Any = None,
+        queue_encryption_key_props: typing.Optional[typing.Union[_aws_cdk_aws_kms_ceddda9d.KeyProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    ) -> None:
+        '''
+        :param state_machine_props: User provided props for the sfn.StateMachine.
+        :param create_cloud_watch_alarms: Whether to create recommended CloudWatch alarms. default = true
+        :param dead_letter_queue_props: Optional user-provided props to override the default props for the dead letter SQS queue.
+        :param deploy_dead_letter_queue: Whether to create a secondary queue to be used as a dead letter queue. default = true.
+        :param encrypt_queue_with_cmk: Whether to encrypt the Queue with a customer managed KMS key (CMK). This is the default behavior, and this property defaults to true - if it is explicitly set to false then the Queue is encrypted with an Amazon managed KMS key. For a completely unencrypted Queue (not recommended), create the Queue separately from the construct and pass it in using the existingQueueObject. Since SNS subscriptions do not currently support SQS queues with AWS managed encryption keys, setting this to false will always result in an error from the underlying CDK - we have still included this property for consistency with topics and to be ready if the services one day support this functionality.
+        :param enrichment_function: Optional - Lambda function that the construct will configure to be called to enrich the message between source and target. The construct will configure the pipe IAM role to allow invoking the function (but will not affect the IArole assigned to the function). Specifying both this and enrichmentStateMachine is an error. Default - undefined
+        :param enrichment_state_machine: Optional - Step Functions state machine that the construct will configure to be called to enrich the message between source and target. The construct will configure the pipe IAM role to allow executing the state machine (but will not affect the IAM role assigned to the state machine). Specifying both this and enrichmentStateMachine is an error. Enrichment is invoked synchronously, so this must be an EXPRESS state machin. Default - undefined
+        :param existing_queue_encryption_key: An optional CMK that will be used by the construct to encrypt the new SQS queue.
+        :param existing_queue_obj: An optional, existing SQS queue to be used instead of the default queue. Providing both this and queueProps will cause an error.
+        :param log_group_props: Optional user provided props to override the default props for for the CloudWatchLogs LogGroup.
+        :param log_level: Threshold for what messages the new pipe sends to the log, PipesLogLevel.OFF, PipesLogLevel.ERROR, PipesLogLevel.INFO, PipesLogLevel.TRACE. The default is INFO. Setting the level to OFF will prevent any log group from being created. Providing pipeProps.logConfiguration will controls all aspects of logging and any construct provided log configuration is disabled. If pipeProps.logConfiguration is provided then specifying this or pipeLogProps is an error.
+        :param max_receive_count: The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to 15.
+        :param pipe_log_props: Default behavior is for the this construct to create a new CloudWatch Logs log group for the pipe. These props are used to override defaults set by AWS or this construct. If there are concerns about the cost of log storage, this is where a client can specify a shorter retention duration (in days)
+        :param pipe_props: Optional customer provided settings for the EventBridge pipe. source, target and roleArn are set by the construct and cannot be overriden. The construct will generate default sourceParameters, targetParameters and logConfiguration that can be overriden by populating those values in these props. If the client wants to implement enrichment or a filter, this is where that information can be provided. Any other props can be freely overridden.
+        :param queue_encryption_key_props: An optional subset of key properties to override the default properties used by constructs (enableKeyRotation: true). These properties will be used in constructing the CMK used to encrypt the SQS queue.
+        :param queue_props: Optional user provided properties to override the default properties for the SQS queue.
+
+        :summary: The properties for the SnsToSqs class.
+        '''
+        if isinstance(state_machine_props, dict):
+            state_machine_props = _aws_cdk_aws_stepfunctions_ceddda9d.StateMachineProps(**state_machine_props)
+        if isinstance(dead_letter_queue_props, dict):
+            dead_letter_queue_props = _aws_cdk_aws_sqs_ceddda9d.QueueProps(**dead_letter_queue_props)
+        if isinstance(log_group_props, dict):
+            log_group_props = _aws_cdk_aws_logs_ceddda9d.LogGroupProps(**log_group_props)
+        if isinstance(pipe_log_props, dict):
+            pipe_log_props = _aws_cdk_aws_logs_ceddda9d.LogGroupProps(**pipe_log_props)
+        if isinstance(queue_encryption_key_props, dict):
+            queue_encryption_key_props = _aws_cdk_aws_kms_ceddda9d.KeyProps(**queue_encryption_key_props)
+        if isinstance(queue_props, dict):
+            queue_props = _aws_cdk_aws_sqs_ceddda9d.QueueProps(**queue_props)
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__194e6c5b4126faff541334ee4c6e09b0eb05d31358b8eba12e563e86b30c14c1)
+            check_type(argname="argument state_machine_props", value=state_machine_props, expected_type=type_hints["state_machine_props"])
+            check_type(argname="argument create_cloud_watch_alarms", value=create_cloud_watch_alarms, expected_type=type_hints["create_cloud_watch_alarms"])
+            check_type(argname="argument dead_letter_queue_props", value=dead_letter_queue_props, expected_type=type_hints["dead_letter_queue_props"])
+            check_type(argname="argument deploy_dead_letter_queue", value=deploy_dead_letter_queue, expected_type=type_hints["deploy_dead_letter_queue"])
+            check_type(argname="argument encrypt_queue_with_cmk", value=encrypt_queue_with_cmk, expected_type=type_hints["encrypt_queue_with_cmk"])
+            check_type(argname="argument enrichment_function", value=enrichment_function, expected_type=type_hints["enrichment_function"])
+            check_type(argname="argument enrichment_state_machine", value=enrichment_state_machine, expected_type=type_hints["enrichment_state_machine"])
+            check_type(argname="argument existing_queue_encryption_key", value=existing_queue_encryption_key, expected_type=type_hints["existing_queue_encryption_key"])
+            check_type(argname="argument existing_queue_obj", value=existing_queue_obj, expected_type=type_hints["existing_queue_obj"])
+            check_type(argname="argument log_group_props", value=log_group_props, expected_type=type_hints["log_group_props"])
+            check_type(argname="argument log_level", value=log_level, expected_type=type_hints["log_level"])
+            check_type(argname="argument max_receive_count", value=max_receive_count, expected_type=type_hints["max_receive_count"])
+            check_type(argname="argument pipe_log_props", value=pipe_log_props, expected_type=type_hints["pipe_log_props"])
+            check_type(argname="argument pipe_props", value=pipe_props, expected_type=type_hints["pipe_props"])
+            check_type(argname="argument queue_encryption_key_props", value=queue_encryption_key_props, expected_type=type_hints["queue_encryption_key_props"])
+            check_type(argname="argument queue_props", value=queue_props, expected_type=type_hints["queue_props"])
+        self._values: typing.Dict[builtins.str, typing.Any] = {
+            "state_machine_props": state_machine_props,
+        }
+        if create_cloud_watch_alarms is not None:
+            self._values["create_cloud_watch_alarms"] = create_cloud_watch_alarms
+        if dead_letter_queue_props is not None:
+            self._values["dead_letter_queue_props"] = dead_letter_queue_props
+        if deploy_dead_letter_queue is not None:
+            self._values["deploy_dead_letter_queue"] = deploy_dead_letter_queue
+        if encrypt_queue_with_cmk is not None:
+            self._values["encrypt_queue_with_cmk"] = encrypt_queue_with_cmk
+        if enrichment_function is not None:
+            self._values["enrichment_function"] = enrichment_function
+        if enrichment_state_machine is not None:
+            self._values["enrichment_state_machine"] = enrichment_state_machine
+        if existing_queue_encryption_key is not None:
+            self._values["existing_queue_encryption_key"] = existing_queue_encryption_key
+        if existing_queue_obj is not None:
+            self._values["existing_queue_obj"] = existing_queue_obj
+        if log_group_props is not None:
+            self._values["log_group_props"] = log_group_props
+        if log_level is not None:
+            self._values["log_level"] = log_level
+        if max_receive_count is not None:
+            self._values["max_receive_count"] = max_receive_count
+        if pipe_log_props is not None:
+            self._values["pipe_log_props"] = pipe_log_props
+        if pipe_props is not None:
+            self._values["pipe_props"] = pipe_props
+        if queue_encryption_key_props is not None:
+            self._values["queue_encryption_key_props"] = queue_encryption_key_props
+        if queue_props is not None:
+            self._values["queue_props"] = queue_props
+
+    @builtins.property
+    def state_machine_props(
+        self,
+    ) -> _aws_cdk_aws_stepfunctions_ceddda9d.StateMachineProps:
+        '''User provided props for the sfn.StateMachine.'''
+        result = self._values.get("state_machine_props")
+        assert result is not None, "Required property 'state_machine_props' is missing"
+        return typing.cast(_aws_cdk_aws_stepfunctions_ceddda9d.StateMachineProps, result)
+
+    @builtins.property
+    def create_cloud_watch_alarms(self) -> typing.Optional[builtins.bool]:
+        '''Whether to create recommended CloudWatch alarms.
+
+        default = true
+        '''
+        result = self._values.get("create_cloud_watch_alarms")
+        return typing.cast(typing.Optional[builtins.bool], result)
+
+    @builtins.property
+    def dead_letter_queue_props(
+        self,
+    ) -> typing.Optional[_aws_cdk_aws_sqs_ceddda9d.QueueProps]:
+        '''Optional user-provided props to override the default props for the dead letter SQS queue.'''
+        result = self._values.get("dead_letter_queue_props")
+        return typing.cast(typing.Optional[_aws_cdk_aws_sqs_ceddda9d.QueueProps], result)
+
+    @builtins.property
+    def deploy_dead_letter_queue(self) -> typing.Optional[builtins.bool]:
+        '''Whether to create a secondary queue to be used as a dead letter queue.
+
+        default = true.
+        '''
+        result = self._values.get("deploy_dead_letter_queue")
+        return typing.cast(typing.Optional[builtins.bool], result)
+
+    @builtins.property
+    def encrypt_queue_with_cmk(self) -> typing.Optional[builtins.bool]:
+        '''Whether to encrypt the Queue with a customer managed KMS key (CMK).
+
+        This is the default
+        behavior, and this property defaults to true - if it is explicitly set to false then the Queue
+        is encrypted with an Amazon managed KMS key. For a completely unencrypted Queue (not recommended),
+        create the Queue separately from the construct and pass it in using the existingQueueObject. Since
+        SNS subscriptions do not currently support SQS queues with AWS managed encryption keys, setting this
+        to false will always result in an error from the underlying CDK - we have still included this property
+        for consistency with topics and to be ready if the services one day support this functionality.
+        '''
+        result = self._values.get("encrypt_queue_with_cmk")
+        return typing.cast(typing.Optional[builtins.bool], result)
+
+    @builtins.property
+    def enrichment_function(
+        self,
+    ) -> typing.Optional[_aws_cdk_aws_lambda_ceddda9d.Function]:
+        '''Optional - Lambda function that the construct will configure to be called to enrich the message between source and target.
+
+        The construct will configure the pipe IAM role to allow invoking the
+        function (but will not affect the IArole assigned to the function). Specifying both this and
+        enrichmentStateMachine is an error. Default - undefined
+        '''
+        result = self._values.get("enrichment_function")
+        return typing.cast(typing.Optional[_aws_cdk_aws_lambda_ceddda9d.Function], result)
+
+    @builtins.property
+    def enrichment_state_machine(
+        self,
+    ) -> typing.Optional[_aws_cdk_aws_stepfunctions_ceddda9d.StateMachine]:
+        '''Optional - Step Functions state machine that the construct will configure to be called to enrich the message between source and target.
+
+        The construct will configure the pipe IAM role to allow executing the state
+        machine (but will not affect the IAM role assigned to the state machine). Specifying both this and
+        enrichmentStateMachine is an error. Enrichment is invoked synchronously, so this must be an EXPRESS
+        state machin. Default - undefined
+        '''
+        result = self._values.get("enrichment_state_machine")
+        return typing.cast(typing.Optional[_aws_cdk_aws_stepfunctions_ceddda9d.StateMachine], result)
+
+    @builtins.property
+    def existing_queue_encryption_key(
+        self,
+    ) -> typing.Optional[_aws_cdk_aws_kms_ceddda9d.Key]:
+        '''An optional CMK that will be used by the construct to encrypt the new SQS queue.'''
+        result = self._values.get("existing_queue_encryption_key")
+        return typing.cast(typing.Optional[_aws_cdk_aws_kms_ceddda9d.Key], result)
+
+    @builtins.property
+    def existing_queue_obj(self) -> typing.Optional[_aws_cdk_aws_sqs_ceddda9d.Queue]:
+        '''An optional, existing SQS queue to be used instead of the default queue.
+
+        Providing both this and queueProps will cause an error.
+        '''
+        result = self._values.get("existing_queue_obj")
+        return typing.cast(typing.Optional[_aws_cdk_aws_sqs_ceddda9d.Queue], result)
+
+    @builtins.property
+    def log_group_props(
+        self,
+    ) -> typing.Optional[_aws_cdk_aws_logs_ceddda9d.LogGroupProps]:
+        '''Optional user provided props to override the default props for for the CloudWatchLogs LogGroup.'''
+        result = self._values.get("log_group_props")
+        return typing.cast(typing.Optional[_aws_cdk_aws_logs_ceddda9d.LogGroupProps], result)
+
+    @builtins.property
+    def log_level(
+        self,
+    ) -> typing.Optional[_aws_solutions_constructs_core_ac4f6ab9.PipesLogLevel]:
+        '''Threshold for what messages the new pipe sends to the log, PipesLogLevel.OFF, PipesLogLevel.ERROR, PipesLogLevel.INFO, PipesLogLevel.TRACE. The default is INFO. Setting the level to OFF will prevent any log group from being created. Providing pipeProps.logConfiguration will controls all aspects of logging and any construct provided log configuration is disabled. If pipeProps.logConfiguration is provided then specifying this or pipeLogProps is an error.'''
+        result = self._values.get("log_level")
+        return typing.cast(typing.Optional[_aws_solutions_constructs_core_ac4f6ab9.PipesLogLevel], result)
+
+    @builtins.property
+    def max_receive_count(self) -> typing.Optional[jsii.Number]:
+        '''The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue.
+
+        Defaults to 15.
+        '''
+        result = self._values.get("max_receive_count")
+        return typing.cast(typing.Optional[jsii.Number], result)
+
+    @builtins.property
+    def pipe_log_props(
+        self,
+    ) -> typing.Optional[_aws_cdk_aws_logs_ceddda9d.LogGroupProps]:
+        '''Default behavior is for the this construct to create a new CloudWatch Logs log group for the pipe.
+
+        These props are used to override defaults set by AWS or this construct. If there are concerns about
+        the cost of log storage, this is where a client can specify a shorter retention duration (in days)
+        '''
+        result = self._values.get("pipe_log_props")
+        return typing.cast(typing.Optional[_aws_cdk_aws_logs_ceddda9d.LogGroupProps], result)
+
+    @builtins.property
+    def pipe_props(self) -> typing.Any:
+        '''Optional customer provided settings for the EventBridge pipe.
+
+        source, target and
+        roleArn are set by the construct and cannot be overriden. The construct will generate
+        default sourceParameters, targetParameters and logConfiguration that can be
+        overriden by populating those values in these props. If the client wants to implement
+        enrichment or a filter, this is where that information can be provided. Any other props
+        can be freely overridden.
+        '''
+        result = self._values.get("pipe_props")
+        return typing.cast(typing.Any, result)
+
+    @builtins.property
+    def queue_encryption_key_props(
+        self,
+    ) -> typing.Optional[_aws_cdk_aws_kms_ceddda9d.KeyProps]:
+        '''An optional subset of key properties to override the default properties used by constructs (enableKeyRotation: true).
+
+        These properties will be used in constructing the CMK used to encrypt the SQS queue.
+        '''
+        result = self._values.get("queue_encryption_key_props")
+        return typing.cast(typing.Optional[_aws_cdk_aws_kms_ceddda9d.KeyProps], result)
+
+    @builtins.property
+    def queue_props(self) -> typing.Optional[_aws_cdk_aws_sqs_ceddda9d.QueueProps]:
+        '''Optional user provided properties to override the default properties for the SQS queue.'''
+        result = self._values.get("queue_props")
+        return typing.cast(typing.Optional[_aws_cdk_aws_sqs_ceddda9d.QueueProps], result)
+
+    def __eq__(self, rhs: typing.Any) -> builtins.bool:
+        return isinstance(rhs, self.__class__) and rhs._values == self._values
+
+    def __ne__(self, rhs: typing.Any) -> builtins.bool:
+        return not (rhs == self)
+
+    def __repr__(self) -> str:
+        return "SqsToPipesToStepfunctionsProps(%s)" % ", ".join(
+            k + "=" + repr(v) for k, v in self._values.items()
+        )
+
+
+__all__ = [
+    "PipesLogLevel",
+    "SqsToPipesToStepfunctions",
+    "SqsToPipesToStepfunctionsProps",
+]
+
+publication.publish()
+
+def _typecheckingstub__ceb1c3c4d051238d574ab5b99dbf3c5e745042f472b80f152d0f11b3d56c0c1b(
+    scope: _constructs_77d1e7e8.Construct,
+    id: builtins.str,
+    *,
+    state_machine_props: typing.Union[_aws_cdk_aws_stepfunctions_ceddda9d.StateMachineProps, typing.Dict[builtins.str, typing.Any]],
+    create_cloud_watch_alarms: typing.Optional[builtins.bool] = None,
+    dead_letter_queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    deploy_dead_letter_queue: typing.Optional[builtins.bool] = None,
+    encrypt_queue_with_cmk: typing.Optional[builtins.bool] = None,
+    enrichment_function: typing.Optional[_aws_cdk_aws_lambda_ceddda9d.Function] = None,
+    enrichment_state_machine: typing.Optional[_aws_cdk_aws_stepfunctions_ceddda9d.StateMachine] = None,
+    existing_queue_encryption_key: typing.Optional[_aws_cdk_aws_kms_ceddda9d.Key] = None,
+    existing_queue_obj: typing.Optional[_aws_cdk_aws_sqs_ceddda9d.Queue] = None,
+    log_group_props: typing.Optional[typing.Union[_aws_cdk_aws_logs_ceddda9d.LogGroupProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    log_level: typing.Optional[_aws_solutions_constructs_core_ac4f6ab9.PipesLogLevel] = None,
+    max_receive_count: typing.Optional[jsii.Number] = None,
+    pipe_log_props: typing.Optional[typing.Union[_aws_cdk_aws_logs_ceddda9d.LogGroupProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    pipe_props: typing.Any = None,
+    queue_encryption_key_props: typing.Optional[typing.Union[_aws_cdk_aws_kms_ceddda9d.KeyProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__194e6c5b4126faff541334ee4c6e09b0eb05d31358b8eba12e563e86b30c14c1(
+    *,
+    state_machine_props: typing.Union[_aws_cdk_aws_stepfunctions_ceddda9d.StateMachineProps, typing.Dict[builtins.str, typing.Any]],
+    create_cloud_watch_alarms: typing.Optional[builtins.bool] = None,
+    dead_letter_queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    deploy_dead_letter_queue: typing.Optional[builtins.bool] = None,
+    encrypt_queue_with_cmk: typing.Optional[builtins.bool] = None,
+    enrichment_function: typing.Optional[_aws_cdk_aws_lambda_ceddda9d.Function] = None,
+    enrichment_state_machine: typing.Optional[_aws_cdk_aws_stepfunctions_ceddda9d.StateMachine] = None,
+    existing_queue_encryption_key: typing.Optional[_aws_cdk_aws_kms_ceddda9d.Key] = None,
+    existing_queue_obj: typing.Optional[_aws_cdk_aws_sqs_ceddda9d.Queue] = None,
+    log_group_props: typing.Optional[typing.Union[_aws_cdk_aws_logs_ceddda9d.LogGroupProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    log_level: typing.Optional[_aws_solutions_constructs_core_ac4f6ab9.PipesLogLevel] = None,
+    max_receive_count: typing.Optional[jsii.Number] = None,
+    pipe_log_props: typing.Optional[typing.Union[_aws_cdk_aws_logs_ceddda9d.LogGroupProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    pipe_props: typing.Any = None,
+    queue_encryption_key_props: typing.Optional[typing.Union[_aws_cdk_aws_kms_ceddda9d.KeyProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+) -> None:
+    """Type checking stubs"""
+    pass

aws_solutions_constructs/aws_sqs_pipes_stepfunctions/_jsii/__init__.py

@@ -0,0 +1,48 @@
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
+import abc
+import builtins
+import datetime
+import enum
+import typing
+
+import jsii
+import publication
+import typing_extensions
+
+import typeguard
+from importlib.metadata import version as _metadata_package_version
+TYPEGUARD_MAJOR_VERSION = int(_metadata_package_version('typeguard').split('.')[0])
+
+def check_type(argname: str, value: object, expected_type: typing.Any) -> typing.Any:
+    if TYPEGUARD_MAJOR_VERSION <= 2:
+        return typeguard.check_type(argname=argname, value=value, expected_type=expected_type) # type:ignore
+    else:
+        if isinstance(value, jsii._reference_map.InterfaceDynamicProxy): # pyright: ignore [reportAttributeAccessIssue]
+           pass
+        else:
+            if TYPEGUARD_MAJOR_VERSION == 3:
+                typeguard.config.collection_check_strategy = typeguard.CollectionCheckStrategy.ALL_ITEMS # type:ignore
+                typeguard.check_type(value=value, expected_type=expected_type) # type:ignore
+            else:
+                typeguard.check_type(value=value, expected_type=expected_type, collection_check_strategy=typeguard.CollectionCheckStrategy.ALL_ITEMS) # type:ignore
+
+import aws_cdk._jsii
+import aws_cdk.integ_tests_alpha._jsii
+import aws_solutions_constructs.core._jsii
+import aws_solutions_constructs.resources._jsii
+import constructs._jsii
+
+__jsii_assembly__ = jsii.JSIIAssembly.load(
+    "@aws-solutions-constructs/aws-sqs-pipes-stepfunctions",
+    "2.73.0",
+    __name__[0:-6],
+    "aws-sqs-pipes-stepfunctions@2.73.0.jsii.tgz",
+)
+
+__all__ = [
+    "__jsii_assembly__",
+]
+
+publication.publish()

aws_solutions_constructs/aws_sqs_pipes_stepfunctions/py.typed

@@ -0,0 +1 @@
+

aws_solutions_constructs.aws_sqs_pipes_stepfunctions-2.73.0.dist-info/LICENSE

@@ -0,0 +1,73 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+     (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+     (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+     (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+     (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+     You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

aws_solutions_constructs.aws_sqs_pipes_stepfunctions-2.73.0.dist-info/METADATA

@@ -0,0 +1,139 @@
+Metadata-Version: 2.1
+Name: aws-solutions-constructs.aws-sqs-pipes-stepfunctions
+Version: 2.73.0
+Summary: CDK Constructs for Amazon SQS to AWS Step Functions via Amazon EventBridge Pipes integration.
+Home-page: https://github.com/awslabs/aws-solutions-constructs.git
+Author: Amazon Web Services
+License: Apache-2.0
+Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: JavaScript
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Typing :: Typed
+Classifier: License :: OSI Approved
+Requires-Python: ~=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aws-cdk-lib<3.0.0,>=2.161.0
+Requires-Dist: aws-cdk.integ-tests-alpha==2.161.0.a0
+Requires-Dist: aws-solutions-constructs.core==2.73.0
+Requires-Dist: aws-solutions-constructs.resources==2.73.0
+Requires-Dist: constructs<11.0.0,>=10.0.0
+Requires-Dist: jsii<2.0.0,>=1.104.0
+Requires-Dist: publication>=0.0.3
+Requires-Dist: typeguard<4.3.0,>=2.13.3
+
+# aws-sqs-pipes-stepfunctions module
+
+<!--BEGIN STABILITY BANNER-->---
+
+
+![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
+
+---
+<!--END STABILITY BANNER-->
+
+| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
+|:-------------|:-------------|
+
+<div style="height:8px"></div>
+
+| **Language**     | **Package**        |
+|:-------------|-----------------|
+|![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_sqs_pipes_stepfunctions`|
+|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-sqs-pipes-stepfunctions`|
+|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.sqspipesstepfunctions`|
+
+## Overview
+
+This AWS Solutions Construct implements an AWS SQS queue whose messages are passed to an AWS Step Functions state machine by an Amazon Eventbridge pipe.
+
+Here is a minimal deployable pattern definition:
+
+Typescript
+
+```python
+import { Construct } from 'constructs';
+import { Stack, StackProps } from 'aws-cdk-lib';
+import * as stepfunctions from 'aws-cdk-lib/aws-stepfunctions';
+import { SqsToPipesToStepfunctions, SqsToPipesToStepfunctionsProps } from "@aws-solutions-constructs/aws-sqs-pipes-stepfunctions";
+
+const startState = new stepfunctions.Pass(this, 'StartState');
+
+new SqsToPipesToStepfunctions(this, 'SqsToLambdaToStepfunctionsPattern', {
+  stateMachineProps: {
+    definition: startState
+  }
+});
+```
+
+## Pattern Construct Props
+
+| **Name**     | **Type**        | **Description** |
+|:-------------|:----------------|-----------------|
+|existingQueueObj?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|An optional, existing SQS queue to be used instead of the default queue. Providing both this and `queueProps` will cause an error.|
+|queueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional user provided properties to override the default properties for the SQS queue.|
+|encryptQueueWithCmk|`boolean`|Whether to encrypt the Queue with a customer managed KMS key (CMK). This is the default behavior, and this property defaults to true - if it is explicitly set to false then the Queue is encrypted with an Amazon managed KMS key. For a completely unencrypted Queue (not recommended), create the Queue separately from the construct and pass it in using the existingQueueObject. Since SNS subscriptions do not currently support SQS queues with AWS managed encryption keys, setting this to false will always result in an error from the underlying CDK - we have still included this property for consistency with topics and to be ready if the services one day support this functionality.|
+|queueEncryptionKeyProps?|[`kms.KeyProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html#construct-props)|An optional subset of key properties to override the default properties used by constructs (`enableKeyRotation: true`). These properties will be used in constructing the CMK used to encrypt the SQS queue.|
+|existingQueueEncryptionKey?|[`kms.Key`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.Key.html)|An optional CMK that will be used by the construct to encrypt the new SQS queue.|
+|deployDeadLetterQueue?|`boolean`|Whether to create a secondary queue to be used as a dead letter queue. Defaults to true.|
+|deadLetterQueueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional user-provided props to override the default props for the dead letter SQS queue.|
+|maxReceiveCount?|`number`|The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to 15.|
+|stateMachineProps|[`sfn.StateMachineProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachineProps.html)|User provided props for the sfn.StateMachine.|
+|createCloudWatchAlarms?|`boolean`|Whether to create recommended CloudWatch alarms|
+| logGroupProps? | [logs.logGroupProps ](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroupProps.html)| Optional user provided props to override the default props for for the CloudWatchLogs LogGroup for the state machine. |
+|pipeProps?|[ pipes.CfnPipeProps ](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_pipes.CfnPipeProps.html)|Optional customer provided settings for the EventBridge pipe. source, target, roleArn and enrichment settings are set by the construct and cannot be overriden here. The construct will generate default sourceParameters, targetParameters and logConfiguration (found [here](link)) that can be overriden by populating those values in these props. If the client wants to implement enrichment or a filter, this is where that information can be provided. Any other props can be freely overridden. If a client wants to set values such as batchSize, that can be done here in the sourceParameters property.|
+| enrichmentFunction? | [lambda.Function ](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html) | Optional - Lambda function that the construct will configure to be called to enrich the message between source and target. The construct will configure the pipe IAM role to allow invoking the function (but will not affect the IArole assigned to the function). Specifying both this and enrichmentStateMachine is an error. Default - undefined |
+| enrichmentStateMachine? | [sfn.StateMachine ](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachine.html) | Optional - Step Functions state machine that the construct will configure to be called to enrich the message between source and target. The construct will configure the pipe IAM role to allow executing the state machine (but will not affect the IAM role assigned to the state machine). Specifying both this and enrichmentStateMachine is an error. Default - undefined |
+|logLevel?|PipesLogLevel|Threshold for what messages the new pipe sends to the log, PipesLogLevel.OFF, PipesLogLevel.ERROR, PipesLogLevel.INFO, PipesLogLevel.TRACE. The default is INFO. Setting the level to OFF will prevent any log group from being created. Providing pipeProps.logConfiguration will controls all aspects of logging and any construct provided log configuration is disabled. If pipeProps.logConfiguration is provided then specifying this or pipeLogProps is an error. |
+|pipeLogProps?|[logs.LogGroupProps]()| Default behavior is for the this construct to create a new CloudWatch Logs log group for the pipe. These props are used to override defaults set by AWS or this construct. If there are concerns about the cost of log storage, this is where a client can specify a shorter retention duration (in days) |
+
+## Pattern Properties
+
+| **Name**     | **Type**        | **Description** |
+|:-------------|:----------------|-----------------|
+|stateMachine|[`sfn.StateMachine`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachine.html)|Returns an instance of StateMachine created by the construct.|
+|stateMachineLogGroup|[`logs.ILogGroup`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.ILogGroup.html)|Returns an instance of the ILogGroup created by the construct for StateMachine|
+|cloudwatchAlarms?|[`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Alarm.html)|Returns a list of alarms created by the construct.|
+|sqsQueue|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of the SQS queue created by the pattern. |
+|deadLetterQueue?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of the dead letter queue created by the pattern, if one is deployed.|
+|encryptionKey?|[kms.IKey](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html)|Returns an instance of kms.Key used for the SQS queue if key is customer managed.|
+|pipe|[ pipes.CfnPipe](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_pipes.CfnPipe.html)| The L1 pipe construct created by this Solutions Construct. |
+| pipeRole | [iam.Role ](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html) | The role created that allows the pipe to access both the source and the target. |
+
+## Default settings
+
+Out of the box implementation of the Construct without any override will set the following defaults:
+
+### Amazon SQS Queue
+
+* Deploy SQS dead-letter queue for the source SQS Queue.
+* Enable server-side encryption for source SQS Queue using AWS Managed KMS Key.
+* Enforce encryption of data in transit
+
+### AWS Step Functions State Machine
+
+* Deploy Step Functions standard state machine
+* Create CloudWatch log group with /vendedlogs/ prefix in name
+* Deploy best practices CloudWatch Alarms for the Step Functions
+
+### AWS EventBridge Pipe
+
+* Pipe configured with an SQS queue source and state machine target
+* A least privilege IAM role assigned to the pipe to access the queue and state machine
+* CloudWatch logs set up at the 'INFO' level
+* Encrypted with an AWS managed KMS key
+
+## Architecture
+
+![Architecture Diagram](architecture.png)
+
+---
+
+
+© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

aws_solutions_constructs.aws_sqs_pipes_stepfunctions-2.73.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+aws_solutions_constructs/aws_sqs_pipes_stepfunctions/__init__.py,sha256=g0dliUIVAr3087KNFTnhMWTsBLIj3cKuOxSVBw8NRvU,46065
+aws_solutions_constructs/aws_sqs_pipes_stepfunctions/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+aws_solutions_constructs/aws_sqs_pipes_stepfunctions/_jsii/__init__.py,sha256=n9ylvYt-nwDQuNQBxBAh82chDxeQSSlQaTL92MOBO94,1636
+aws_solutions_constructs/aws_sqs_pipes_stepfunctions/_jsii/aws-sqs-pipes-stepfunctions@2.73.0.jsii.tgz,sha256=TGhUPYK1TV-bf5Wxvwe1FCOrkBogn_7u5bMf9WE2C_s,128634
+aws_solutions_constructs.aws_sqs_pipes_stepfunctions-2.73.0.dist-info/LICENSE,sha256=wnT4A3LZDAEpNzcPDh8VCH0i4wjvmLJ86l3A0tCINmw,10279
+aws_solutions_constructs.aws_sqs_pipes_stepfunctions-2.73.0.dist-info/METADATA,sha256=fdNqP5djM3QmV6Hho0y4-gilJG2q7gvhETidElFcJ-Q,10848
+aws_solutions_constructs.aws_sqs_pipes_stepfunctions-2.73.0.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
+aws_solutions_constructs.aws_sqs_pipes_stepfunctions-2.73.0.dist-info/top_level.txt,sha256=hi3us_KW7V1ocfOqVsNq1o3w552jCEgu_KsCckqYWsg,25
+aws_solutions_constructs.aws_sqs_pipes_stepfunctions-2.73.0.dist-info/RECORD,,

aws_solutions_constructs.aws_sqs_pipes_stepfunctions-2.73.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.44.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

aws_solutions_constructs.aws_sqs_pipes_stepfunctions-2.73.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+aws_solutions_constructs