SnsPublishProps¶

class aws_cdk.aws_stepfunctions_tasks.SnsPublishProps(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, timeout=None, message, topic, message_per_subscription_type=None, subject=None)¶

Bases: aws_cdk.aws_stepfunctions.TaskStateBaseProps

Properties for publishing a message to an SNS topic.

Parameters

comment (Optional[str]) – An optional description for this state. Default: - No comment
heartbeat (Optional[Duration]) – Timeout for the heartbeat. Default: - None
input_path (Optional[str]) – JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}. Default: - The entire task input (JSON path ‘$’)
integration_pattern (Optional[IntegrationPattern]) – AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns Default: IntegrationPattern.REQUEST_RESPONSE
output_path (Optional[str]) – JSONPath expression to select select a portion of the state output to pass to the next state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}. Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path ‘$’)
result_path (Optional[str]) – JSONPath expression to indicate where to inject the state’s output. May also be the special value JsonPath.DISCARD, which will cause the state’s input to become its output. Default: - Replaces the entire input with the result (JSON path ‘$’)
timeout (Optional[Duration]) – Timeout for the state machine. Default: - None
message (TaskInput) – The message you want to send. With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size. For SMS, each message can contain up to 140 characters.
topic (ITopic) – The SNS topic that the task will publish to.
message_per_subscription_type (Optional[bool]) – Send different messages for each transport protocol. For example, you might want to send a shorter message to SMS subscribers and a more verbose message to email and SQS subscribers. Your message must be a JSON object with a top-level JSON key of “default” with a value that is a string You can define other top-level keys that define the message you want to send to a specific transport protocol (i.e. “sqs”, “email”, “http”, etc) Default: false
subject (Optional[str]) – Used as the “Subject” line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Default: - No subject

Attributes

comment¶

An optional description for this state.

Default

No comment

Return type

Optional[str]

heartbeat¶

Timeout for the heartbeat.

Default

None

Return type

Optional[Duration]

input_path¶

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Default

The entire task input (JSON path ‘$’)

Return type

Optional[str]

integration_pattern¶

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns

Default: IntegrationPattern.REQUEST_RESPONSE
See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
Return type: Optional[IntegrationPattern]

message¶

The message you want to send.

With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size. For SMS, each message can contain up to 140 characters.

Return type: TaskInput

message_per_subscription_type¶

Send different messages for each transport protocol.

For example, you might want to send a shorter message to SMS subscribers and a more verbose message to email and SQS subscribers.

Your message must be a JSON object with a top-level JSON key of “default” with a value that is a string You can define other top-level keys that define the message you want to send to a specific transport protocol (i.e. “sqs”, “email”, “http”, etc)

Default: false
See: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html#API_Publish_RequestParameters
Return type: Optional[bool]

output_path¶

JSONPath expression to select select a portion of the state output to pass to the next state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Default

The entire JSON node determined by the state input, the task result,

and resultPath is passed to the next state (JSON path ‘$’)

Return type: Optional[str]

result_path¶

JSONPath expression to indicate where to inject the state’s output.

May also be the special value JsonPath.DISCARD, which will cause the state’s input to become its output.

Default

Replaces the entire input with the result (JSON path ‘$’)

Return type

Optional[str]

subject¶

Used as the “Subject” line when the message is delivered to email endpoints.

This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

Default

No subject

Return type

Optional[str]

timeout¶

Timeout for the state machine.

Default

None

Return type

Optional[Duration]

topic¶

The SNS topic that the task will publish to.

Return type: ITopic