Package software.amazon.awscdk.services.apigatewayv2

Class StageOptions.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.StageOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StageOptions>

Enclosing interface:

StageOptions

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

A builder for StageOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StageOptions.Builder	autoDeploy(Boolean autoDeploy)	Sets the value of StageOptions.getAutoDeploy()
StageOptions	build()	Builds the configured instance.
StageOptions.Builder	description(String description)	Sets the value of StageOptions.getDescription()
StageOptions.Builder	domainMapping(DomainMappingOptions domainMapping)	Sets the value of StageOptions.getDomainMapping()
StageOptions.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

autoDeploy

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

Sets the value of StageOptions.getDescription()

Parameters:

description - The description for the API stage.

Returns:

this

domainMapping

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of StageOptions

Throws:

NullPointerException - if any required attribute was not provided