Show / Hide Table of Contents

Class StepFunctionsIntegration

Options to integrate with various StepFunction API.

Inheritance
System.Object
StepFunctionsIntegration
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class StepFunctionsIntegration : DeputyBase
Syntax (vb)
Public Class StepFunctionsIntegration
    Inherits DeputyBase
Remarks

ExampleMetadata: infused

Examples
var stateMachine = new StateMachine(this, "MyStateMachine", new StateMachineProps {
    StateMachineType = StateMachineType.EXPRESS,
    Definition = Chain.Start(new Pass(this, "Pass"))
});

var api = new RestApi(this, "Api", new RestApiProps {
    RestApiName = "MyApi"
});
api.Root.AddMethod("GET", StepFunctionsIntegration.StartExecution(stateMachine));

Synopsis

Constructors

StepFunctionsIntegration()
StepFunctionsIntegration(ByRefValue)

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

StepFunctionsIntegration(DeputyBase.DeputyProps)

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

Methods

StartExecution(IStateMachine, IStepFunctionsExecutionIntegrationOptions)

Integrates a Synchronous Express State Machine from AWS Step Functions to an API Gateway method.

Constructors

StepFunctionsIntegration()

public StepFunctionsIntegration()

StepFunctionsIntegration(ByRefValue)

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

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

The Javascript-owned object reference

StepFunctionsIntegration(DeputyBase.DeputyProps)

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

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

The deputy props

Methods

StartExecution(IStateMachine, IStepFunctionsExecutionIntegrationOptions)

Integrates a Synchronous Express State Machine from AWS Step Functions to an API Gateway method.

public static AwsIntegration StartExecution(IStateMachine stateMachine, IStepFunctionsExecutionIntegrationOptions options = null)
Parameters
stateMachine IStateMachine
options IStepFunctionsExecutionIntegrationOptions
Returns

AwsIntegration

Examples
var stateMachine = new StateMachine(this, "MyStateMachine", new StateMachineProps {
    StateMachineType = StateMachineType.EXPRESS,
    Definition = Chain.Start(new Pass(this, "Pass"))
});

var api = new RestApi(this, "Api", new RestApiProps {
    RestApiName = "MyApi"
});
api.Root.AddMethod("GET", StepFunctionsIntegration.StartExecution(stateMachine));
Back to top Generated by DocFX