software.amazon.awscdk.services.stepfunctions.tasks

Class CallApiGatewayRestApiEndpoint.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayRestApiEndpoint.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CallApiGatewayRestApiEndpoint>

Enclosing class:

CallApiGatewayRestApiEndpoint

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

A fluent builder for CallApiGatewayRestApiEndpoint.

Method Summary

Modifier and Type	Method and Description
CallApiGatewayRestApiEndpoint.Builder	api(IRestApi api) API to call.
CallApiGatewayRestApiEndpoint.Builder	apiPath(String apiPath) Path parameters appended after API endpoint.
CallApiGatewayRestApiEndpoint.Builder	authType(AuthType authType) Authentication methods.
CallApiGatewayRestApiEndpoint	build()
CallApiGatewayRestApiEndpoint.Builder	comment(String comment) An optional description for this state.
static CallApiGatewayRestApiEndpoint.Builder	create(software.constructs.Construct scope, String id)
CallApiGatewayRestApiEndpoint.Builder	headers(TaskInput headers) HTTP request information that does not relate to contents of the request.
CallApiGatewayRestApiEndpoint.Builder	heartbeat(Duration heartbeat) Timeout for the heartbeat.
CallApiGatewayRestApiEndpoint.Builder	inputPath(String inputPath) JSONPath expression to select part of the state to be the input to this state.
CallApiGatewayRestApiEndpoint.Builder	integrationPattern(IntegrationPattern integrationPattern) AWS Step Functions integrates with services directly in the Amazon States Language.
CallApiGatewayRestApiEndpoint.Builder	method(HttpMethod method) Http method for the API.
CallApiGatewayRestApiEndpoint.Builder	outputPath(String outputPath) JSONPath expression to select select a portion of the state output to pass to the next state.
CallApiGatewayRestApiEndpoint.Builder	queryParameters(TaskInput queryParameters) Query strings attatched to end of request.
CallApiGatewayRestApiEndpoint.Builder	requestBody(TaskInput requestBody) HTTP Request body.
CallApiGatewayRestApiEndpoint.Builder	resultPath(String resultPath) JSONPath expression to indicate where to inject the state's output.
CallApiGatewayRestApiEndpoint.Builder	resultSelector(Map<String,? extends Object> resultSelector) The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
CallApiGatewayRestApiEndpoint.Builder	stageName(String stageName) Name of the stage where the API is deployed to in API Gateway.
CallApiGatewayRestApiEndpoint.Builder	timeout(Duration timeout) Timeout for the state machine.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CallApiGatewayRestApiEndpoint.Builder create(software.constructs.Construct scope,
                                                                                    String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of CallApiGatewayRestApiEndpoint.Builder.

comment

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder comment(String comment)

An optional description for this state.

Default: - No comment

Parameters:

comment - An optional description for this state. This parameter is required.

Returns:

this

heartbeat

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder heartbeat(Duration heartbeat)

Timeout for the heartbeat.

Default: - None

Parameters:

heartbeat - Timeout for the heartbeat. This parameter is required.

Returns:

this

inputPath

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder inputPath(String inputPath)

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Default: - The entire task input (JSON path '$')

Parameters:

inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.

Returns:

this

integrationPattern

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder integrationPattern(IntegrationPattern integrationPattern)

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns

Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

Parameters:

integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token

outputPath

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder outputPath(String outputPath)

JSONPath expression to select select a portion of the state output to pass to the next state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')

Parameters:

outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.

Returns:

this

resultPath

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder resultPath(String resultPath)

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Default: - Replaces the entire input with the result (JSON path '$')

Parameters:

resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.

Returns:

this

resultSelector

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder resultSelector(Map<String,? extends Object> resultSelector)

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Default: - None

Parameters:

resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

timeout

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder timeout(Duration timeout)

Timeout for the state machine.

Default: - None

Parameters:

timeout - Timeout for the state machine. This parameter is required.

Returns:

this

method

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder method(HttpMethod method)

Http method for the API.

Parameters:

method - Http method for the API. This parameter is required.

Returns:

this

apiPath

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder apiPath(String apiPath)

Path parameters appended after API endpoint.

Default: - No path

Parameters:

apiPath - Path parameters appended after API endpoint. This parameter is required.

Returns:

this

authType

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder authType(AuthType authType)

Authentication methods.

Default: AuthType.NO_AUTH

Parameters:

authType - Authentication methods. This parameter is required.

Returns:

this

headers

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder headers(TaskInput headers)

HTTP request information that does not relate to contents of the request.

Default: - No headers

Parameters:

headers - HTTP request information that does not relate to contents of the request. This parameter is required.

Returns:

this

queryParameters

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder queryParameters(TaskInput queryParameters)

Query strings attatched to end of request.

Default: - No query parameters

Parameters:

queryParameters - Query strings attatched to end of request. This parameter is required.

Returns:

this

requestBody

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder requestBody(TaskInput requestBody)

HTTP Request body.

Default: - No request body

Parameters:

requestBody - HTTP Request body. This parameter is required.

Returns:

this

api

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder api(IRestApi api)

API to call.

Parameters:

api - API to call. This parameter is required.

Returns:

this

stageName

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint.Builder stageName(String stageName)

Name of the stage where the API is deployed to in API Gateway.

Parameters:

stageName - Name of the stage where the API is deployed to in API Gateway. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CallApiGatewayRestApiEndpoint build()

Specified by:

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