SendToQueueProps

class aws_cdk.aws_stepfunctions_tasks.SendToQueueProps(*, delay=None, integration_pattern=None, message_body, message_deduplication_id=None, message_group_id=None)

Bases: object

(deprecated) Properties for SendMessageTask.

Parameters
  • delay (Optional[Duration]) – (deprecated) The length of time, in seconds, for which to delay a specific message. Valid values are 0-900 seconds. Default: Default value of the queue is used

  • integration_pattern (Optional[ServiceIntegrationPattern]) – (deprecated) The service integration pattern indicates different ways to call SendMessage to SQS. The valid value is either FIRE_AND_FORGET or WAIT_FOR_TASK_TOKEN. Default: FIRE_AND_FORGET

  • message_body (TaskInput) – (deprecated) The text message to send to the queue.

  • message_deduplication_id (Optional[str]) – (deprecated) The token used for deduplication of sent messages. Default: Use content-based deduplication

  • message_group_id (Optional[str]) – (deprecated) The tag that specifies that a message belongs to a specific message group. Required for FIFO queues. FIFO ordering applies to messages in the same message group. Default: No group ID

Deprecated

Use SqsSendMessage

Stability

deprecated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_stepfunctions as stepfunctions
import aws_cdk.aws_stepfunctions_tasks as stepfunctions_tasks
import aws_cdk.core as cdk

# task_input is of type TaskInput

send_to_queue_props = stepfunctions_tasks.SendToQueueProps(
    message_body=task_input,

    # the properties below are optional
    delay=cdk.Duration.minutes(30),
    integration_pattern=stepfunctions.ServiceIntegrationPattern.FIRE_AND_FORGET,
    message_deduplication_id="messageDeduplicationId",
    message_group_id="messageGroupId"
)

Attributes

delay

(deprecated) The length of time, in seconds, for which to delay a specific message.

Valid values are 0-900 seconds.

Default

Default value of the queue is used

Stability

deprecated

Return type

Optional[Duration]

integration_pattern

(deprecated) The service integration pattern indicates different ways to call SendMessage to SQS.

The valid value is either FIRE_AND_FORGET or WAIT_FOR_TASK_TOKEN.

Default

FIRE_AND_FORGET

Stability

deprecated

Return type

Optional[ServiceIntegrationPattern]

message_body

(deprecated) The text message to send to the queue.

Stability

deprecated

Return type

TaskInput

message_deduplication_id

(deprecated) The token used for deduplication of sent messages.

Default

Use content-based deduplication

Stability

deprecated

Return type

Optional[str]

message_group_id

(deprecated) The tag that specifies that a message belongs to a specific message group.

Required for FIFO queues. FIFO ordering applies to messages in the same message group.

Default

No group ID

Stability

deprecated

Return type

Optional[str]