Package software.amazon.awscdk.services.apigateway

Class CfnStage.MethodSettingProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnStage.MethodSettingProperty

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

A builder for CfnStage.MethodSettingProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnStage.MethodSettingProperty	build()	Builds the configured instance.
CfnStage.MethodSettingProperty.Builder	cacheDataEncrypted(Boolean cacheDataEncrypted)	Sets the value of CfnStage.MethodSettingProperty.getCacheDataEncrypted()
CfnStage.MethodSettingProperty.Builder	cacheDataEncrypted(IResolvable cacheDataEncrypted)	Sets the value of CfnStage.MethodSettingProperty.getCacheDataEncrypted()
CfnStage.MethodSettingProperty.Builder	cacheTtlInSeconds(Number cacheTtlInSeconds)	Sets the value of CfnStage.MethodSettingProperty.getCacheTtlInSeconds()
CfnStage.MethodSettingProperty.Builder	cachingEnabled(Boolean cachingEnabled)	Sets the value of CfnStage.MethodSettingProperty.getCachingEnabled()
CfnStage.MethodSettingProperty.Builder	cachingEnabled(IResolvable cachingEnabled)	Sets the value of CfnStage.MethodSettingProperty.getCachingEnabled()
CfnStage.MethodSettingProperty.Builder	dataTraceEnabled(Boolean dataTraceEnabled)	Sets the value of CfnStage.MethodSettingProperty.getDataTraceEnabled()
CfnStage.MethodSettingProperty.Builder	dataTraceEnabled(IResolvable dataTraceEnabled)	Sets the value of CfnStage.MethodSettingProperty.getDataTraceEnabled()
CfnStage.MethodSettingProperty.Builder	httpMethod(String httpMethod)	Sets the value of CfnStage.MethodSettingProperty.getHttpMethod()
CfnStage.MethodSettingProperty.Builder	loggingLevel(String loggingLevel)	Sets the value of CfnStage.MethodSettingProperty.getLoggingLevel()
CfnStage.MethodSettingProperty.Builder	metricsEnabled(Boolean metricsEnabled)	Sets the value of CfnStage.MethodSettingProperty.getMetricsEnabled()
CfnStage.MethodSettingProperty.Builder	metricsEnabled(IResolvable metricsEnabled)	Sets the value of CfnStage.MethodSettingProperty.getMetricsEnabled()
CfnStage.MethodSettingProperty.Builder	resourcePath(String resourcePath)	Sets the value of CfnStage.MethodSettingProperty.getResourcePath()
CfnStage.MethodSettingProperty.Builder	throttlingBurstLimit(Number throttlingBurstLimit)	Sets the value of CfnStage.MethodSettingProperty.getThrottlingBurstLimit()
CfnStage.MethodSettingProperty.Builder	throttlingRateLimit(Number throttlingRateLimit)	Sets the value of CfnStage.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 CfnStage.MethodSettingProperty.Builder cacheDataEncrypted(Boolean cacheDataEncrypted)

Sets the value of CfnStage.MethodSettingProperty.getCacheDataEncrypted()

Parameters:

cacheDataEncrypted - Specifies whether the cached responses are encrypted.

Returns:

this

cacheDataEncrypted

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

Sets the value of CfnStage.MethodSettingProperty.getCacheDataEncrypted()

Parameters:

cacheDataEncrypted - Specifies whether the cached responses are encrypted.

Returns:

this

cacheTtlInSeconds

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

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

Sets the value of CfnStage.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 CfnStage.MethodSettingProperty.Builder cachingEnabled(IResolvable cachingEnabled)

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

Sets the value of CfnStage.MethodSettingProperty.getDataTraceEnabled()

Parameters:

dataTraceEnabled - Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.

Returns:

this

dataTraceEnabled

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

Sets the value of CfnStage.MethodSettingProperty.getDataTraceEnabled()

Parameters:

dataTraceEnabled - Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.

Returns:

this

httpMethod

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

Sets the value of CfnStage.MethodSettingProperty.getHttpMethod()

Parameters:

httpMethod - The HTTP method. To apply settings to multiple resources and methods, specify an asterisk ( * ) for the HttpMethod and /* for the ResourcePath . This parameter is required when you specify a MethodSetting .

Returns:

this

loggingLevel

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

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

Sets the value of CfnStage.MethodSettingProperty.getMetricsEnabled()

Parameters:

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

Returns:

this

metricsEnabled

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

Sets the value of CfnStage.MethodSettingProperty.getMetricsEnabled()

Parameters:

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

Returns:

this

resourcePath

@Stability(Stable)
public CfnStage.MethodSettingProperty.Builder resourcePath(String resourcePath)

Sets the value of CfnStage.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 ( / ). To apply settings to multiple resources and methods, specify an asterisk ( * ) for the HttpMethod and /* for the ResourcePath . This parameter is required when you specify a MethodSetting .

Returns:

this

throttlingBurstLimit

@Stability(Stable)
public CfnStage.MethodSettingProperty.Builder throttlingBurstLimit(Number throttlingBurstLimit)

Sets the value of CfnStage.MethodSettingProperty.getThrottlingBurstLimit()

Parameters:

throttlingBurstLimit - Specifies the throttling burst limit.

Returns:

this

throttlingRateLimit

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

Sets the value of CfnStage.MethodSettingProperty.getThrottlingRateLimit()

Parameters:

throttlingRateLimit - Specifies the throttling rate limit.

Returns:

this

build

@Stability(Stable)
public CfnStage.MethodSettingProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnStage.MethodSettingProperty

Throws:

NullPointerException - if any required attribute was not provided