Class CfnDeployment.StageDescriptionProperty.Builder
java.lang.Object
software.amazon.awscdk.services.apigateway.CfnDeployment.StageDescriptionProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDeployment.StageDescriptionProperty>
- Enclosing interface:
CfnDeployment.StageDescriptionProperty
@Stability(Stable)
public static final class CfnDeployment.StageDescriptionProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDeployment.StageDescriptionProperty>
A builder for
CfnDeployment.StageDescriptionProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaccessLogSetting
(IResolvable accessLogSetting) Sets the value ofCfnDeployment.StageDescriptionProperty.getAccessLogSetting()
accessLogSetting
(CfnDeployment.AccessLogSettingProperty accessLogSetting) Sets the value ofCfnDeployment.StageDescriptionProperty.getAccessLogSetting()
build()
Builds the configured instance.cacheClusterEnabled
(Boolean cacheClusterEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getCacheClusterEnabled()
cacheClusterEnabled
(IResolvable cacheClusterEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getCacheClusterEnabled()
cacheClusterSize
(String cacheClusterSize) Sets the value ofCfnDeployment.StageDescriptionProperty.getCacheClusterSize()
cacheDataEncrypted
(Boolean cacheDataEncrypted) Sets the value ofCfnDeployment.StageDescriptionProperty.getCacheDataEncrypted()
cacheDataEncrypted
(IResolvable cacheDataEncrypted) Sets the value ofCfnDeployment.StageDescriptionProperty.getCacheDataEncrypted()
cacheTtlInSeconds
(Number cacheTtlInSeconds) Sets the value ofCfnDeployment.StageDescriptionProperty.getCacheTtlInSeconds()
cachingEnabled
(Boolean cachingEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getCachingEnabled()
cachingEnabled
(IResolvable cachingEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getCachingEnabled()
canarySetting
(IResolvable canarySetting) Sets the value ofCfnDeployment.StageDescriptionProperty.getCanarySetting()
canarySetting
(CfnDeployment.CanarySettingProperty canarySetting) Sets the value ofCfnDeployment.StageDescriptionProperty.getCanarySetting()
clientCertificateId
(String clientCertificateId) Sets the value ofCfnDeployment.StageDescriptionProperty.getClientCertificateId()
dataTraceEnabled
(Boolean dataTraceEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getDataTraceEnabled()
dataTraceEnabled
(IResolvable dataTraceEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getDataTraceEnabled()
description
(String description) Sets the value ofCfnDeployment.StageDescriptionProperty.getDescription()
documentationVersion
(String documentationVersion) Sets the value ofCfnDeployment.StageDescriptionProperty.getDocumentationVersion()
loggingLevel
(String loggingLevel) Sets the value ofCfnDeployment.StageDescriptionProperty.getLoggingLevel()
methodSettings
(List<? extends Object> methodSettings) Sets the value ofCfnDeployment.StageDescriptionProperty.getMethodSettings()
methodSettings
(IResolvable methodSettings) Sets the value ofCfnDeployment.StageDescriptionProperty.getMethodSettings()
metricsEnabled
(Boolean metricsEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getMetricsEnabled()
metricsEnabled
(IResolvable metricsEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getMetricsEnabled()
Sets the value ofCfnDeployment.StageDescriptionProperty.getTags()
throttlingBurstLimit
(Number throttlingBurstLimit) Sets the value ofCfnDeployment.StageDescriptionProperty.getThrottlingBurstLimit()
throttlingRateLimit
(Number throttlingRateLimit) Sets the value ofCfnDeployment.StageDescriptionProperty.getThrottlingRateLimit()
tracingEnabled
(Boolean tracingEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getTracingEnabled()
tracingEnabled
(IResolvable tracingEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getTracingEnabled()
Sets the value ofCfnDeployment.StageDescriptionProperty.getVariables()
variables
(IResolvable variables) Sets the value ofCfnDeployment.StageDescriptionProperty.getVariables()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
accessLogSetting
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder accessLogSetting(IResolvable accessLogSetting) Sets the value ofCfnDeployment.StageDescriptionProperty.getAccessLogSetting()
- Parameters:
accessLogSetting
- Specifies settings for logging access in this stage.- Returns:
this
-
accessLogSetting
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder accessLogSetting(CfnDeployment.AccessLogSettingProperty accessLogSetting) Sets the value ofCfnDeployment.StageDescriptionProperty.getAccessLogSetting()
- Parameters:
accessLogSetting
- Specifies settings for logging access in this stage.- Returns:
this
-
cacheClusterEnabled
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder cacheClusterEnabled(Boolean cacheClusterEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getCacheClusterEnabled()
- Parameters:
cacheClusterEnabled
- Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, setCachingEnabled
totrue
for a method.- Returns:
this
-
cacheClusterEnabled
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder cacheClusterEnabled(IResolvable cacheClusterEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getCacheClusterEnabled()
- Parameters:
cacheClusterEnabled
- Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, setCachingEnabled
totrue
for a method.- Returns:
this
-
cacheClusterSize
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder cacheClusterSize(String cacheClusterSize) Sets the value ofCfnDeployment.StageDescriptionProperty.getCacheClusterSize()
- Parameters:
cacheClusterSize
- The size of the stage's cache cluster. For more information, see cacheClusterSize in the API Gateway API Reference .- Returns:
this
-
cacheDataEncrypted
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder cacheDataEncrypted(Boolean cacheDataEncrypted) Sets the value ofCfnDeployment.StageDescriptionProperty.getCacheDataEncrypted()
- Parameters:
cacheDataEncrypted
- Indicates whether the cached responses are encrypted.- Returns:
this
-
cacheDataEncrypted
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder cacheDataEncrypted(IResolvable cacheDataEncrypted) Sets the value ofCfnDeployment.StageDescriptionProperty.getCacheDataEncrypted()
- Parameters:
cacheDataEncrypted
- Indicates whether the cached responses are encrypted.- Returns:
this
-
cacheTtlInSeconds
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder cacheTtlInSeconds(Number cacheTtlInSeconds) Sets the value ofCfnDeployment.StageDescriptionProperty.getCacheTtlInSeconds()
- Parameters:
cacheTtlInSeconds
- The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.- Returns:
this
-
cachingEnabled
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder cachingEnabled(Boolean cachingEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getCachingEnabled()
- Parameters:
cachingEnabled
- Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance in the API Gateway Developer Guide .- Returns:
this
-
cachingEnabled
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder cachingEnabled(IResolvable cachingEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getCachingEnabled()
- Parameters:
cachingEnabled
- Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance in the API Gateway Developer Guide .- Returns:
this
-
canarySetting
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder canarySetting(IResolvable canarySetting) Sets the value ofCfnDeployment.StageDescriptionProperty.getCanarySetting()
- Parameters:
canarySetting
- Specifies settings for the canary deployment in this stage.- Returns:
this
-
canarySetting
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder canarySetting(CfnDeployment.CanarySettingProperty canarySetting) Sets the value ofCfnDeployment.StageDescriptionProperty.getCanarySetting()
- Parameters:
canarySetting
- Specifies settings for the canary deployment in this stage.- Returns:
this
-
clientCertificateId
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder clientCertificateId(String clientCertificateId) Sets the value ofCfnDeployment.StageDescriptionProperty.getClientCertificateId()
- Parameters:
clientCertificateId
- The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.- Returns:
this
-
dataTraceEnabled
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder dataTraceEnabled(Boolean dataTraceEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getDataTraceEnabled()
- Parameters:
dataTraceEnabled
- Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.- Returns:
this
-
dataTraceEnabled
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder dataTraceEnabled(IResolvable dataTraceEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getDataTraceEnabled()
- Parameters:
dataTraceEnabled
- Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.- Returns:
this
-
description
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder description(String description) Sets the value ofCfnDeployment.StageDescriptionProperty.getDescription()
- Parameters:
description
- A description of the purpose of the stage.- Returns:
this
-
documentationVersion
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder documentationVersion(String documentationVersion) Sets the value ofCfnDeployment.StageDescriptionProperty.getDocumentationVersion()
- Parameters:
documentationVersion
- The version identifier of the API documentation snapshot.- Returns:
this
-
loggingLevel
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder loggingLevel(String loggingLevel) Sets the value ofCfnDeployment.StageDescriptionProperty.getLoggingLevel()
- Parameters:
loggingLevel
- The logging level for this method. For valid values, see theloggingLevel
property of the MethodSetting resource in the Amazon API Gateway API Reference .- Returns:
this
-
methodSettings
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder methodSettings(IResolvable methodSettings) Sets the value ofCfnDeployment.StageDescriptionProperty.getMethodSettings()
- Parameters:
methodSettings
- Configures settings for all of the stage's methods.- Returns:
this
-
methodSettings
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder methodSettings(List<? extends Object> methodSettings) Sets the value ofCfnDeployment.StageDescriptionProperty.getMethodSettings()
- Parameters:
methodSettings
- Configures settings for all of the stage's methods.- Returns:
this
-
metricsEnabled
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder metricsEnabled(Boolean metricsEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getMetricsEnabled()
- Parameters:
metricsEnabled
- Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.- Returns:
this
-
metricsEnabled
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder metricsEnabled(IResolvable metricsEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getMetricsEnabled()
- Parameters:
metricsEnabled
- Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.- Returns:
this
-
tags
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder tags(List<? extends CfnTag> tags) Sets the value ofCfnDeployment.StageDescriptionProperty.getTags()
- Parameters:
tags
- An array of arbitrary tags (key-value pairs) to associate with the stage.- Returns:
this
-
throttlingBurstLimit
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder throttlingBurstLimit(Number throttlingBurstLimit) Sets the value ofCfnDeployment.StageDescriptionProperty.getThrottlingBurstLimit()
- Parameters:
throttlingBurstLimit
- The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide .- Returns:
this
-
throttlingRateLimit
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder throttlingRateLimit(Number throttlingRateLimit) Sets the value ofCfnDeployment.StageDescriptionProperty.getThrottlingRateLimit()
- Parameters:
throttlingRateLimit
- The target request steady-state rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide .- Returns:
this
-
tracingEnabled
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder tracingEnabled(Boolean tracingEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getTracingEnabled()
- Parameters:
tracingEnabled
- Specifies whether active tracing with X-ray is enabled for this stage. For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .- Returns:
this
-
tracingEnabled
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder tracingEnabled(IResolvable tracingEnabled) Sets the value ofCfnDeployment.StageDescriptionProperty.getTracingEnabled()
- Parameters:
tracingEnabled
- Specifies whether active tracing with X-ray is enabled for this stage. For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .- Returns:
this
-
variables
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder variables(IResolvable variables) Sets the value ofCfnDeployment.StageDescriptionProperty.getVariables()
- Parameters:
variables
- A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression:[A-Za-z0-9-._~:/?#&=,]+
.- Returns:
this
-
variables
@Stability(Stable) public CfnDeployment.StageDescriptionProperty.Builder variables(Map<String, String> variables) Sets the value ofCfnDeployment.StageDescriptionProperty.getVariables()
- Parameters:
variables
- A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the 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<CfnDeployment.StageDescriptionProperty>
- Returns:
- a new instance of
CfnDeployment.StageDescriptionProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-