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

Class CallApiGatewayRestApiEndpointOptions.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CallApiGatewayRestApiEndpointOptions>

Enclosing interface:

CallApiGatewayRestApiEndpointOptions

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

A builder for CallApiGatewayRestApiEndpointOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CallApiGatewayRestApiEndpointOptions.Builder	api(IRestApi api)	Sets the value of CallApiGatewayRestApiEndpointOptions.getApi()
CallApiGatewayRestApiEndpointOptions	build()	Builds the configured instance.
CallApiGatewayRestApiEndpointOptions.Builder	region(String region)	Sets the value of CallApiGatewayRestApiEndpointOptions.getRegion()
CallApiGatewayRestApiEndpointOptions.Builder	stageName(String stageName)	Sets the value of CallApiGatewayRestApiEndpointOptions.getStageName()

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

api

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CallApiGatewayRestApiEndpointOptions

Throws:

NullPointerException - if any required attribute was not provided