public static final class CfnStageProps.Builder
extends java.lang.Object
CfnStageProps
Constructor and Description |
---|
Builder() |
public CfnStageProps.Builder apiId(java.lang.String apiId)
CfnStageProps.getApiId()
apiId
- The API identifier. This parameter is required.this
public CfnStageProps.Builder stageName(java.lang.String stageName)
CfnStageProps.getStageName()
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.this
public CfnStageProps.Builder accessLogSettings(IResolvable accessLogSettings)
CfnStageProps.getAccessLogSettings()
accessLogSettings
- Settings for logging access in this stage.this
public CfnStageProps.Builder accessLogSettings(CfnStage.AccessLogSettingsProperty accessLogSettings)
CfnStageProps.getAccessLogSettings()
accessLogSettings
- Settings for logging access in this stage.this
public CfnStageProps.Builder accessPolicyId(java.lang.String accessPolicyId)
CfnStageProps.getAccessPolicyId()
accessPolicyId
- This parameter is not currently supported.this
public CfnStageProps.Builder autoDeploy(java.lang.Boolean autoDeploy)
CfnStageProps.getAutoDeploy()
autoDeploy
- Specifies whether updates to an API automatically trigger a new deployment.
The default value is false
.this
public CfnStageProps.Builder autoDeploy(IResolvable autoDeploy)
CfnStageProps.getAutoDeploy()
autoDeploy
- Specifies whether updates to an API automatically trigger a new deployment.
The default value is false
.this
public CfnStageProps.Builder clientCertificateId(java.lang.String clientCertificateId)
CfnStageProps.getClientCertificateId()
clientCertificateId
- The identifier of a client certificate for a `Stage` .
Supported only for WebSocket APIs.this
public CfnStageProps.Builder defaultRouteSettings(IResolvable defaultRouteSettings)
CfnStageProps.getDefaultRouteSettings()
defaultRouteSettings
- The default route settings for the stage.this
public CfnStageProps.Builder defaultRouteSettings(CfnStage.RouteSettingsProperty defaultRouteSettings)
CfnStageProps.getDefaultRouteSettings()
defaultRouteSettings
- The default route settings for the stage.this
public CfnStageProps.Builder deploymentId(java.lang.String deploymentId)
CfnStageProps.getDeploymentId()
deploymentId
- The deployment identifier for the API stage.
Can't be updated if autoDeploy
is enabled.this
public CfnStageProps.Builder description(java.lang.String description)
CfnStageProps.getDescription()
description
- The description for the API stage.this
public CfnStageProps.Builder routeSettings(java.lang.Object routeSettings)
CfnStageProps.getRouteSettings()
routeSettings
- Route settings for the stage.this
public CfnStageProps.Builder stageVariables(java.lang.Object stageVariables)
CfnStageProps.getStageVariables()
stageVariables
- A map that defines the stage variables for a `Stage` .
Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.this
public CfnStageProps.Builder tags(java.lang.Object tags)
CfnStageProps.getTags()
tags
- The collection of tags.
Each tag element is associated with a given resource.this
public CfnStageProps build()
CfnStageProps
java.lang.NullPointerException
- if any required attribute was not provided