Package software.amazon.awscdk.services.stepfunctions.tasks

Class CallApiGatewayHttpApiEndpointProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CallApiGatewayHttpApiEndpointProps>

Enclosing interface:

CallApiGatewayHttpApiEndpointProps

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

A builder for CallApiGatewayHttpApiEndpointProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CallApiGatewayHttpApiEndpointProps.Builder	apiId(String apiId)	Sets the value of CallApiGatewayHttpApiEndpointOptions.getApiId()
CallApiGatewayHttpApiEndpointProps.Builder	apiPath(String apiPath)	Sets the value of CallApiGatewayEndpointBaseOptions.getApiPath()
CallApiGatewayHttpApiEndpointProps.Builder	apiStack(Stack apiStack)	Sets the value of CallApiGatewayHttpApiEndpointOptions.getApiStack()
CallApiGatewayHttpApiEndpointProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
CallApiGatewayHttpApiEndpointProps.Builder	authType(AuthType authType)	Sets the value of CallApiGatewayEndpointBaseOptions.getAuthType()
CallApiGatewayHttpApiEndpointProps	build()	Builds the configured instance.
CallApiGatewayHttpApiEndpointProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
CallApiGatewayHttpApiEndpointProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
CallApiGatewayHttpApiEndpointProps.Builder	headers(TaskInput headers)	Sets the value of CallApiGatewayEndpointBaseOptions.getHeaders()
CallApiGatewayHttpApiEndpointProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
CallApiGatewayHttpApiEndpointProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
CallApiGatewayHttpApiEndpointProps.Builder	inputPath(String inputPath)	Sets the value of JsonPathCommonOptions.getInputPath()
CallApiGatewayHttpApiEndpointProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
CallApiGatewayHttpApiEndpointProps.Builder	method(HttpMethod method)	Sets the value of CallApiGatewayEndpointBaseOptions.getMethod()
CallApiGatewayHttpApiEndpointProps.Builder	outputPath(String outputPath)	Sets the value of JsonPathCommonOptions.getOutputPath()
CallApiGatewayHttpApiEndpointProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
CallApiGatewayHttpApiEndpointProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
CallApiGatewayHttpApiEndpointProps.Builder	queryParameters(TaskInput queryParameters)	Sets the value of CallApiGatewayEndpointBaseOptions.getQueryParameters()
CallApiGatewayHttpApiEndpointProps.Builder	requestBody(TaskInput requestBody)	Sets the value of CallApiGatewayEndpointBaseOptions.getRequestBody()
CallApiGatewayHttpApiEndpointProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
CallApiGatewayHttpApiEndpointProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
CallApiGatewayHttpApiEndpointProps.Builder	stageName(String stageName)	Sets the value of CallApiGatewayHttpApiEndpointOptions.getStageName()
CallApiGatewayHttpApiEndpointProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
CallApiGatewayHttpApiEndpointProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
CallApiGatewayHttpApiEndpointProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

resultPath

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder resultPath(String resultPath)

Sets the value of TaskStateBaseProps.getResultPath()

Parameters:

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.

Returns:

this

resultSelector

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

Sets the value of TaskStateBaseProps.getResultSelector()

Parameters:

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.

Returns:

this

comment

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder comment(String comment)

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder queryLanguage(QueryLanguage queryLanguage)

Sets the value of StateBaseProps.getQueryLanguage()

Parameters:

queryLanguage - The name of the query language used by the state. If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Returns:

this

stateName

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder credentials(Credentials credentials)

Sets the value of TaskStateBaseOptions.getCredentials()

Parameters:

credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.

Returns:

this

heartbeat

@Stability(Deprecated)
@Deprecated
public CallApiGatewayHttpApiEndpointProps.Builder heartbeat(Duration heartbeat)

Deprecated.

use `heartbeatTimeout`

Sets the value of TaskStateBaseOptions.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

heartbeatTimeout

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder heartbeatTimeout(Timeout heartbeatTimeout)

Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()

Parameters:

heartbeatTimeout - Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

integrationPattern

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseOptions.getIntegrationPattern()

Parameters:

integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Returns:

this

taskTimeout

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder taskTimeout(Timeout taskTimeout)

Sets the value of TaskStateBaseOptions.getTaskTimeout()

Parameters:

taskTimeout - Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

timeout

@Stability(Deprecated)
@Deprecated
public CallApiGatewayHttpApiEndpointProps.Builder timeout(Duration timeout)

Deprecated.

use `taskTimeout`

Sets the value of TaskStateBaseOptions.getTimeout()

Parameters:

timeout - Timeout for the task.

Returns:

this

assign

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder assign(Map<String,? extends Object> assign)

Sets the value of AssignableStateOptions.getAssign()

Parameters:

assign - Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.

Returns:

this

inputPath

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder inputPath(String inputPath)

Sets the value of JsonPathCommonOptions.getInputPath()

Parameters:

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 {}.

Returns:

this

outputPath

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder outputPath(String outputPath)

Sets the value of JsonPathCommonOptions.getOutputPath()

Parameters:

outputPath - JSONPath expression to select part of the state to be the output to this state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

this

outputs

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder outputs(Object outputs)

Sets the value of JsonataCommonOptions.getOutputs()

Parameters:

outputs - Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Returns:

this

method

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder method(HttpMethod method)

Sets the value of CallApiGatewayEndpointBaseOptions.getMethod()

Parameters:

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

Returns:

this

apiPath

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder apiPath(String apiPath)

Sets the value of CallApiGatewayEndpointBaseOptions.getApiPath()

Parameters:

apiPath - Path parameters appended after API endpoint.

Returns:

this

authType

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder authType(AuthType authType)

Sets the value of CallApiGatewayEndpointBaseOptions.getAuthType()

Parameters:

authType - Authentication methods.

Returns:

this

headers

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder headers(TaskInput headers)

Sets the value of CallApiGatewayEndpointBaseOptions.getHeaders()

Parameters:

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

Returns:

this

queryParameters

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder queryParameters(TaskInput queryParameters)

Sets the value of CallApiGatewayEndpointBaseOptions.getQueryParameters()

Parameters:

queryParameters - Query strings attatched to end of request.

Returns:

this

requestBody

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder requestBody(TaskInput requestBody)

Sets the value of CallApiGatewayEndpointBaseOptions.getRequestBody()

Parameters:

requestBody - HTTP Request body.

Returns:

this

apiId

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder apiId(String apiId)

Sets the value of CallApiGatewayHttpApiEndpointOptions.getApiId()

Parameters:

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

Returns:

this

apiStack

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder apiStack(Stack apiStack)

Sets the value of CallApiGatewayHttpApiEndpointOptions.getApiStack()

Parameters:

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

Returns:

this

stageName

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps.Builder stageName(String stageName)

Sets the value of CallApiGatewayHttpApiEndpointOptions.getStageName()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CallApiGatewayHttpApiEndpointProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CallApiGatewayHttpApiEndpointProps

Throws:

NullPointerException - if any required attribute was not provided