PublishToTopicProps

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

Bases: object

(deprecated) Properties for PublishTask.

Parameters
  • 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 (TaskInput) – (deprecated) The text message to send to the topic.

  • 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

Deprecated

Use SnsPublish

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

# task_input is of type TaskInput

publish_to_topic_props = stepfunctions_tasks.PublishToTopicProps(
    message=task_input,

    # the properties below are optional
    integration_pattern=stepfunctions.ServiceIntegrationPattern.FIRE_AND_FORGET,
    message_per_subscription_type=False,
    subject="subject"
)

Attributes

integration_pattern

(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

Stability

deprecated

Return type

Optional[ServiceIntegrationPattern]

message

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

Stability

deprecated

Return type

TaskInput

message_per_subscription_type

(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

See

https://docs.aws.amazon.com/sns/latest/api/API_Publish.html#API_Publish_RequestParameters

Stability

deprecated

Return type

Optional[bool]

subject

(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

Return type

Optional[str]