Class CfnStageProps.Builder
java.lang.Object
software.amazon.awscdk.services.apigateway.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 TypeMethodDescriptionaccessLogSetting
(IResolvable accessLogSetting) Sets the value ofCfnStageProps.getAccessLogSetting()
accessLogSetting
(CfnStage.AccessLogSettingProperty accessLogSetting) Sets the value ofCfnStageProps.getAccessLogSetting()
build()
Builds the configured instance.cacheClusterEnabled
(Boolean cacheClusterEnabled) Sets the value ofCfnStageProps.getCacheClusterEnabled()
cacheClusterEnabled
(IResolvable cacheClusterEnabled) Sets the value ofCfnStageProps.getCacheClusterEnabled()
cacheClusterSize
(String cacheClusterSize) Sets the value ofCfnStageProps.getCacheClusterSize()
canarySetting
(IResolvable canarySetting) Sets the value ofCfnStageProps.getCanarySetting()
canarySetting
(CfnStage.CanarySettingProperty canarySetting) Sets the value ofCfnStageProps.getCanarySetting()
clientCertificateId
(String clientCertificateId) Sets the value ofCfnStageProps.getClientCertificateId()
deploymentId
(String deploymentId) Sets the value ofCfnStageProps.getDeploymentId()
description
(String description) Sets the value ofCfnStageProps.getDescription()
documentationVersion
(String documentationVersion) Sets the value ofCfnStageProps.getDocumentationVersion()
methodSettings
(List<? extends Object> methodSettings) Sets the value ofCfnStageProps.getMethodSettings()
methodSettings
(IResolvable methodSettings) Sets the value ofCfnStageProps.getMethodSettings()
Sets the value ofCfnStageProps.getRestApiId()
Sets the value ofCfnStageProps.getStageName()
Sets the value ofCfnStageProps.getTags()
tracingEnabled
(Boolean tracingEnabled) Sets the value ofCfnStageProps.getTracingEnabled()
tracingEnabled
(IResolvable tracingEnabled) Sets the value ofCfnStageProps.getTracingEnabled()
Sets the value ofCfnStageProps.getVariables()
variables
(IResolvable variables) Sets the value ofCfnStageProps.getVariables()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
restApiId
Sets the value ofCfnStageProps.getRestApiId()
- Parameters:
restApiId
- The string identifier of the associated RestApi. This parameter is required.- Returns:
this
-
accessLogSetting
Sets the value ofCfnStageProps.getAccessLogSetting()
- Parameters:
accessLogSetting
- Access log settings, including the access log format and access log destination ARN.- Returns:
this
-
accessLogSetting
@Stability(Stable) public CfnStageProps.Builder accessLogSetting(CfnStage.AccessLogSettingProperty accessLogSetting) Sets the value ofCfnStageProps.getAccessLogSetting()
- Parameters:
accessLogSetting
- Access log settings, including the access log format and access log destination ARN.- Returns:
this
-
cacheClusterEnabled
Sets the value ofCfnStageProps.getCacheClusterEnabled()
- Parameters:
cacheClusterEnabled
- Specifies whether a cache cluster is enabled for the stage.- Returns:
this
-
cacheClusterEnabled
@Stability(Stable) public CfnStageProps.Builder cacheClusterEnabled(IResolvable cacheClusterEnabled) Sets the value ofCfnStageProps.getCacheClusterEnabled()
- Parameters:
cacheClusterEnabled
- Specifies whether a cache cluster is enabled for the stage.- Returns:
this
-
cacheClusterSize
Sets the value ofCfnStageProps.getCacheClusterSize()
- Parameters:
cacheClusterSize
- The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .- Returns:
this
-
canarySetting
Sets the value ofCfnStageProps.getCanarySetting()
- Parameters:
canarySetting
- Settings for the canary deployment in this stage.- Returns:
this
-
canarySetting
@Stability(Stable) public CfnStageProps.Builder canarySetting(CfnStage.CanarySettingProperty canarySetting) Sets the value ofCfnStageProps.getCanarySetting()
- Parameters:
canarySetting
- Settings for the canary deployment in this stage.- Returns:
this
-
clientCertificateId
Sets the value ofCfnStageProps.getClientCertificateId()
- Parameters:
clientCertificateId
- The identifier of a client certificate for an API stage.- Returns:
this
-
deploymentId
Sets the value ofCfnStageProps.getDeploymentId()
- Parameters:
deploymentId
- The identifier of the Deployment that the stage points to.- Returns:
this
-
description
Sets the value ofCfnStageProps.getDescription()
- Parameters:
description
- The stage's description.- Returns:
this
-
documentationVersion
Sets the value ofCfnStageProps.getDocumentationVersion()
- Parameters:
documentationVersion
- The version of the associated API documentation.- Returns:
this
-
methodSettings
Sets the value ofCfnStageProps.getMethodSettings()
- Parameters:
methodSettings
- A map that defines the method settings for a Stage resource. Keys (designated as/{method_setting_key
below) are method paths defined as{resource_path}/{http_method}
for an individual method override, or/\* /\*
for overriding all methods in the stage.- Returns:
this
-
methodSettings
@Stability(Stable) public CfnStageProps.Builder methodSettings(List<? extends Object> methodSettings) Sets the value ofCfnStageProps.getMethodSettings()
- Parameters:
methodSettings
- A map that defines the method settings for a Stage resource. Keys (designated as/{method_setting_key
below) are method paths defined as{resource_path}/{http_method}
for an individual method override, or/\* /\*
for overriding all methods in the stage.- Returns:
this
-
stageName
Sets the value ofCfnStageProps.getStageName()
- Parameters:
stageName
- The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.- 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
-
tracingEnabled
Sets the value ofCfnStageProps.getTracingEnabled()
- Parameters:
tracingEnabled
- Specifies whether active tracing with X-ray is enabled for the Stage.- Returns:
this
-
tracingEnabled
Sets the value ofCfnStageProps.getTracingEnabled()
- Parameters:
tracingEnabled
- Specifies whether active tracing with X-ray is enabled for the Stage.- Returns:
this
-
variables
Sets the value ofCfnStageProps.getVariables()
- Parameters:
variables
- A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression:[A-Za-z0-9-._~:/?#&=,]+
.- Returns:
this
-
variables
Sets the value ofCfnStageProps.getVariables()
- Parameters:
variables
- A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression:[A-Za-z0-9-._~:/?#&=,]+
.- 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
-