software.amazon.awscdk.services.apigateway

Class CfnDeployment.MethodSettingProperty.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnDeployment.MethodSettingProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDeployment.MethodSettingProperty>

Enclosing interface:

CfnDeployment.MethodSettingProperty

@Stability(value=Stable)
public static final class CfnDeployment.MethodSettingProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDeployment.MethodSettingProperty>

A builder for CfnDeployment.MethodSettingProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnDeployment.MethodSettingProperty	build() Builds the configured instance.
CfnDeployment.MethodSettingProperty.Builder	cacheDataEncrypted(Boolean cacheDataEncrypted) Sets the value of CfnDeployment.MethodSettingProperty.getCacheDataEncrypted()
CfnDeployment.MethodSettingProperty.Builder	cacheDataEncrypted(IResolvable cacheDataEncrypted) Sets the value of CfnDeployment.MethodSettingProperty.getCacheDataEncrypted()
CfnDeployment.MethodSettingProperty.Builder	cacheTtlInSeconds(Number cacheTtlInSeconds) Sets the value of CfnDeployment.MethodSettingProperty.getCacheTtlInSeconds()
CfnDeployment.MethodSettingProperty.Builder	cachingEnabled(Boolean cachingEnabled) Sets the value of CfnDeployment.MethodSettingProperty.getCachingEnabled()
CfnDeployment.MethodSettingProperty.Builder	cachingEnabled(IResolvable cachingEnabled) Sets the value of CfnDeployment.MethodSettingProperty.getCachingEnabled()
CfnDeployment.MethodSettingProperty.Builder	dataTraceEnabled(Boolean dataTraceEnabled) Sets the value of CfnDeployment.MethodSettingProperty.getDataTraceEnabled()
CfnDeployment.MethodSettingProperty.Builder	dataTraceEnabled(IResolvable dataTraceEnabled) Sets the value of CfnDeployment.MethodSettingProperty.getDataTraceEnabled()
CfnDeployment.MethodSettingProperty.Builder	httpMethod(String httpMethod) Sets the value of CfnDeployment.MethodSettingProperty.getHttpMethod()
CfnDeployment.MethodSettingProperty.Builder	loggingLevel(String loggingLevel) Sets the value of CfnDeployment.MethodSettingProperty.getLoggingLevel()
CfnDeployment.MethodSettingProperty.Builder	metricsEnabled(Boolean metricsEnabled) Sets the value of CfnDeployment.MethodSettingProperty.getMetricsEnabled()
CfnDeployment.MethodSettingProperty.Builder	metricsEnabled(IResolvable metricsEnabled) Sets the value of CfnDeployment.MethodSettingProperty.getMetricsEnabled()
CfnDeployment.MethodSettingProperty.Builder	resourcePath(String resourcePath) Sets the value of CfnDeployment.MethodSettingProperty.getResourcePath()
CfnDeployment.MethodSettingProperty.Builder	throttlingBurstLimit(Number throttlingBurstLimit) Sets the value of CfnDeployment.MethodSettingProperty.getThrottlingBurstLimit()
CfnDeployment.MethodSettingProperty.Builder	throttlingRateLimit(Number throttlingRateLimit) Sets the value of CfnDeployment.MethodSettingProperty.getThrottlingRateLimit()

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

cacheDataEncrypted

@Stability(value=Stable)
public CfnDeployment.MethodSettingProperty.Builder cacheDataEncrypted(Boolean cacheDataEncrypted)

Sets the value of CfnDeployment.MethodSettingProperty.getCacheDataEncrypted()

Parameters:

cacheDataEncrypted - Indicates whether the cached responses are encrypted.

Returns:

this

cacheDataEncrypted

@Stability(value=Stable)
public CfnDeployment.MethodSettingProperty.Builder cacheDataEncrypted(IResolvable cacheDataEncrypted)

Sets the value of CfnDeployment.MethodSettingProperty.getCacheDataEncrypted()

Parameters:

