Package software.amazon.awscdk.services.apigatewayv2

Class HttpStage.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.HttpStage.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpStage>

Enclosing class:

HttpStage

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

A fluent builder for HttpStage.

Method Summary

Modifier and Type	Method	Description
HttpStage.Builder	autoDeploy(Boolean autoDeploy)	Whether updates to an API automatically trigger a new deployment.
HttpStage	build()
static HttpStage.Builder	create(software.constructs.Construct scope, String id)
HttpStage.Builder	domainMapping(DomainMappingOptions domainMapping)	The options for custom domain and api mapping.
HttpStage.Builder	httpApi(IHttpApi httpApi)	The HTTP API to which this stage is associated.
HttpStage.Builder	stageName(String stageName)	The name of the stage.
HttpStage.Builder	throttle(ThrottleSettings throttle)	Throttle settings for the routes of this stage.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static HttpStage.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of HttpStage.Builder.

autoDeploy

@Stability(Stable)
public HttpStage.Builder autoDeploy(Boolean autoDeploy)

Whether updates to an API automatically trigger a new deployment.

Default: false

Parameters:

autoDeploy - Whether updates to an API automatically trigger a new deployment. This parameter is required.

Returns:

this

domainMapping

@Stability(Stable)
public HttpStage.Builder domainMapping(DomainMappingOptions domainMapping)

The options for custom domain and api mapping.

Default: - no custom domain and api mapping configuration

Parameters:

domainMapping - The options for custom domain and api mapping. This parameter is required.

Returns:

this

throttle

@Stability(Stable)
public HttpStage.Builder throttle(ThrottleSettings throttle)

Throttle settings for the routes of this stage.

Default: - no throttling configuration

Parameters:

throttle - Throttle settings for the routes of this stage. This parameter is required.

Returns:

this

stageName

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

The name of the stage.

See StageName class for more details.

Default: '$default' the default stage of the API. This stage will have the URL at the root of the API endpoint.

Parameters:

stageName - The name of the stage. This parameter is required.

Returns:

this

httpApi

@Stability(Stable)
public HttpStage.Builder httpApi(IHttpApi httpApi)

The HTTP API to which this stage is associated.

Parameters:

httpApi - The HTTP API to which this stage is associated. This parameter is required.

Returns:

this

build

@Stability(Stable)
public HttpStage build()

Specified by:

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

Returns:

a newly built instance of HttpStage.