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

Class CallApiGatewayRestApiEndpointJsonataProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CallApiGatewayRestApiEndpointJsonataProps>

Enclosing interface:

CallApiGatewayRestApiEndpointJsonataProps

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

A builder for CallApiGatewayRestApiEndpointJsonataProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CallApiGatewayRestApiEndpointJsonataProps.Builder	api(IRestApi api)	Sets the value of CallApiGatewayRestApiEndpointOptions.getApi()
CallApiGatewayRestApiEndpointJsonataProps.Builder	apiPath(String apiPath)	Sets the value of CallApiGatewayEndpointBaseOptions.getApiPath()
CallApiGatewayRestApiEndpointJsonataProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
CallApiGatewayRestApiEndpointJsonataProps.Builder	authType(AuthType authType)	Sets the value of CallApiGatewayEndpointBaseOptions.getAuthType()
CallApiGatewayRestApiEndpointJsonataProps	build()	Builds the configured instance.
CallApiGatewayRestApiEndpointJsonataProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
CallApiGatewayRestApiEndpointJsonataProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
CallApiGatewayRestApiEndpointJsonataProps.Builder	headers(TaskInput headers)	Sets the value of CallApiGatewayEndpointBaseOptions.getHeaders()
CallApiGatewayRestApiEndpointJsonataProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
CallApiGatewayRestApiEndpointJsonataProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
CallApiGatewayRestApiEndpointJsonataProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
CallApiGatewayRestApiEndpointJsonataProps.Builder	method(HttpMethod method)	Sets the value of CallApiGatewayEndpointBaseOptions.getMethod()
CallApiGatewayRestApiEndpointJsonataProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
CallApiGatewayRestApiEndpointJsonataProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
CallApiGatewayRestApiEndpointJsonataProps.Builder	queryParameters(TaskInput queryParameters)	Sets the value of CallApiGatewayEndpointBaseOptions.getQueryParameters()
CallApiGatewayRestApiEndpointJsonataProps.Builder	region(String region)	Sets the value of CallApiGatewayRestApiEndpointOptions.getRegion()
CallApiGatewayRestApiEndpointJsonataProps.Builder	requestBody(TaskInput requestBody)	Sets the value of CallApiGatewayEndpointBaseOptions.getRequestBody()
CallApiGatewayRestApiEndpointJsonataProps.Builder	stageName(String stageName)	Sets the value of CallApiGatewayRestApiEndpointOptions.getStageName()
CallApiGatewayRestApiEndpointJsonataProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
CallApiGatewayRestApiEndpointJsonataProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
CallApiGatewayRestApiEndpointJsonataProps.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

comment

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

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public CallApiGatewayRestApiEndpointJsonataProps.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 CallApiGatewayRestApiEndpointJsonataProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public CallApiGatewayRestApiEndpointJsonataProps.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 CallApiGatewayRestApiEndpointJsonataProps.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 CallApiGatewayRestApiEndpointJsonataProps.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 CallApiGatewayRestApiEndpointJsonataProps.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 CallApiGatewayRestApiEndpointJsonataProps.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 CallApiGatewayRestApiEndpointJsonataProps.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 CallApiGatewayRestApiEndpointJsonataProps.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

outputs

@Stability(Stable)
public CallApiGatewayRestApiEndpointJsonataProps.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 CallApiGatewayRestApiEndpointJsonataProps.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 CallApiGatewayRestApiEndpointJsonataProps.Builder apiPath(String apiPath)

Sets the value of CallApiGatewayEndpointBaseOptions.getApiPath()

Parameters:

apiPath - Path parameters appended after API endpoint.

Returns:

this

authType

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

Sets the value of CallApiGatewayEndpointBaseOptions.getAuthType()

Parameters:

authType - Authentication methods.

Returns:

this

headers

@Stability(Stable)
public CallApiGatewayRestApiEndpointJsonataProps.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 CallApiGatewayRestApiEndpointJsonataProps.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 CallApiGatewayRestApiEndpointJsonataProps.Builder requestBody(TaskInput requestBody)

Sets the value of CallApiGatewayEndpointBaseOptions.getRequestBody()

Parameters:

requestBody - HTTP Request body.

Returns:

this

api

@Stability(Stable)
public CallApiGatewayRestApiEndpointJsonataProps.Builder api(IRestApi api)

Sets the value of CallApiGatewayRestApiEndpointOptions.getApi()

Parameters:

api - API to call. This parameter is required.

Returns:

this

stageName

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

Sets the value of CallApiGatewayRestApiEndpointOptions.getStageName()

Parameters:

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

Returns:

this

region

@Stability(Stable)
public CallApiGatewayRestApiEndpointJsonataProps.Builder region(String region)

Sets the value of CallApiGatewayRestApiEndpointOptions.getRegion()

Parameters:

region - Specify a custom Region where the API is deployed, e.g. 'us-east-1'.

Returns:

this

build

@Stability(Stable)
public CallApiGatewayRestApiEndpointJsonataProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CallApiGatewayRestApiEndpointJsonataProps

Throws:

NullPointerException - if any required attribute was not provided