cacheDataEncrypted - Indicates whether the cached responses are encrypted.

Returns:

this

cacheTtlInSeconds

@Stability(value=Stable)
public CfnDeployment.MethodSettingProperty.Builder cacheTtlInSeconds(Number cacheTtlInSeconds)

Sets the value of CfnDeployment.MethodSettingProperty.getCacheTtlInSeconds()

Parameters:

cacheTtlInSeconds - The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

Returns:

this

cachingEnabled

@Stability(value=Stable)
public CfnDeployment.MethodSettingProperty.Builder cachingEnabled(Boolean cachingEnabled)

Sets the value of CfnDeployment.MethodSettingProperty.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(value=Stable)
public CfnDeployment.MethodSettingProperty.Builder cachingEnabled(IResolvable cachingEnabled)

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

dataTraceEnabled

@Stability(value=Stable)
public CfnDeployment.MethodSettingProperty.Builder dataTraceEnabled(Boolean dataTraceEnabled)

Sets the value of CfnDeployment.MethodSettingProperty.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(value=Stable)
public CfnDeployment.MethodSettingProperty.Builder dataTraceEnabled(IResolvable dataTraceEnabled)

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

httpMethod

@Stability(value=Stable)
public CfnDeployment.MethodSettingProperty.Builder httpMethod(String httpMethod)

Sets the value of CfnDeployment.MethodSettingProperty.getHttpMethod()

Parameters:

httpMethod - The HTTP method.

Returns:

this

loggingLevel

@Stability(value=Stable)
public CfnDeployment.MethodSettingProperty.Builder loggingLevel(String loggingLevel)

Sets the value of CfnDeployment.MethodSettingProperty.getLoggingLevel()

Parameters:

loggingLevel - The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference .

Returns:

this

metricsEnabled

@Stability(value=Stable)
public CfnDeployment.MethodSettingProperty.Builder metricsEnabled(Boolean metricsEnabled)

Sets the value of CfnDeployment.MethodSettingProperty.getMetricsEnabled()

Parameters:

metricsEnabled - Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

Returns:

this

metricsEnabled

@Stability(value=Stable)
public CfnDeployment.MethodSettingProperty.Builder metricsEnabled(IResolvable metricsEnabled)

Sets the value of CfnDeployment.MethodSettingProperty.getMetricsEnabled()

Parameters:

metricsEnabled - Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

Returns:

this

resourcePath

@Stability(value=Stable)
public CfnDeployment.MethodSettingProperty.Builder resourcePath(String resourcePath)

Sets the value of CfnDeployment.MethodSettingProperty.getResourcePath()

Parameters:

resourcePath - The resource path for this method. Forward slashes ( / ) are encoded as ~1 and the initial slash must include a forward slash. For example, the path value /resource/subresource must be encoded as /~1resource~1subresource . To specify the root path, use only a slash ( / ).

Returns:

this

throttlingBurstLimit

@Stability(value=Stable)
public CfnDeployment.MethodSettingProperty.Builder throttlingBurstLimit(Number throttlingBurstLimit)

Sets the value of CfnDeployment.MethodSettingProperty.getThrottlingBurstLimit()

Parameters:

throttlingBurstLimit - The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account . For more information, see Manage API Request Throttling in the API Gateway Developer Guide .

Returns:

this

throttlingRateLimit

@Stability(value=Stable)
public CfnDeployment.MethodSettingProperty.Builder throttlingRateLimit(Number throttlingRateLimit)

Sets the value of CfnDeployment.MethodSettingProperty.getThrottlingRateLimit()

Parameters:

throttlingRateLimit - The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account . For more information, see Manage API Request Throttling in the API Gateway Developer Guide .

Returns:

this

build

@Stability(value=Stable)
public CfnDeployment.MethodSettingProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDeployment.MethodSettingProperty>

Returns:

a new instance of CfnDeployment.MethodSettingProperty

Throws:

NullPointerException - if any required attribute was not provided