PublishToTopicProps

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

Bases: object

__init__(*, message, integration_pattern=None, message_per_subscription_type=None, subject=None)

Properties for PublishTask.

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

  • integration_pattern (Optional[ServiceIntegrationPattern]) – 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]) – 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]) – 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 :deprecated: Use SnsPublish

stability :stability: deprecated

Return type

None

Attributes

integration_pattern

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 :default: FIRE_AND_FORGET

stability :stability: deprecated

Return type

Optional[ServiceIntegrationPattern]

message

The text message to send to the topic.

stability :stability: deprecated

Return type

TaskInput

message_per_subscription_type

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 :default: false

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

Return type

Optional[bool]

subject

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 :default: - No subject

stability :stability: deprecated

Return type

Optional[str]