software.amazon.awscdk.services.apigateway

Class MethodDeploymentOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.MethodDeploymentOptions.Jsii$Proxy

All Implemented Interfaces:

MethodDeploymentOptions

Enclosing interface:

MethodDeploymentOptions

public static final class MethodDeploymentOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements MethodDeploymentOptions

An implementation for MethodDeploymentOptions

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.MethodDeploymentOptions

MethodDeploymentOptions.Builder, MethodDeploymentOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(java.lang.Object o)
java.lang.Boolean	getCacheDataEncrypted() Indicates whether the cached responses are encrypted.
Duration	getCacheTtl() Specifies the time to live (TTL), in seconds, for cached responses.
java.lang.Boolean	getCachingEnabled() Specifies whether responses should be cached and returned for requests.
java.lang.Boolean	getDataTraceEnabled() Specifies whether data trace logging is enabled for this method.
MethodLoggingLevel	getLoggingLevel() Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
java.lang.Boolean	getMetricsEnabled() Specifies whether Amazon CloudWatch metrics are enabled for this method.
java.lang.Number	getThrottlingBurstLimit() Specifies the throttling burst limit.
java.lang.Number	getThrottlingRateLimit() Specifies the throttling rate limit.
int	hashCode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.services.apigateway.MethodDeploymentOptions

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Method Detail

getCacheDataEncrypted

public final java.lang.Boolean getCacheDataEncrypted()

Description copied from interface: MethodDeploymentOptions

Indicates whether the cached responses are encrypted.

Default: false

Specified by:

getCacheDataEncrypted in interface MethodDeploymentOptions

getCacheTtl

public final Duration getCacheTtl()

Description copied from interface: MethodDeploymentOptions

Specifies the time to live (TTL), in seconds, for cached responses.

The higher the TTL, the longer the response will be cached.

Default: Duration.minutes(5)

Specified by:

getCacheTtl in interface MethodDeploymentOptions

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html

getCachingEnabled

public final java.lang.Boolean getCachingEnabled()

Description copied from interface: MethodDeploymentOptions

Specifies whether responses should be cached and returned for requests.

A cache cluster must be enabled on the stage for responses to be cached.

Default: - Caching is Disabled.

Specified by:

getCachingEnabled in interface MethodDeploymentOptions

getDataTraceEnabled

public final java.lang.Boolean getDataTraceEnabled()

Description copied from interface: MethodDeploymentOptions

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.

Default: false

Specified by:

getDataTraceEnabled in interface MethodDeploymentOptions

getLoggingLevel

public final MethodLoggingLevel getLoggingLevel()

Description copied from interface: MethodDeploymentOptions

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

Default: - Off

Specified by:

getLoggingLevel in interface MethodDeploymentOptions

getMetricsEnabled

public final java.lang.Boolean getMetricsEnabled()

Description copied from interface: MethodDeploymentOptions

Specifies whether Amazon CloudWatch metrics are enabled for this method.

Default: false

Specified by:

getMetricsEnabled in interface MethodDeploymentOptions

getThrottlingBurstLimit

public final java.lang.Number getThrottlingBurstLimit()

Description copied from interface: MethodDeploymentOptions

Specifies the throttling burst limit.

The total rate of all requests in your AWS account is limited to 5,000 requests.

Default: - No additional restriction.

Specified by:

getThrottlingBurstLimit in interface MethodDeploymentOptions

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html

getThrottlingRateLimit

public final java.lang.Number getThrottlingRateLimit()

Description copied from interface: MethodDeploymentOptions

Specifies the throttling rate limit.

The total rate of all requests in your AWS account is limited to 10,000 requests per second (rps).

Default: - No additional restriction.

Specified by:

getThrottlingRateLimit in interface MethodDeploymentOptions

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html

$jsii$toJson

public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

equals

public final boolean equals(java.lang.Object o)

hashCode

public final int hashCode()