Package software.amazon.awscdk.services.apigatewayv2

Class HttpStageProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.HttpStageProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpStageProps>

Enclosing interface:

HttpStageProps

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

A builder for HttpStageProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpStageProps.Builder	accessLogSettings(IAccessLogSettings accessLogSettings)	Sets the value of StageOptions.getAccessLogSettings()
HttpStageProps.Builder	autoDeploy(Boolean autoDeploy)	Sets the value of StageOptions.getAutoDeploy()
HttpStageProps	build()	Builds the configured instance.
HttpStageProps.Builder	description(String description)	Sets the value of StageOptions.getDescription()
HttpStageProps.Builder	detailedMetricsEnabled(Boolean detailedMetricsEnabled)	Sets the value of StageOptions.getDetailedMetricsEnabled()
HttpStageProps.Builder	domainMapping(DomainMappingOptions domainMapping)	Sets the value of StageOptions.getDomainMapping()
HttpStageProps.Builder	httpApi(IHttpApi httpApi)	Sets the value of HttpStageProps.getHttpApi()
HttpStageProps.Builder	stageName(String stageName)	Sets the value of HttpStageOptions.getStageName()
HttpStageProps.Builder	stageVariables(Map<String,String> stageVariables)	Sets the value of StageOptions.getStageVariables()
HttpStageProps.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

httpApi

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

Sets the value of HttpStageProps.getHttpApi()

Parameters:

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

Returns:

this

stageName

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

accessLogSettings

@Stability(Stable)
public HttpStageProps.Builder accessLogSettings(IAccessLogSettings accessLogSettings)

Sets the value of StageOptions.getAccessLogSettings()

Parameters:

accessLogSettings - Settings for access logging.

Returns:

this

autoDeploy

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

Sets the value of StageOptions.getDescription()

Parameters:

description - The description for the API stage.

Returns:

this

detailedMetricsEnabled

@Stability(Stable)
public HttpStageProps.Builder detailedMetricsEnabled(Boolean detailedMetricsEnabled)

Sets the value of StageOptions.getDetailedMetricsEnabled()

Parameters:

detailedMetricsEnabled - Specifies whether detailed metrics are enabled.

Returns:

this

domainMapping

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

Sets the value of StageOptions.getDomainMapping()

Parameters:

domainMapping - The options for custom domain and api mapping.

Returns:

this

stageVariables

@Stability(Stable)
public HttpStageProps.Builder stageVariables(Map<String,String> stageVariables)

Sets the value of StageOptions.getStageVariables()

Parameters:

stageVariables - Stage variables for the stage. These are key-value pairs that you can define and use in your API routes. The allowed characters for variable names and the required pattern for variable values are specified here: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables

Returns:

this

throttle

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of HttpStageProps

Throws:

NullPointerException - if any required attribute was not provided