PublishToTopic

class aws_cdk.aws_stepfunctions_tasks.PublishToTopic(topic, *, message, integration_pattern=None, message_per_subscription_type=None, subject=None)

Bases: object

(deprecated) A Step Functions Task to publish messages to SNS topic.

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 SnsPublish

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_sns as sns
import aws_cdk.aws_stepfunctions as stepfunctions
import aws_cdk.aws_stepfunctions_tasks as stepfunctions_tasks

# task_input: stepfunctions.TaskInput
# topic: sns.Topic

publish_to_topic = stepfunctions_tasks.PublishToTopic(topic,
    message=task_input,

    # the properties below are optional
    integration_pattern=stepfunctions.ServiceIntegrationPattern.FIRE_AND_FORGET,
    message_per_subscription_type=False,
    subject="subject"
)
Parameters
  • topic (ITopic) –

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

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

  • message_per_subscription_type (Optional[bool]) – (deprecated) If true, send a different message to every subscription type. If this is set to true, message must be a JSON object with a “default” key and a key for every subscription type (such as “sqs”, “email”, etc.) The values are strings representing the messages being sent to every subscription type. Default: false

  • subject (Optional[str]) – (deprecated) Used as the “Subject” line when the message is delivered to email endpoints. Also included, if present, in the standard JSON messages delivered to other endpoints. Default: - No subject

Stability

deprecated

Methods

bind(_task)

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

Parameters

_task (Task) –

Stability

deprecated

Return type

StepFunctionsTaskConfig