Package software.amazon.awscdk.services.apigateway

Class MethodDeploymentOptions.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.MethodDeploymentOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<MethodDeploymentOptions>

Enclosing interface:

MethodDeploymentOptions

@Stability(Stable)
public static final class MethodDeploymentOptions.Builder
extends Object
implements software.amazon.jsii.Builder<MethodDeploymentOptions>

A builder for MethodDeploymentOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MethodDeploymentOptions	build()	Builds the configured instance.
MethodDeploymentOptions.Builder	cacheDataEncrypted(Boolean cacheDataEncrypted)	Sets the value of MethodDeploymentOptions.getCacheDataEncrypted()
MethodDeploymentOptions.Builder	cacheTtl(Duration cacheTtl)	Sets the value of MethodDeploymentOptions.getCacheTtl()
MethodDeploymentOptions.Builder	cachingEnabled(Boolean cachingEnabled)	Sets the value of MethodDeploymentOptions.getCachingEnabled()
MethodDeploymentOptions.Builder	dataTraceEnabled(Boolean dataTraceEnabled)	Sets the value of MethodDeploymentOptions.getDataTraceEnabled()
MethodDeploymentOptions.Builder	loggingLevel(MethodLoggingLevel loggingLevel)	Sets the value of MethodDeploymentOptions.getLoggingLevel()
MethodDeploymentOptions.Builder	metricsEnabled(Boolean metricsEnabled)	Sets the value of MethodDeploymentOptions.getMetricsEnabled()
MethodDeploymentOptions.Builder	throttlingBurstLimit(Number throttlingBurstLimit)	Sets the value of MethodDeploymentOptions.getThrottlingBurstLimit()
MethodDeploymentOptions.Builder	throttlingRateLimit(Number throttlingRateLimit)	Sets the value of MethodDeploymentOptions.getThrottlingRateLimit()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

cacheDataEncrypted

@Stability(Stable)
public MethodDeploymentOptions.Builder cacheDataEncrypted(Boolean cacheDataEncrypted)

Sets the value of MethodDeploymentOptions.getCacheDataEncrypted()

Parameters:

cacheDataEncrypted - Indicates whether the cached responses are encrypted.

Returns:

this

cacheTtl

@Stability(Stable)
public MethodDeploymentOptions.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

@Stability(Stable)
public MethodDeploymentOptions.Builder cachingEnabled(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

@Stability(Stable)
public MethodDeploymentOptions.Builder dataTraceEnabled(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

@Stability(Stable)
public MethodDeploymentOptions.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

@Stability(Stable)
public MethodDeploymentOptions.Builder metricsEnabled(Boolean metricsEnabled)

Sets the value of MethodDeploymentOptions.getMetricsEnabled()

Parameters:

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

Returns:

this

throttlingBurstLimit

@Stability(Stable)
public MethodDeploymentOptions.Builder throttlingBurstLimit(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

@Stability(Stable)
public MethodDeploymentOptions.Builder throttlingRateLimit(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

@Stability(Stable)
public MethodDeploymentOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<MethodDeploymentOptions>

Returns:

a new instance of MethodDeploymentOptions

Throws:

NullPointerException - if any required attribute was not provided