AWS solutions documentation change
Summary
Updated logo URLs and clarified documentation for queueProps, pipeProps, enrichmentFunction, enrichmentStateMachine, logLevel, and pipeLogProps properties. Added error condition notes and fixed documentation links.
Security assessment
Changes are documentation clarifications and error prevention instructions. No security vulnerabilities, exploits, or security features are mentioned. Updates focus on usage guidance without security implications.
Diff
diff --git a/solutions/latest/constructs/aws_sqs_pipes_stepfunctions.md b/solutions/latest/constructs/aws_sqs_pipes_stepfunctions.md index 7a7a60f6f..66d732ab2 100644 --- a//solutions/latest/constructs/aws_sqs_pipes_stepfunctions.md +++ b//solutions/latest/constructs/aws_sqs_pipes_stepfunctions.md @@ -16,3 +16,3 @@ OverviewPattern Construct PropsPattern PropertiesDefault settingsArchitectureGit - Python | `aws_solutions_constructs.aws_sqs_pipes_stepfunctions` - Typescript | `@aws-solutions-constructs/aws-sqs-pipes-stepfunctions` - Java | `software.amazon.awsconstructs.services.sqspipesstepfunctions` + Python | `aws_solutions_constructs.aws_sqs_pipes_stepfunctions` + Typescript | `@aws-solutions-constructs/aws-sqs-pipes-stepfunctions` + Java | `software.amazon.awsconstructs.services.sqspipesstepfunctions` @@ -89 +89 @@ existingQueueObj? | [`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/a -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. +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. Providing both this and `existingQueueObj` will cause an error. @@ -99,5 +99,5 @@ logGroupProps? | [logs.logGroupProps](https://docs.aws.amazon.com/cdk/api/v2/do -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](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-pipes-pipe.html#cfn-pipes-pipe-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. 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`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroupProps.html) | 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) +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](./.html#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 causes 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 causes 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 causes an error. +pipeLogProps? | [logs.LogGroupProps](./.html#) | 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)