aws-cdk-lib.aws_pipes.CfnPipe.PipeTargetStateMachineParametersProperty

interface PipeTargetStateMachineParametersProperty

LanguageType name
.NETAmazon.CDK.AWS.Pipes.CfnPipe.PipeTargetStateMachineParametersProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awspipes#CfnPipe_PipeTargetStateMachineParametersProperty
Javasoftware.amazon.awscdk.services.pipes.CfnPipe.PipeTargetStateMachineParametersProperty
Pythonaws_cdk.aws_pipes.CfnPipe.PipeTargetStateMachineParametersProperty
TypeScript aws-cdk-lib » aws_pipes » CfnPipe » PipeTargetStateMachineParametersProperty

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 { aws_pipes as pipes } from 'aws-cdk-lib';
const pipeTargetStateMachineParametersProperty: pipes.CfnPipe.PipeTargetStateMachineParametersProperty = {
  invocationType: 'invocationType',
};

Properties

NameTypeDescription
invocationType?stringSpecify whether to invoke the Step Functions state machine synchronously or asynchronously.

invocationType?

Type: string (optional)

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 .