Package software.amazon.awsconstructs.services.sqspipesstepfunctions

Interface SqsToPipesToStepfunctionsProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
SqsToPipesToStepfunctionsProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.110.0 (build 336b265)", date="2025-03-21T12:26:52.893Z") public interface SqsToPipesToStepfunctionsProps extends software.amazon.jsii.JsiiSerializable

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    SqsToPipesToStepfunctionsProps.Builder
    A builder for SqsToPipesToStepfunctionsProps
    static final class 
    SqsToPipesToStepfunctionsProps.Jsii$Proxy
    An implementation for SqsToPipesToStepfunctionsProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static SqsToPipesToStepfunctionsProps.Builder
    builder()
     
    default Boolean
    getCreateCloudWatchAlarms()
    Whether to create recommended CloudWatch alarms.
    default software.amazon.awscdk.services.sqs.QueueProps
    getDeadLetterQueueProps()
    Optional user-provided props to override the default props for the dead letter SQS queue.
    default Boolean
    getDeployDeadLetterQueue()
    Whether to create a secondary queue to be used as a dead letter queue.
    default Boolean
    getEncryptQueueWithCmk()
    Whether to encrypt the Queue with a customer managed KMS key (CMK).
    default software.amazon.awscdk.services.lambda.Function
    getEnrichmentFunction()
    Optional - Lambda function that the construct will configure to be called to enrich the message between source and target.
    default software.amazon.awscdk.services.stepfunctions.StateMachine
    getEnrichmentStateMachine()
    Optional - Step Functions state machine that the construct will configure to be called to enrich the message between source and target.
    default software.amazon.awscdk.services.kms.Key
    getExistingQueueEncryptionKey()
    An optional CMK that will be used by the construct to encrypt the new SQS queue.
    default software.amazon.awscdk.services.sqs.Queue
    getExistingQueueObj()
    An optional, existing SQS queue to be used instead of the default queue.
    default software.amazon.awscdk.services.stepfunctions.StateMachine
    getExistingStateMachineObj()
    Optional existing state machine to incorporate into the construct.
    default software.amazon.awscdk.services.logs.LogGroupProps
    getLogGroupProps()
    Optional user provided props to override the default props for for the CloudWatchLogs LogGroup.
    default software.amazon.awsconstructs.services.core.PipesLogLevel
    getLogLevel()
    Threshold for what messages the new pipe sends to the log, PipesLogLevel.OFF, PipesLogLevel.ERROR, PipesLogLevel.INFO, PipesLogLevel.TRACE.
    default Number
    getMaxReceiveCount()
    The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue.
    default software.amazon.awscdk.services.logs.LogGroupProps
    getPipeLogProps()
    Default behavior is for the this construct to create a new CloudWatch Logs log group for the pipe.
    default Object
    getPipeProps()
    Optional customer provided settings for the EventBridge pipe.
    default software.amazon.awscdk.services.kms.KeyProps
    getQueueEncryptionKeyProps()
    An optional subset of key properties to override the default properties used by constructs (enableKeyRotation: true).
    default software.amazon.awscdk.services.sqs.QueueProps
    getQueueProps()
    Optional user provided properties to override the default properties for the SQS queue.
    default software.amazon.awscdk.services.stepfunctions.StateMachineProps
    getStateMachineProps()
    User provided props for the sfn.StateMachine.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getCreateCloudWatchAlarms

      @Nullable default Boolean getCreateCloudWatchAlarms()
      Whether to create recommended CloudWatch alarms.

      default = true

    • getDeadLetterQueueProps

      @Nullable default software.amazon.awscdk.services.sqs.QueueProps getDeadLetterQueueProps()
      Optional user-provided props to override the default props for the dead letter SQS queue.

    • getDeployDeadLetterQueue

      @Nullable default Boolean getDeployDeadLetterQueue()
      Whether to create a secondary queue to be used as a dead letter queue.

      default = true.

    • getEncryptQueueWithCmk

      @Nullable default Boolean getEncryptQueueWithCmk()
      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.

    • getEnrichmentFunction

      @Nullable default software.amazon.awscdk.services.lambda.Function getEnrichmentFunction()
      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

    • getEnrichmentStateMachine

      @Nullable default software.amazon.awscdk.services.stepfunctions.StateMachine getEnrichmentStateMachine()
      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

    • getExistingQueueEncryptionKey

      @Nullable default software.amazon.awscdk.services.kms.Key getExistingQueueEncryptionKey()
      An optional CMK that will be used by the construct to encrypt the new SQS queue.

    • getExistingQueueObj

      @Nullable default software.amazon.awscdk.services.sqs.Queue getExistingQueueObj()
      An optional, existing SQS queue to be used instead of the default queue.

      Providing both this and queueProps will cause an error.

    • getExistingStateMachineObj

      @Nullable default software.amazon.awscdk.services.stepfunctions.StateMachine getExistingStateMachineObj()
      Optional existing state machine to incorporate into the construct.

    • getLogGroupProps

      @Nullable default software.amazon.awscdk.services.logs.LogGroupProps getLogGroupProps()
      Optional user provided props to override the default props for for the CloudWatchLogs LogGroup.

    • getLogLevel

      @Nullable default software.amazon.awsconstructs.services.core.PipesLogLevel getLogLevel()
      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.

    • getMaxReceiveCount

      @Nullable default Number getMaxReceiveCount()
      The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue.

      Defaults to 15.

    • getPipeLogProps

      @Nullable default software.amazon.awscdk.services.logs.LogGroupProps getPipeLogProps()
      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)

    • getPipeProps

      @Nullable default Object getPipeProps()
      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.

    • getQueueEncryptionKeyProps

      @Nullable default software.amazon.awscdk.services.kms.KeyProps getQueueEncryptionKeyProps()
      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.

    • getQueueProps

      @Nullable default software.amazon.awscdk.services.sqs.QueueProps getQueueProps()
      Optional user provided properties to override the default properties for the SQS queue.

    • getStateMachineProps

      @Nullable default software.amazon.awscdk.services.stepfunctions.StateMachineProps getStateMachineProps()
      User provided props for the sfn.StateMachine. This or existingStateMachine is required.

    • builder

      static SqsToPipesToStepfunctionsProps.Builder builder()
      Returns:
      a SqsToPipesToStepfunctionsProps.Builder of SqsToPipesToStepfunctionsProps