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(value=Experimental)
public static final class CallApiGatewayHttpApiEndpointProps.Builder
extends Object
implements software.amazon.jsii.Builder<CallApiGatewayHttpApiEndpointProps>

A builder for CallApiGatewayHttpApiEndpointProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CallApiGatewayHttpApiEndpointProps.Builder	apiId(String apiId) Sets the value of CallApiGatewayHttpApiEndpointProps.getApiId()
CallApiGatewayHttpApiEndpointProps.Builder	apiPath(String apiPath) Sets the value of CallApiGatewayEndpointBaseProps.getApiPath()
CallApiGatewayHttpApiEndpointProps.Builder	apiStack(Stack apiStack) Sets the value of CallApiGatewayHttpApiEndpointProps.getApiStack()
CallApiGatewayHttpApiEndpointProps.Builder	authType(AuthType authType) Sets the value of CallApiGatewayEndpointBaseProps.getAuthType()
CallApiGatewayHttpApiEndpointProps	build() Builds the configured instance.
CallApiGatewayHttpApiEndpointProps.Builder	comment(String comment) Sets the value of TaskStateBaseProps.getComment()
CallApiGatewayHttpApiEndpointProps.Builder	headers(TaskInput headers) Sets the value of CallApiGatewayEndpointBaseProps.getHeaders()
CallApiGatewayHttpApiEndpointProps.Builder	heartbeat(Duration heartbeat) Sets the value of TaskStateBaseProps.getHeartbeat()
CallApiGatewayHttpApiEndpointProps.Builder	inputPath(String inputPath) Sets the value of TaskStateBaseProps.getInputPath()
CallApiGatewayHttpApiEndpointProps.Builder	integrationPattern(IntegrationPattern integrationPattern) Sets the value of TaskStateBaseProps.getIntegrationPattern()
CallApiGatewayHttpApiEndpointProps.Builder	method(HttpMethod method) Sets the value of CallApiGatewayEndpointBaseProps.getMethod()
CallApiGatewayHttpApiEndpointProps.Builder	outputPath(String outputPath) Sets the value of TaskStateBaseProps.getOutputPath()
CallApiGatewayHttpApiEndpointProps.Builder	queryParameters(TaskInput queryParameters) Sets the value of CallApiGatewayEndpointBaseProps.getQueryParameters()
CallApiGatewayHttpApiEndpointProps.Builder	requestBody(TaskInput requestBody) Sets the value of CallApiGatewayEndpointBaseProps.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 CallApiGatewayHttpApiEndpointProps.getStageName()
CallApiGatewayHttpApiEndpointProps.Builder	timeout(Duration timeout) Sets the value of TaskStateBaseProps.getTimeout()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

apiId

@Stability(value=Experimental)
public CallApiGatewayHttpApiEndpointProps.Builder apiId(String apiId)

Sets the value of CallApiGatewayHttpApiEndpointProps.getApiId()

Parameters:

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

Returns:

this

apiStack

@Stability(value=Experimental)
public CallApiGatewayHttpApiEndpointProps.Builder apiStack(Stack apiStack)

Sets the value of CallApiGatewayHttpApiEndpointProps.getApiStack()

Parameters:

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

Returns:

this

stageName

@Stability(value=Experimental)
public CallApiGatewayHttpApiEndpointProps.Builder stageName(String stageName)

Sets the value of CallApiGatewayHttpApiEndpointProps.getStageName()

Parameters:

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

Returns:

this

method

@Stability(value=Experimental)
public CallApiGatewayHttpApiEndpointProps.Builder method(HttpMethod method)

Sets the value of CallApiGatewayEndpointBaseProps.getMethod()

Parameters:

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

Returns:

this

apiPath

@Stability(value=Experimental)
public CallApiGatewayHttpApiEndpointProps.Builder apiPath(String apiPath)

Sets the value of CallApiGatewayEndpointBaseProps.getApiPath()

Parameters:

apiPath - Path parameters appended after API endpoint.

Returns:

this

authType

@Stability(value=Experimental)
public CallApiGatewayHttpApiEndpointProps.Builder authType(AuthType authType)

Sets the value of CallApiGatewayEndpointBaseProps.getAuthType()

Parameters:

authType - Authentication methods.

Returns:

this

headers

@Stability(value=Experimental)
public CallApiGatewayHttpApiEndpointProps.Builder headers(TaskInput headers)

Sets the value of CallApiGatewayEndpointBaseProps.getHeaders()

Parameters:

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

Returns:

this

queryParameters

@Stability(value=Experimental)
public CallApiGatewayHttpApiEndpointProps.Builder queryParameters(TaskInput queryParameters)

Sets the value of CallApiGatewayEndpointBaseProps.getQueryParameters()

Parameters:

queryParameters - Query strings attatched to end of request.

Returns:

this

requestBody

@Stability(value=Experimental)
public CallApiGatewayHttpApiEndpointProps.Builder requestBody(TaskInput requestBody)

Sets the value of CallApiGatewayEndpointBaseProps.getRequestBody()

Parameters:

requestBody - HTTP Request body.

Returns:

this

comment

@Stability(value=Experimental)
public CallApiGatewayHttpApiEndpointProps.Builder comment(String comment)

Sets the value of TaskStateBaseProps.getComment()

Parameters:

comment - An optional description for this state.

Returns:

this

heartbeat

@Stability(value=Experimental)
public CallApiGatewayHttpApiEndpointProps.Builder heartbeat(Duration heartbeat)

Sets the value of TaskStateBaseProps.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

inputPath

@Stability(value=Experimental)
public CallApiGatewayHttpApiEndpointProps.Builder inputPath(String inputPath)

Sets the value of TaskStateBaseProps.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

integrationPattern

@Stability(value=Experimental)
public CallApiGatewayHttpApiEndpointProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseProps.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

Returns:

this

outputPath

@Stability(value=Experimental)
public CallApiGatewayHttpApiEndpointProps.Builder outputPath(String outputPath)

Sets the value of TaskStateBaseProps.getOutputPath()

Parameters:

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

Returns:

this

resultPath

@Stability(value=Experimental)
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(value=Experimental)
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

timeout

@Stability(value=Experimental)
public CallApiGatewayHttpApiEndpointProps.Builder timeout(Duration timeout)

Sets the value of TaskStateBaseProps.getTimeout()

Parameters:

timeout - Timeout for the state machine.

Returns:

this

build

@Stability(value=Experimental)
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