Package 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, software.amazon.jsii.JsiiSerializable

Enclosing interface:

MethodDeploymentOptions

@Stability(Stable)
@Internal
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

MethodDeploymentOptions.Builder, MethodDeploymentOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(MethodDeploymentOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the MethodDeploymentOptions.Builder.
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	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Boolean	getCacheDataEncrypted()	Indicates whether the cached responses are encrypted.
final Duration	getCacheTtl()	Specifies the time to live (TTL), in seconds, for cached responses.
final Boolean	getCachingEnabled()	Specifies whether responses should be cached and returned for requests.
final Boolean	getDataTraceEnabled()	Specifies whether data trace logging is enabled for this method.
final MethodLoggingLevel	getLoggingLevel()	Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
final Boolean	getMetricsEnabled()	Specifies whether Amazon CloudWatch metrics are enabled for this method.
final Number	getThrottlingBurstLimit()	Specifies the throttling burst limit.
final Number	getThrottlingRateLimit()	Specifies the throttling rate limit.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

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.

Jsii$Proxy

protected Jsii$Proxy(MethodDeploymentOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the MethodDeploymentOptions.Builder.

Method Details

getCacheDataEncrypted

public final 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 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 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 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 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 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

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

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object