Package 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(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	Description
Builder()

Method Summary

Modifier and Type	Method	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 Details

Builder

public Builder()

Method Details

cacheDataEncrypted

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

Sets the value of CfnDeployment.MethodSettingProperty.getCacheDataEncrypted()

Parameters:

cacheDataEncrypted - Specifies whether the cached responses are encrypted.

Returns:

this

cacheDataEncrypted

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

Sets the value of CfnDeployment.MethodSettingProperty.getCacheDataEncrypted()

Parameters:

cacheDataEncrypted - Specifies whether the cached responses are encrypted.

Returns:

this

cacheTtlInSeconds

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

Sets the value of CfnDeployment.MethodSettingProperty.getCacheTtlInSeconds()

Parameters:

cacheTtlInSeconds - 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 CfnDeployment.MethodSettingProperty.Builder cachingEnabled(Boolean cachingEnabled)

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

cachingEnabled

@Stability(Stable)
public CfnDeployment.MethodSettingProperty.Builder cachingEnabled(IResolvable cachingEnabled)

Sets the value of CfnDeployment.MethodSettingProperty.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 CfnDeployment.MethodSettingProperty.Builder dataTraceEnabled(Boolean dataTraceEnabled)

Sets the value of CfnDeployment.MethodSettingProperty.getDataTraceEnabled()

Parameters:

dataTraceEnabled - Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.

Returns:

this

dataTraceEnabled

@Stability(Stable)
public CfnDeployment.MethodSettingProperty.Builder dataTraceEnabled(IResolvable dataTraceEnabled)

Sets the value of CfnDeployment.MethodSettingProperty.getDataTraceEnabled()

Parameters:

dataTraceEnabled - Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.

Returns:

this

httpMethod

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

Sets the value of CfnDeployment.MethodSettingProperty.getHttpMethod()

Parameters:

httpMethod - The HTTP method.

Returns:

this

loggingLevel

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

Sets the value of CfnDeployment.MethodSettingProperty.getLoggingLevel()

Parameters:

loggingLevel - Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF , ERROR , and INFO . Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

Returns:

this

metricsEnabled

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

Sets the value of CfnDeployment.MethodSettingProperty.getMetricsEnabled()

Parameters:

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

Returns:

this

metricsEnabled

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

Sets the value of CfnDeployment.MethodSettingProperty.getMetricsEnabled()

Parameters:

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

Returns:

this

resourcePath

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

Sets the value of CfnDeployment.MethodSettingProperty.getThrottlingBurstLimit()

Parameters:

throttlingBurstLimit - Specifies the throttling burst limit.

Returns:

this

throttlingRateLimit

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

Sets the value of CfnDeployment.MethodSettingProperty.getThrottlingRateLimit()

Parameters:

throttlingRateLimit - Specifies the throttling rate limit.

Returns:

this

build

@Stability(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