Class CfnStageProps.Builder
java.lang.Object
software.amazon.awscdk.services.apigatewayv2.CfnStageProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnStageProps>
- Enclosing interface:
CfnStageProps
@Stability(Stable)
public static final class CfnStageProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnStageProps>
A builder for
CfnStageProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaccessLogSettings
(IResolvable accessLogSettings) Sets the value ofCfnStageProps.getAccessLogSettings()
accessLogSettings
(CfnStage.AccessLogSettingsProperty accessLogSettings) Sets the value ofCfnStageProps.getAccessLogSettings()
accessPolicyId
(String accessPolicyId) Sets the value ofCfnStageProps.getAccessPolicyId()
Sets the value ofCfnStageProps.getApiId()
autoDeploy
(Boolean autoDeploy) Sets the value ofCfnStageProps.getAutoDeploy()
autoDeploy
(IResolvable autoDeploy) Sets the value ofCfnStageProps.getAutoDeploy()
build()
Builds the configured instance.clientCertificateId
(String clientCertificateId) Sets the value ofCfnStageProps.getClientCertificateId()
defaultRouteSettings
(IResolvable defaultRouteSettings) Sets the value ofCfnStageProps.getDefaultRouteSettings()
defaultRouteSettings
(CfnStage.RouteSettingsProperty defaultRouteSettings) Sets the value ofCfnStageProps.getDefaultRouteSettings()
deploymentId
(String deploymentId) Sets the value ofCfnStageProps.getDeploymentId()
description
(String description) Sets the value ofCfnStageProps.getDescription()
routeSettings
(Object routeSettings) Sets the value ofCfnStageProps.getRouteSettings()
Sets the value ofCfnStageProps.getStageName()
stageVariables
(Object stageVariables) Sets the value ofCfnStageProps.getStageVariables()
Sets the value ofCfnStageProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
apiId
Sets the value ofCfnStageProps.getApiId()
- Parameters:
apiId
- The API identifier. This parameter is required.- Returns:
this
-
stageName
Sets the value ofCfnStageProps.getStageName()
- Parameters:
stageName
- The stage name. This parameter is required. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be$default
. Maximum length is 128 characters.- Returns:
this
-
accessLogSettings
Sets the value ofCfnStageProps.getAccessLogSettings()
- Parameters:
accessLogSettings
- Settings for logging access in this stage.- Returns:
this
-
accessLogSettings
@Stability(Stable) public CfnStageProps.Builder accessLogSettings(CfnStage.AccessLogSettingsProperty accessLogSettings) Sets the value ofCfnStageProps.getAccessLogSettings()
- Parameters:
accessLogSettings
- Settings for logging access in this stage.- Returns:
this
-
accessPolicyId
Sets the value ofCfnStageProps.getAccessPolicyId()
- Parameters:
accessPolicyId
- This parameter is not currently supported.- Returns:
this
-
autoDeploy
Sets the value ofCfnStageProps.getAutoDeploy()
- Parameters:
autoDeploy
- Specifies whether updates to an API automatically trigger a new deployment. The default value isfalse
.- Returns:
this
-
autoDeploy
Sets the value ofCfnStageProps.getAutoDeploy()
- Parameters:
autoDeploy
- Specifies whether updates to an API automatically trigger a new deployment. The default value isfalse
.- Returns:
this
-
clientCertificateId
Sets the value ofCfnStageProps.getClientCertificateId()
- Parameters:
clientCertificateId
- The identifier of a client certificate for aStage
. Supported only for WebSocket APIs.- Returns:
this
-
defaultRouteSettings
@Stability(Stable) public CfnStageProps.Builder defaultRouteSettings(IResolvable defaultRouteSettings) Sets the value ofCfnStageProps.getDefaultRouteSettings()
- Parameters:
defaultRouteSettings
- The default route settings for the stage.- Returns:
this
-
defaultRouteSettings
@Stability(Stable) public CfnStageProps.Builder defaultRouteSettings(CfnStage.RouteSettingsProperty defaultRouteSettings) Sets the value ofCfnStageProps.getDefaultRouteSettings()
- Parameters:
defaultRouteSettings
- The default route settings for the stage.- Returns:
this
-
deploymentId
Sets the value ofCfnStageProps.getDeploymentId()
- Parameters:
deploymentId
- The deployment identifier for the API stage. Can't be updated ifautoDeploy
is enabled.- Returns:
this
-
description
Sets the value ofCfnStageProps.getDescription()
- Parameters:
description
- The description for the API stage.- Returns:
this
-
routeSettings
Sets the value ofCfnStageProps.getRouteSettings()
- Parameters:
routeSettings
- Route settings for the stage.- Returns:
this
-
stageVariables
Sets the value ofCfnStageProps.getStageVariables()
- Parameters:
stageVariables
- A map that defines the stage variables for aStage
. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.- Returns:
this
-
tags
Sets the value ofCfnStageProps.getTags()
- Parameters:
tags
- The collection of tags. Each tag element is associated with a given resource.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnStageProps>
- Returns:
- a new instance of
CfnStageProps
- Throws:
NullPointerException
- if any required attribute was not provided
-