Class StepFunctionsStartExecutionProps
Properties for StartExecution.
Inheritance
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class StepFunctionsStartExecutionProps : Object, IStepFunctionsStartExecutionProps, ITaskStateBaseProps
Syntax (vb)
Public Class StepFunctionsStartExecutionProps
Inherits Object
Implements IStepFunctionsStartExecutionProps, ITaskStateBaseProps
Remarks
ExampleMetadata: infused
Examples
// Define a state machine with one Pass state
var child = new StateMachine(this, "ChildStateMachine", new StateMachineProps {
Definition = Chain.Start(new Pass(this, "PassState"))
});
// Include the state machine in a Task state with callback pattern
var task = new StepFunctionsStartExecution(this, "ChildTask", new StepFunctionsStartExecutionProps {
StateMachine = child,
IntegrationPattern = IntegrationPattern.WAIT_FOR_TASK_TOKEN,
Input = TaskInput.FromObject(new Dictionary<string, object> {
{ "token", JsonPath.TaskToken },
{ "foo", "bar" }
}),
Name = "MyExecutionName"
});
// Define a second state machine with the Task state above
// Define a second state machine with the Task state above
new StateMachine(this, "ParentStateMachine", new StateMachineProps {
Definition = task
});
Synopsis
Constructors
StepFunctionsStartExecutionProps() |
Properties
AssociateWithParent | Pass the execution ID from the context object to the execution input. |
Comment | An optional description for this state. |
Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
Heartbeat | (deprecated) Timeout for the heartbeat. |
HeartbeatTimeout | Timeout for the heartbeat. |
Input | The JSON input for the execution, same as that of StartExecution. |
InputPath | JSONPath expression to select part of the state to be the input to this state. |
IntegrationPattern | AWS Step Functions integrates with services directly in the Amazon States Language. |
Name | The name of the execution, same as that of StartExecution. |
OutputPath | JSONPath expression to select select a portion of the state output to pass to the next state. |
ResultPath | JSONPath expression to indicate where to inject the state's output. |
ResultSelector | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
StateMachine | The Step Functions state machine to start the execution on. |
StateName | Optional name for this state. |
TaskTimeout | Timeout for the task. |
Timeout | (deprecated) Timeout for the task. |
Constructors
StepFunctionsStartExecutionProps()
public StepFunctionsStartExecutionProps()
Properties
AssociateWithParent
Pass the execution ID from the context object to the execution input.
public Nullable<bool> AssociateWithParent { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
This allows the Step Functions UI to link child executions from parent executions, making it easier to trace execution flow across state machines.
If you set this property to true
, the input
property must be an object (provided by sfn.TaskInput.fromObject
) or omitted entirely.
Default: - false
Comment
An optional description for this state.
public string Comment { get; set; }
Property Value
System.String
Remarks
Default: - No comment
Credentials
Credentials for an IAM Role that the State Machine assumes for executing the task.
public ICredentials Credentials { get; set; }
Property Value
Remarks
This enables cross-account resource invocations.
Default: - None (Task is executed using the State Machine's execution role)
See: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html
Heartbeat
(deprecated) Timeout for the heartbeat.
public Duration Heartbeat { get; set; }
Property Value
Remarks
Default: - None
Stability: Deprecated
HeartbeatTimeout
Timeout for the heartbeat.
public Timeout HeartbeatTimeout { get; set; }
Property Value
Remarks
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
Input
The JSON input for the execution, same as that of StartExecution.
public TaskInput Input { get; set; }
Property Value
Remarks
Default: - The state input (JSON path '$')
See: https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html
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: - The entire task input (JSON path '$')
IntegrationPattern
AWS Step Functions integrates with services directly in the Amazon States Language.
public Nullable<IntegrationPattern> IntegrationPattern { get; set; }
Property Value
System.Nullable<IntegrationPattern>
Remarks
You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
Default: - IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:
BatchSubmitJob
, EmrAddStep
, EmrCreateCluster
, EmrTerminationCluster
, and EmrContainersStartJobRun
.
See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html
Name
The name of the execution, same as that of StartExecution.
public string Name { get; set; }
Property Value
System.String
Remarks
OutputPath
JSONPath expression to select select a portion of the state output to pass to the next 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: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
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: - Replaces the entire input with the result (JSON path '$')
ResultSelector
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
public IDictionary<string, object> ResultSelector { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
StateMachine
The Step Functions state machine to start the execution on.
public IStateMachine StateMachine { get; set; }
Property Value
StateName
Optional name for this state.
public string StateName { get; set; }
Property Value
System.String
Remarks
Default: - The construct ID will be used as state name
TaskTimeout
Timeout for the task.
public Timeout TaskTimeout { get; set; }
Property Value
Remarks
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
Timeout
(deprecated) Timeout for the task.
public Duration Timeout { get; set; }
Property Value
Remarks
Default: - None
Stability: Deprecated