Class StageOptions.Builder
java.lang.Object
software.amazon.awscdk.services.apigateway.StageOptions.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<StageOptions>
- Enclosing interface:
StageOptions
@Stability(Stable)
public static final class StageOptions.Builder
extends Object
implements software.amazon.jsii.Builder<StageOptions>
A builder for
StageOptions
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaccessLogDestination
(IAccessLogDestination accessLogDestination) Sets the value ofStageOptions.getAccessLogDestination()
accessLogFormat
(AccessLogFormat accessLogFormat) Sets the value ofStageOptions.getAccessLogFormat()
build()
Builds the configured instance.cacheClusterEnabled
(Boolean cacheClusterEnabled) Sets the value ofStageOptions.getCacheClusterEnabled()
cacheClusterSize
(String cacheClusterSize) Sets the value ofStageOptions.getCacheClusterSize()
cacheDataEncrypted
(Boolean cacheDataEncrypted) Sets the value ofMethodDeploymentOptions.getCacheDataEncrypted()
Sets the value ofMethodDeploymentOptions.getCacheTtl()
cachingEnabled
(Boolean cachingEnabled) Sets the value ofMethodDeploymentOptions.getCachingEnabled()
clientCertificateId
(String clientCertificateId) Sets the value ofStageOptions.getClientCertificateId()
dataTraceEnabled
(Boolean dataTraceEnabled) Sets the value ofMethodDeploymentOptions.getDataTraceEnabled()
description
(String description) Sets the value ofStageOptions.getDescription()
documentationVersion
(String documentationVersion) Sets the value ofStageOptions.getDocumentationVersion()
loggingLevel
(MethodLoggingLevel loggingLevel) Sets the value ofMethodDeploymentOptions.getLoggingLevel()
methodOptions
(Map<String, ? extends MethodDeploymentOptions> methodOptions) Sets the value ofStageOptions.getMethodOptions()
metricsEnabled
(Boolean metricsEnabled) Sets the value ofMethodDeploymentOptions.getMetricsEnabled()
Sets the value ofStageOptions.getStageName()
throttlingBurstLimit
(Number throttlingBurstLimit) Sets the value ofMethodDeploymentOptions.getThrottlingBurstLimit()
throttlingRateLimit
(Number throttlingRateLimit) Sets the value ofMethodDeploymentOptions.getThrottlingRateLimit()
tracingEnabled
(Boolean tracingEnabled) Sets the value ofStageOptions.getTracingEnabled()
Sets the value ofStageOptions.getVariables()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
accessLogDestination
@Stability(Stable) public StageOptions.Builder accessLogDestination(IAccessLogDestination accessLogDestination) Sets the value ofStageOptions.getAccessLogDestination()
- Parameters:
accessLogDestination
- The CloudWatch Logs log group or Firehose delivery stream where to write access logs.- Returns:
this
-
accessLogFormat
Sets the value ofStageOptions.getAccessLogFormat()
- Parameters:
accessLogFormat
- A single line format of access logs of data, as specified by selected $content variables. The format must include eitherAccessLogFormat.contextRequestId()
orAccessLogFormat.contextExtendedRequestId()
.- Returns:
this
-
cacheClusterEnabled
Sets the value ofStageOptions.getCacheClusterEnabled()
- Parameters:
cacheClusterEnabled
- Indicates whether cache clustering is enabled for the stage.- Returns:
this
-
cacheClusterSize
Sets the value ofStageOptions.getCacheClusterSize()
- Parameters:
cacheClusterSize
- The stage's cache cluster size.- Returns:
this
-
clientCertificateId
Sets the value ofStageOptions.getClientCertificateId()
- Parameters:
clientCertificateId
- The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.- Returns:
this
-
description
Sets the value ofStageOptions.getDescription()
- Parameters:
description
- A description of the purpose of the stage.- Returns:
this
-
documentationVersion
Sets the value ofStageOptions.getDocumentationVersion()
- Parameters:
documentationVersion
- The version identifier of the API documentation snapshot.- Returns:
this
-
methodOptions
@Stability(Stable) public StageOptions.Builder methodOptions(Map<String, ? extends MethodDeploymentOptions> methodOptions) Sets the value ofStageOptions.getMethodOptions()
- Parameters:
methodOptions
- Method deployment options for specific resources/methods. These will override common options defined inStageOptions#methodOptions
.- Returns:
this
-
stageName
Sets the value ofStageOptions.getStageName()
- Parameters:
stageName
- The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).- Returns:
this
-
tracingEnabled
Sets the value ofStageOptions.getTracingEnabled()
- Parameters:
tracingEnabled
- Specifies whether Amazon X-Ray tracing is enabled for this method.- Returns:
this
-
variables
Sets the value ofStageOptions.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
-
cacheDataEncrypted
Sets the value ofMethodDeploymentOptions.getCacheDataEncrypted()
- Parameters:
cacheDataEncrypted
- Indicates whether the cached responses are encrypted.- Returns:
this
-
cacheTtl
Sets the value ofMethodDeploymentOptions.getCacheTtl()
- Parameters:
cacheTtl
- Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.- Returns:
this
-
cachingEnabled
Sets the value ofMethodDeploymentOptions.getCachingEnabled()
- Parameters:
cachingEnabled
- Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.- Returns:
this
-
dataTraceEnabled
Sets the value ofMethodDeploymentOptions.getDataTraceEnabled()
- Parameters:
dataTraceEnabled
- Specifies whether data trace logging is enabled for this method. When enabled, API gateway will log the full API requests and responses. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this feature for production APIs.- Returns:
this
-
loggingLevel
Sets the value ofMethodDeploymentOptions.getLoggingLevel()
- Parameters:
loggingLevel
- Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.- Returns:
this
-
metricsEnabled
Sets the value ofMethodDeploymentOptions.getMetricsEnabled()
- Parameters:
metricsEnabled
- Specifies whether Amazon CloudWatch metrics are enabled for this method.- Returns:
this
-
throttlingBurstLimit
Sets the value ofMethodDeploymentOptions.getThrottlingBurstLimit()
- Parameters:
throttlingBurstLimit
- Specifies the throttling burst limit. The total rate of all requests in your AWS account is limited to 5,000 requests.- Returns:
this
-
throttlingRateLimit
Sets the value ofMethodDeploymentOptions.getThrottlingRateLimit()
- Parameters:
throttlingRateLimit
- Specifies the throttling rate limit. The total rate of all requests in your AWS account is limited to 10,000 requests per second (rps).- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<StageOptions>
- Returns:
- a new instance of
StageOptions
- Throws:
NullPointerException
- if any required attribute was not provided
-