1.204.0

interface SnsPublishProps

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.Tasks.SnsPublishProps
Javasoftware.amazon.awscdk.services.stepfunctions.tasks.SnsPublishProps
Pythonaws_cdk.aws_stepfunctions_tasks.SnsPublishProps
TypeScript (source)@aws-cdk/aws-stepfunctions-tasks » SnsPublishProps

Properties for publishing a message to an SNS topic.

Example

const convertToSeconds = new tasks.EvaluateExpression(this, 'Convert to seconds', {
  expression: '$.waitMilliseconds / 1000',
  resultPath: '$.waitSeconds',
});

const createMessage = new tasks.EvaluateExpression(this, 'Create message', {
  // Note: this is a string inside a string.
  expression: '`Now waiting ${$.waitSeconds} seconds...`',
  runtime: lambda.Runtime.NODEJS_14_X,
  resultPath: '$.message',
});

const publishMessage = new tasks.SnsPublish(this, 'Publish message', {
  topic: new sns.Topic(this, 'cool-topic'),
  message: sfn.TaskInput.fromJsonPathAt('$.message'),
  resultPath: '$.sns',
});

const wait = new sfn.Wait(this, 'Wait', {
  time: sfn.WaitTime.secondsPath('$.waitSeconds'),
});

new sfn.StateMachine(this, 'StateMachine', {
  definition: convertToSeconds
    .next(createMessage)
    .next(publishMessage)
    .next(wait),
});

Properties

NameTypeDescription
messageTaskInputThe message you want to send.
topicITopicThe SNS topic that the task will publish to.
comment?stringAn optional description for this state.
heartbeat?DurationTimeout for the heartbeat.
inputPath?stringJSONPath expression to select part of the state to be the input to this state.
integrationPattern?IntegrationPatternAWS Step Functions integrates with services directly in the Amazon States Language.
messageAttributes?{ [string]: MessageAttribute }Add message attributes when publishing.
messagePerSubscriptionType?booleanSend different messages for each transport protocol.
outputPath?stringJSONPath expression to select select a portion of the state output to pass to the next state.
resultPath?stringJSONPath expression to indicate where to inject the state's output.
resultSelector?{ [string]: any }The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
subject?stringUsed as the "Subject" line when the message is delivered to email endpoints.
timeout?DurationTimeout for the state machine.

message

Type: 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

Type: ITopic

The SNS topic that the task will publish to.

comment?

Type: string (optional, default: No comment)

An optional description for this state.

heartbeat?

Type: Duration (optional, default: None)

Timeout for the heartbeat.

inputPath?

Type: string (optional, default: The entire task input (JSON 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 {}.

integrationPattern?

Type: IntegrationPattern (optional, default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.)

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

You can control these AWS services using service integration patterns

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token

messageAttributes?

Type: { [string]: MessageAttribute } (optional, default: {})

Add message attributes when publishing.

These attributes carry additional metadata about the message and may be used for subscription filters.

See also: https://docs.aws.amazon.com/sns/latest/dg/sns-message-attributes.html

messagePerSubscriptionType?

Type: boolean (optional, default: false)

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)

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

outputPath?

Type: string (optional, default: The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON 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 {}.

resultPath?

Type: string (optional, default: Replaces the entire input with the result (JSON 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.

resultSelector?

Type: { [string]: any } (optional, default: None)

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

subject?

Type: string (optional, default: No 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.

timeout?

Type: Duration (optional, default: None)

Timeout for the state machine.

← PreviousNext →