Package software.amazon.awscdk.aws_apigatewayv2_integrations

Class HttpStepFunctionsIntegration.Builder

java.lang.Object

software.amazon.awscdk.aws_apigatewayv2_integrations.HttpStepFunctionsIntegration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpStepFunctionsIntegration>

Enclosing class:

HttpStepFunctionsIntegration

@Stability(Stable)
public static final class HttpStepFunctionsIntegration.Builder
extends Object
implements software.amazon.jsii.Builder<HttpStepFunctionsIntegration>

A fluent builder for HttpStepFunctionsIntegration.

Method Summary

Modifier and Type	Method	Description
HttpStepFunctionsIntegration	build()
static HttpStepFunctionsIntegration.Builder	create(String id)
HttpStepFunctionsIntegration.Builder	parameterMapping(ParameterMapping parameterMapping)	Specifies how to transform HTTP requests before sending them to the backend.
HttpStepFunctionsIntegration.Builder	stateMachine(StateMachine stateMachine)	Statemachine that Integrates with API Gateway.
HttpStepFunctionsIntegration.Builder	subtype(HttpIntegrationSubtype subtype)	The subtype of the HTTP integration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static HttpStepFunctionsIntegration.Builder create(String id)

Parameters:

id - id of the underlying integration construct. This parameter is required.

Returns:

a new instance of HttpStepFunctionsIntegration.Builder.

stateMachine

@Stability(Stable)
public HttpStepFunctionsIntegration.Builder stateMachine(StateMachine stateMachine)

Statemachine that Integrates with API Gateway.

Parameters:

stateMachine - Statemachine that Integrates with API Gateway. This parameter is required.

Returns:

this

parameterMapping

@Stability(Stable)
public HttpStepFunctionsIntegration.Builder parameterMapping(ParameterMapping parameterMapping)

Specifies how to transform HTTP requests before sending them to the backend.

When the subtype is either START_EXECUTION or START_SYNC_EXECUTION, it is necessary to specify the StateMachineArn. Conversely, when the subtype is STOP_EXECUTION, the ExecutionArn must be specified.

Default: - specify only `StateMachineArn`

Parameters:

parameterMapping - Specifies how to transform HTTP requests before sending them to the backend. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html

subtype

@Stability(Stable)
public HttpStepFunctionsIntegration.Builder subtype(HttpIntegrationSubtype subtype)

The subtype of the HTTP integration.

Only subtypes starting with STEPFUNCTIONS_ can be specified.

Default: HttpIntegrationSubtype.STEPFUNCTIONS_START_EXECUTION

Parameters:

subtype - The subtype of the HTTP integration. This parameter is required.

Returns:

this

build

@Stability(Stable)
public HttpStepFunctionsIntegration build()

Specified by:

build in interface software.amazon.jsii.Builder<HttpStepFunctionsIntegration>

Returns:

a newly built instance of HttpStepFunctionsIntegration.