Package software.amazon.awsconstructs.services.sqspipesstepfunctions

Class SqsToPipesToStepfunctionsProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awsconstructs.services.sqspipesstepfunctions.SqsToPipesToStepfunctionsProps.Jsii$Proxy
All Implemented Interfaces:
SqsToPipesToStepfunctionsProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
SqsToPipesToStepfunctionsProps
@Internal public static final class SqsToPipesToStepfunctionsProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements SqsToPipesToStepfunctionsProps
An implementation for SqsToPipesToStepfunctionsProps

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awsconstructs.services.sqspipesstepfunctions.SqsToPipesToStepfunctionsProps

    SqsToPipesToStepfunctionsProps.Builder, SqsToPipesToStepfunctionsProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(SqsToPipesToStepfunctionsProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the SqsToPipesToStepfunctionsProps.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final Boolean
    getCreateCloudWatchAlarms()
    Whether to create recommended CloudWatch alarms.
    final software.amazon.awscdk.services.sqs.QueueProps
    getDeadLetterQueueProps()
    Optional user-provided props to override the default props for the dead letter SQS queue.
    final Boolean
    getDeployDeadLetterQueue()
    Whether to create a secondary queue to be used as a dead letter queue.
    final Boolean
    getEncryptQueueWithCmk()
    Whether to encrypt the Queue with a customer managed KMS key (CMK).
    final 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.
    final 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.
    final software.amazon.awscdk.services.kms.Key
    getExistingQueueEncryptionKey()
    An optional CMK that will be used by the construct to encrypt the new SQS queue.
    final software.amazon.awscdk.services.sqs.Queue
    getExistingQueueObj()
    An optional, existing SQS queue to be used instead of the default queue.
    final software.amazon.awscdk.services.stepfunctions.StateMachine
    getExistingStateMachineObj()
    Optional existing state machine to incorporate into the construct.
    final software.amazon.awscdk.services.logs.LogGroupProps
    getLogGroupProps()
    Optional user provided props to override the default props for for the CloudWatchLogs LogGroup.
    final 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.
    final Number
    getMaxReceiveCount()
    The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue.
    final 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.
    final Object
    getPipeProps()
    Optional customer provided settings for the EventBridge pipe.
    final software.amazon.awscdk.services.kms.KeyProps
    getQueueEncryptionKeyProps()
    An optional subset of key properties to override the default properties used by constructs (enableKeyRotation: true).
    final software.amazon.awscdk.services.sqs.QueueProps
    getQueueProps()
    Optional user provided properties to override the default properties for the SQS queue.
    final software.amazon.awscdk.services.stepfunctions.StateMachineProps
    getStateMachineProps()
    User provided props for the sfn.StateMachine.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(SqsToPipesToStepfunctionsProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the SqsToPipesToStepfunctionsProps.Builder.

  • Method Details

    • getCreateCloudWatchAlarms

      public final Boolean getCreateCloudWatchAlarms()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      Whether to create recommended CloudWatch alarms.

      default = true

      Specified by:
      getCreateCloudWatchAlarms in interface SqsToPipesToStepfunctionsProps

    • getDeadLetterQueueProps

      public final software.amazon.awscdk.services.sqs.QueueProps getDeadLetterQueueProps()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      Optional user-provided props to override the default props for the dead letter SQS queue.
      Specified by:
      getDeadLetterQueueProps in interface SqsToPipesToStepfunctionsProps

    • getDeployDeadLetterQueue

      public final Boolean getDeployDeadLetterQueue()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      Whether to create a secondary queue to be used as a dead letter queue.

      default = true.

      Specified by:
      getDeployDeadLetterQueue in interface SqsToPipesToStepfunctionsProps

    • getEncryptQueueWithCmk

      public final Boolean getEncryptQueueWithCmk()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      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.

      Specified by:
      getEncryptQueueWithCmk in interface SqsToPipesToStepfunctionsProps

    • getEnrichmentFunction

      public final software.amazon.awscdk.services.lambda.Function getEnrichmentFunction()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      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

      Specified by:
      getEnrichmentFunction in interface SqsToPipesToStepfunctionsProps

    • getEnrichmentStateMachine

      public final software.amazon.awscdk.services.stepfunctions.StateMachine getEnrichmentStateMachine()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      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

      Specified by:
      getEnrichmentStateMachine in interface SqsToPipesToStepfunctionsProps

    • getExistingQueueEncryptionKey

      public final software.amazon.awscdk.services.kms.Key getExistingQueueEncryptionKey()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      An optional CMK that will be used by the construct to encrypt the new SQS queue.
      Specified by:
      getExistingQueueEncryptionKey in interface SqsToPipesToStepfunctionsProps

    • getExistingQueueObj

      public final software.amazon.awscdk.services.sqs.Queue getExistingQueueObj()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      An optional, existing SQS queue to be used instead of the default queue.

      Providing both this and queueProps will cause an error.

      Specified by:
      getExistingQueueObj in interface SqsToPipesToStepfunctionsProps

    • getExistingStateMachineObj

      public final software.amazon.awscdk.services.stepfunctions.StateMachine getExistingStateMachineObj()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      Optional existing state machine to incorporate into the construct.
      Specified by:
      getExistingStateMachineObj in interface SqsToPipesToStepfunctionsProps

    • getLogGroupProps

      public final software.amazon.awscdk.services.logs.LogGroupProps getLogGroupProps()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      Optional user provided props to override the default props for for the CloudWatchLogs LogGroup.
      Specified by:
      getLogGroupProps in interface SqsToPipesToStepfunctionsProps

    • getLogLevel

      public final software.amazon.awsconstructs.services.core.PipesLogLevel getLogLevel()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      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.
      Specified by:
      getLogLevel in interface SqsToPipesToStepfunctionsProps

    • getMaxReceiveCount

      public final Number getMaxReceiveCount()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue.

      Defaults to 15.

      Specified by:
      getMaxReceiveCount in interface SqsToPipesToStepfunctionsProps

    • getPipeLogProps

      public final software.amazon.awscdk.services.logs.LogGroupProps getPipeLogProps()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      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)

      Specified by:
      getPipeLogProps in interface SqsToPipesToStepfunctionsProps

    • getPipeProps

      public final Object getPipeProps()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      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.

      Specified by:
      getPipeProps in interface SqsToPipesToStepfunctionsProps

    • getQueueEncryptionKeyProps

      public final software.amazon.awscdk.services.kms.KeyProps getQueueEncryptionKeyProps()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      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.

      Specified by:
      getQueueEncryptionKeyProps in interface SqsToPipesToStepfunctionsProps

    • getQueueProps

      public final software.amazon.awscdk.services.sqs.QueueProps getQueueProps()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      Optional user provided properties to override the default properties for the SQS queue.
      Specified by:
      getQueueProps in interface SqsToPipesToStepfunctionsProps

    • getStateMachineProps

      public final software.amazon.awscdk.services.stepfunctions.StateMachineProps getStateMachineProps()
      Description copied from interface: SqsToPipesToStepfunctionsProps
      User provided props for the sfn.StateMachine. This or existingStateMachine is required.
      Specified by:
      getStateMachineProps in interface SqsToPipesToStepfunctionsProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object