Class PassProps

Properties for defining a Pass state.

Inheritance

System.Object

PassProps

Implements

IPassProps

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.AWS.StepFunctions.dll

Syntax (csharp)

public class PassProps : Object, IPassProps

Syntax (vb)

Public Class PassProps
    Inherits Object
    Implements IPassProps

Remarks

ExampleMetadata: infused

Examples

// Makes the current JSON state { ..., "subObject": { "hello": "world" } }
var pass = new Pass(this, "Add Hello World", new PassProps {
    Result = Result.FromObject(new Dictionary<string, object> { { "hello", "world" } }),
    ResultPath = "$.subObject"
});

// Set the next state
var nextState = new Pass(this, "NextState");
pass.Next(nextState);

Synopsis

Constructors

PassProps()

Properties

Comment	An optional description for this state.
InputPath	JSONPath expression to select part of the state to be the input to this state.
OutputPath	JSONPath expression to select part of the state to be the output to this state.
Parameters	Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
Result	If given, treat as the result of this operation.
ResultPath	JSONPath expression to indicate where to inject the state's output.

Constructors

PassProps()

public PassProps()

Properties

Comment

An optional description for this state.

public string Comment { get; set; }

Property Value

System.String

Remarks

Default: No comment

InputPath

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

public string InputPath { get; set; }

Property Value

System.String

Remarks

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

Default: $

OutputPath

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

public string OutputPath { get; set; }

Property Value

System.String

Remarks

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

Default: $

Parameters

Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

public IDictionary<string, object> Parameters { get; set; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Remarks

Default: No parameters

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

Result

If given, treat as the result of this operation.

public Result Result { get; set; }

Property Value

Result

Remarks

Can be used to inject or replace the current execution state.

Default: No injected result

ResultPath

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

public string ResultPath { get; set; }

Property Value

System.String

Remarks

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

Default: $

Implements

IPassProps