software.amazon.awscdk.services.stepfunctions.tasks

Class CallApiGatewayHttpApiEndpoint.Builder

java.lang.Object

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

Enclosing class:

CallApiGatewayHttpApiEndpoint

public static final class CallApiGatewayHttpApiEndpoint.Builder
extends java.lang.Object

A fluent builder for CallApiGatewayHttpApiEndpoint.

Method Summary

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

public static CallApiGatewayHttpApiEndpoint.Builder create(software.constructs.Construct scope,
                                                           java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of CallApiGatewayHttpApiEndpoint.Builder.

comment

public CallApiGatewayHttpApiEndpoint.Builder comment(java.lang.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

public CallApiGatewayHttpApiEndpoint.Builder heartbeat(Duration heartbeat)

Timeout for the heartbeat.

Default: - None

Parameters:

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

Returns:

this

inputPath

public CallApiGatewayHttpApiEndpoint.Builder inputPath(java.lang.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

public CallApiGatewayHttpApiEndpoint.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

public CallApiGatewayHttpApiEndpoint.Builder outputPath(java.lang.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

public CallApiGatewayHttpApiEndpoint.Builder resultPath(java.lang.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

public CallApiGatewayHttpApiEndpoint.Builder resultSelector(java.util.Map<java.lang.String,? extends java.lang.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

public CallApiGatewayHttpApiEndpoint.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

public CallApiGatewayHttpApiEndpoint.Builder method(HttpMethod method)

Http method for the API.

Parameters:

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

Returns:

this

apiPath

public CallApiGatewayHttpApiEndpoint.Builder apiPath(java.lang.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

public CallApiGatewayHttpApiEndpoint.Builder authType(AuthType authType)

Authentication methods.

Default: AuthType.NO_AUTH

Parameters:

authType - Authentication methods. This parameter is required.

Returns:

this

headers

public CallApiGatewayHttpApiEndpoint.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

public CallApiGatewayHttpApiEndpoint.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

public CallApiGatewayHttpApiEndpoint.Builder requestBody(TaskInput requestBody)

HTTP Request body.

Default: - No request body

Parameters:

requestBody - HTTP Request body. This parameter is required.

Returns:

this

apiId

public CallApiGatewayHttpApiEndpoint.Builder apiId(java.lang.String apiId)

The Id of the API to call.

Parameters:

apiId - The Id of the API to call. This parameter is required.

Returns:

this

apiStack

public CallApiGatewayHttpApiEndpoint.Builder apiStack(Stack apiStack)

The Stack in which the API is defined.

Parameters:

apiStack - The Stack in which the API is defined. This parameter is required.

Returns:

this

stageName

public CallApiGatewayHttpApiEndpoint.Builder stageName(java.lang.String stageName)

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

Default: '$default'

Parameters:

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

Returns:

this

build

public CallApiGatewayHttpApiEndpoint build()