software.amazon.awscdk.services.apigateway

Class StageOptions.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.StageOptions.Builder

Enclosing interface:

StageOptions

public static final class StageOptions.Builder
extends java.lang.Object

A builder for StageOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
StageOptions.Builder	accessLogDestination(IAccessLogDestination accessLogDestination) Sets the value of StageOptions.getAccessLogDestination()
StageOptions.Builder	accessLogFormat(AccessLogFormat accessLogFormat) Sets the value of StageOptions.getAccessLogFormat()
StageOptions	build() Builds the configured instance.
StageOptions.Builder	cacheClusterEnabled(java.lang.Boolean cacheClusterEnabled) Sets the value of StageOptions.getCacheClusterEnabled()
StageOptions.Builder	cacheClusterSize(java.lang.String cacheClusterSize) Sets the value of StageOptions.getCacheClusterSize()
StageOptions.Builder	cacheDataEncrypted(java.lang.Boolean cacheDataEncrypted) Sets the value of MethodDeploymentOptions.getCacheDataEncrypted()
StageOptions.Builder	cacheTtl(Duration cacheTtl) Sets the value of MethodDeploymentOptions.getCacheTtl()
StageOptions.Builder	cachingEnabled(java.lang.Boolean cachingEnabled) Sets the value of MethodDeploymentOptions.getCachingEnabled()
StageOptions.Builder	clientCertificateId(java.lang.String clientCertificateId) Sets the value of StageOptions.getClientCertificateId()
StageOptions.Builder	dataTraceEnabled(java.lang.Boolean dataTraceEnabled) Sets the value of MethodDeploymentOptions.getDataTraceEnabled()
StageOptions.Builder	description(java.lang.String description) Sets the value of StageOptions.getDescription()
StageOptions.Builder	documentationVersion(java.lang.String documentationVersion) Sets the value of StageOptions.getDocumentationVersion()
StageOptions.Builder	loggingLevel(MethodLoggingLevel loggingLevel) Sets the value of MethodDeploymentOptions.getLoggingLevel()
StageOptions.Builder	methodOptions(java.util.Map<java.lang.String,? extends MethodDeploymentOptions> methodOptions) Sets the value of StageOptions.getMethodOptions()
StageOptions.Builder	metricsEnabled(java.lang.Boolean metricsEnabled) Sets the value of MethodDeploymentOptions.getMetricsEnabled()
StageOptions.Builder	stageName(java.lang.String stageName) Sets the value of StageOptions.getStageName()
StageOptions.Builder	throttlingBurstLimit(java.lang.Number throttlingBurstLimit) Sets the value of MethodDeploymentOptions.getThrottlingBurstLimit()
StageOptions.Builder	throttlingRateLimit(java.lang.Number throttlingRateLimit) Sets the value of MethodDeploymentOptions.getThrottlingRateLimit()
StageOptions.Builder	tracingEnabled(java.lang.Boolean tracingEnabled) Sets the value of StageOptions.getTracingEnabled()
StageOptions.Builder	variables(java.util.Map<java.lang.String,java.lang.String> variables) Sets the value of StageOptions.getVariables()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

accessLogDestination

public StageOptions.Builder accessLogDestination(IAccessLogDestination accessLogDestination)

Sets the value of StageOptions.getAccessLogDestination()

Parameters:

accessLogDestination - The CloudWatch Logs log group.

Returns:

this

accessLogFormat

public StageOptions.Builder accessLogFormat(AccessLogFormat accessLogFormat)

Sets the value of StageOptions.getAccessLogFormat()

Parameters:

accessLogFormat - A single line format of access logs of data, as specified by selected $content variables. The format must include at least AccessLogFormat.contextRequestId().

Returns:

this

cacheClusterEnabled

public StageOptions.Builder cacheClusterEnabled(java.lang.Boolean cacheClusterEnabled)

Sets the value of StageOptions.getCacheClusterEnabled()

Parameters:

cacheClusterEnabled - Indicates whether cache clustering is enabled for the stage.

Returns:

this

cacheClusterSize

public StageOptions.Builder cacheClusterSize(java.lang.String cacheClusterSize)

Sets the value of StageOptions.getCacheClusterSize()

Parameters:

cacheClusterSize - The stage's cache cluster size.

Returns:

this

clientCertificateId

public StageOptions.Builder clientCertificateId(java.lang.String clientCertificateId)

Sets the value of StageOptions.getClientCertificateId()

Parameters:

clientCertificateId - The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.

Returns:

this

description

public StageOptions.Builder description(java.lang.String description)

Sets the value of StageOptions.getDescription()

Parameters:

description - A description of the purpose of the stage.

Returns:

this

documentationVersion

public StageOptions.Builder documentationVersion(java.lang.String documentationVersion)

Sets the value of StageOptions.getDocumentationVersion()

Parameters:

documentationVersion - The version identifier of the API documentation snapshot.

Returns:

this

methodOptions

public StageOptions.Builder methodOptions(java.util.Map<java.lang.String,? extends MethodDeploymentOptions> methodOptions)

Sets the value of StageOptions.getMethodOptions()

Parameters:

methodOptions - Method deployment options for specific resources/methods. These will override common options defined in StageOptions#methodOptions.

Returns:

this

stageName

public StageOptions.Builder stageName(java.lang.String stageName)

Sets the value of StageOptions.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

public StageOptions.Builder tracingEnabled(java.lang.Boolean tracingEnabled)

Sets the value of StageOptions.getTracingEnabled()

Parameters:

tracingEnabled - Specifies whether Amazon X-Ray tracing is enabled for this method.

Returns:

this

variables

public StageOptions.Builder variables(java.util.Map<java.lang.String,java.lang.String> variables)

Sets the value of StageOptions.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

public StageOptions.Builder cacheDataEncrypted(java.lang.Boolean cacheDataEncrypted)

Sets the value of MethodDeploymentOptions.getCacheDataEncrypted()

Parameters:

cacheDataEncrypted - Indicates whether the cached responses are encrypted.

Returns:

this

cacheTtl

public StageOptions.Builder cacheTtl(Duration cacheTtl)

Sets the value of MethodDeploymentOptions.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

public StageOptions.Builder cachingEnabled(java.lang.Boolean cachingEnabled)

Sets the value of MethodDeploymentOptions.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

public StageOptions.Builder dataTraceEnabled(java.lang.Boolean dataTraceEnabled)

Sets the value of MethodDeploymentOptions.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

public StageOptions.Builder loggingLevel(MethodLoggingLevel loggingLevel)

Sets the value of MethodDeploymentOptions.getLoggingLevel()

Parameters:

loggingLevel - Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.

Returns:

this

metricsEnabled

public StageOptions.Builder metricsEnabled(java.lang.Boolean metricsEnabled)

Sets the value of MethodDeploymentOptions.getMetricsEnabled()

Parameters:

metricsEnabled - Specifies whether Amazon CloudWatch metrics are enabled for this method.

Returns:

this

throttlingBurstLimit

public StageOptions.Builder throttlingBurstLimit(java.lang.Number throttlingBurstLimit)

Sets the value of MethodDeploymentOptions.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

public StageOptions.Builder throttlingRateLimit(java.lang.Number throttlingRateLimit)

Sets the value of MethodDeploymentOptions.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

public StageOptions build()

Builds the configured instance.

Returns:

a new instance of StageOptions

Throws:

java.lang.NullPointerException - if any required attribute was not provided