AwsApiGatewayRestSfnRouteIntegrationArgs

interface AwsApiGatewayRestSfnRouteIntegrationArgs {
action?: Input<AwsApiGatewayRestSfnAction>;
credentialsArn: Input<string>;
passthroughBehavior?: Input<string>;
requestTemplates?: Input<Record<string, Input<string>>>;
targetArn: Input<string>;
type: 'sfn';
}

Step Functions route integration target definition for REST APIs.

Example

CODE

const integration: AwsApiGatewayRestSfnRouteIntegrationArgs = {
  type: 'sfn',
  targetArn: stateMachine.arn,
  credentialsArn: apiGatewayExecutionRole.arn,
  action: 'StartExecution',
};

Properties

`action: Input<AwsApiGatewayRestSfnAction>`

Optional Step Functions action. Defaults to StartExecution.

`credentialsArn: Input<string>`

IAM role ARN assumed by API Gateway for Step Functions execution.

`passthroughBehavior: Input<string>`

Optional passthrough behaviour for request templates. Defaults to WHEN_NO_MATCH.

`requestTemplates: Input<Record<string, Input<string>>>`

Optional request templates. Defaults to a JSON execution payload mapping.

`targetArn: Input<string>`

Step Functions state machine ARN target.

`type: 'sfn'`

Integration capability type.