Package software.amazon.awscdk.services.apigatewayv2

Class HttpStageOptions.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.HttpStageOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpStageOptions>

Enclosing interface:

HttpStageOptions

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

A builder for HttpStageOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpStageOptions.Builder	autoDeploy(Boolean autoDeploy)	Sets the value of StageOptions.getAutoDeploy()
HttpStageOptions	build()	Builds the configured instance.
HttpStageOptions.Builder	description(String description)	Sets the value of StageOptions.getDescription()
HttpStageOptions.Builder	domainMapping(DomainMappingOptions domainMapping)	Sets the value of StageOptions.getDomainMapping()
HttpStageOptions.Builder	stageName(String stageName)	Sets the value of HttpStageOptions.getStageName()
HttpStageOptions.Builder	throttle(ThrottleSettings throttle)	Sets the value of StageOptions.getThrottle()

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

stageName

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

Sets the value of HttpStageOptions.getStageName()

Parameters:

stageName - The name of the stage. See StageName class for more details.

Returns:

this

autoDeploy

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

Sets the value of StageOptions.getAutoDeploy()

Parameters:

autoDeploy - Whether updates to an API automatically trigger a new deployment.

Returns:

this

description

@Stability(Stable)
public HttpStageOptions.Builder description(String description)

Sets the value of StageOptions.getDescription()

Parameters:

description - The description for the API stage.

Returns:

this

domainMapping

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

Sets the value of StageOptions.getDomainMapping()

Parameters:

domainMapping - The options for custom domain and api mapping.

Returns:

this

throttle

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

Sets the value of StageOptions.getThrottle()

Parameters:

throttle - Throttle settings for the routes of this stage.

Returns:

this

build

@Stability(Stable)
public HttpStageOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of HttpStageOptions

Throws:

NullPointerException - if any required attribute was not provided