Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeTargetStateMachineParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.PipeTargetStateMachineParametersProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.PipeTargetStateMachineParametersProperty
extends software.amazon.jsii.JsiiSerializable

The parameters for using a Step Functions state machine as a target.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pipes.*;
 PipeTargetStateMachineParametersProperty pipeTargetStateMachineParametersProperty = PipeTargetStateMachineParametersProperty.builder()
         .invocationType("invocationType")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipe.PipeTargetStateMachineParametersProperty.Builder	A builder for CfnPipe.PipeTargetStateMachineParametersProperty
static final class	CfnPipe.PipeTargetStateMachineParametersProperty.Jsii$Proxy	An implementation for CfnPipe.PipeTargetStateMachineParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipe.PipeTargetStateMachineParametersProperty.Builder	builder()
default String	getInvocationType()	Specify whether to invoke the Step Functions state machine synchronously or asynchronously.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInvocationType

@Stability(Stable)
@Nullable
default String getInvocationType()

Specify whether to invoke the Step Functions state machine synchronously or asynchronously.

• REQUEST_RESPONSE (default) - Invoke synchronously. For more information, see StartSyncExecution in the AWS Step Functions API Reference .

REQUEST_RESPONSE is not supported for STANDARD state machine workflows.

• FIRE_AND_FORGET - Invoke asynchronously. For more information, see StartExecution in the AWS Step Functions API Reference .

For more information, see Invocation types in the Amazon EventBridge User Guide .

builder

@Stability(Stable)
static CfnPipe.PipeTargetStateMachineParametersProperty.Builder builder()

Returns:

a CfnPipe.PipeTargetStateMachineParametersProperty.Builder of CfnPipe.PipeTargetStateMachineParametersProperty