Show / Hide Table of Contents

Class SnsPublish

A Step Functions Task to publish messages to SNS topic.

Inheritance
System.Object
Construct
State
TaskStateBase
SnsPublish
Implements
IConstruct
Constructs.IConstruct
IDependable
IChainable
INextable
Inherited Members
TaskStateBase.AddCatch(IChainable, ICatchProps)
TaskStateBase.AddRetry(IRetryProps)
TaskStateBase.Metric(String, IMetricOptions)
TaskStateBase.MetricFailed(IMetricOptions)
TaskStateBase.MetricHeartbeatTimedOut(IMetricOptions)
TaskStateBase.MetricRunTime(IMetricOptions)
TaskStateBase.MetricScheduled(IMetricOptions)
TaskStateBase.MetricScheduleTime(IMetricOptions)
TaskStateBase.MetricStarted(IMetricOptions)
TaskStateBase.MetricSucceeded(IMetricOptions)
TaskStateBase.MetricTime(IMetricOptions)
TaskStateBase.MetricTimedOut(IMetricOptions)
TaskStateBase.Next(IChainable)
TaskStateBase.ToStateJson()
TaskStateBase.WhenBoundToGraph(StateGraph)
TaskStateBase.EndStates
State.FilterNextables(State[])
State.FindReachableEndStates(State, IFindStateOptions)
State.FindReachableStates(State, IFindStateOptions)
State.PrefixStates(IConstruct, String)
State.AddBranch(StateGraph)
State.AddChoice(Condition, State)
State.AddIterator(StateGraph)
State.AddPrefix(String)
State.BindToGraph(StateGraph)
State.MakeDefault(State)
State.MakeNext(State)
State.RenderBranches()
State.RenderChoices()
State.RenderInputOutput()
State.RenderIterator()
State.RenderNextEnd()
State.RenderResultSelector()
State.RenderRetryCatch()
State.Branches
State.Id
State.StartState
State.StateId
State.Comment
State.InputPath
State.OutputPath
State.Parameters
State.ResultPath
State.ResultSelector
State.DefaultChoice
State.Iteration
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll
Syntax (csharp)
public class SnsPublish : TaskStateBase, IConstruct, IDependable, IChainable, INextable
Syntax (vb)
Public Class SnsPublish
    Inherits TaskStateBase
    Implements IConstruct, IDependable, IChainable, INextable
Remarks

ExampleMetadata: infused

Examples
var convertToSeconds = new EvaluateExpression(this, "Convert to seconds", new EvaluateExpressionProps {
    Expression = "$.waitMilliseconds / 1000",
    ResultPath = "$.waitSeconds"
});

var createMessage = new EvaluateExpression(this, "Create message", new EvaluateExpressionProps {
    // Note: this is a string inside a string.
    Expression = "`Now waiting ${$.waitSeconds} seconds...`",
    Runtime = Runtime.NODEJS_14_X,
    ResultPath = "$.message"
});

var publishMessage = new SnsPublish(this, "Publish message", new SnsPublishProps {
    Topic = new Topic(this, "cool-topic"),
    Message = TaskInput.FromJsonPathAt("$.message"),
    ResultPath = "$.sns"
});

var wait = new Wait(this, "Wait", new WaitProps {
    Time = WaitTime.SecondsPath("$.waitSeconds")
});

new StateMachine(this, "StateMachine", new StateMachineProps {
    Definition = convertToSeconds.Next(createMessage).Next(publishMessage).Next(wait)
});

Synopsis

Constructors

SnsPublish(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

SnsPublish(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

SnsPublish(Construct, String, ISnsPublishProps)

Properties

TaskMetrics
TaskPolicies

Constructors

SnsPublish(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected SnsPublish(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

SnsPublish(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected SnsPublish(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

SnsPublish(Construct, String, ISnsPublishProps)

public SnsPublish(Construct scope, string id, ISnsPublishProps props)
Parameters
scope Constructs.Construct
id System.String
props ISnsPublishProps

Properties

TaskMetrics

protected override ITaskMetricsConfig TaskMetrics { get; }
Property Value

ITaskMetricsConfig

Overrides
TaskStateBase.TaskMetrics

TaskPolicies

protected override PolicyStatement[] TaskPolicies { get; }
Property Value

PolicyStatement[]

Overrides
TaskStateBase.TaskPolicies

Implements

IConstruct
Constructs.IConstruct
IDependable
IChainable
INextable
Back to top Generated by DocFX