SendToQueue

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

Bases: object

(deprecated) A StepFunctions Task to send messages to SQS queue.

A Function can be used directly as a Resource, but this class mirrors integration with other AWS services via a specific class instance.

Deprecated

Use SqsSendMessage

Stability

deprecated

ExampleMetadata

fixture=_generated

Example:

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

# queue: sqs.Queue
# task_input: stepfunctions.TaskInput

send_to_queue = stepfunctions_tasks.SendToQueue(queue,
    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"
)
Parameters
  • queue (IQueue) –

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

  • 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_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

Stability

deprecated

Methods

bind(_task)

(deprecated) Called when the task object is used in a workflow.

Parameters

_task (Task) –

Stability

deprecated

Return type

StepFunctionsTaskConfig