Package software.amazon.awscdk.services.apigateway

Class CfnStage.MethodSettingProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.CfnStage.MethodSettingProperty.Jsii$Proxy

All Implemented Interfaces:

CfnStage.MethodSettingProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnStage.MethodSettingProperty

@Stability(Stable)
@Internal
public static final class CfnStage.MethodSettingProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnStage.MethodSettingProperty

An implementation for CfnStage.MethodSettingProperty

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.CfnStage.MethodSettingProperty

CfnStage.MethodSettingProperty.Builder, CfnStage.MethodSettingProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnStage.MethodSettingProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnStage.MethodSettingProperty.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 Object	getCacheDataEncrypted()	Specifies whether the cached responses are encrypted.
final Number	getCacheTtlInSeconds()	Specifies the time to live (TTL), in seconds, for cached responses.
final Object	getCachingEnabled()	Specifies whether responses should be cached and returned for requests.
final Object	getDataTraceEnabled()	Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
final String	getHttpMethod()	The HTTP method.
final String	getLoggingLevel()	Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
final Object	getMetricsEnabled()	Specifies whether Amazon CloudWatch metrics are enabled for this method.
final String	getResourcePath()	The resource path 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(CfnStage.MethodSettingProperty.Builder builder)

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

Method Details

getCacheDataEncrypted

public final Object getCacheDataEncrypted()

Description copied from interface: CfnStage.MethodSettingProperty

Specifies whether the cached responses are encrypted.

Specified by:

getCacheDataEncrypted in interface CfnStage.MethodSettingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachedataencrypted

getCacheTtlInSeconds

public final Number getCacheTtlInSeconds()

Description copied from interface: CfnStage.MethodSettingProperty

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

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

Specified by:

getCacheTtlInSeconds in interface CfnStage.MethodSettingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachettlinseconds

getCachingEnabled

public final Object getCachingEnabled()

Description copied from interface: CfnStage.MethodSettingProperty

Specifies whether responses should be cached and returned for requests.

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

Specified by:

getCachingEnabled in interface CfnStage.MethodSettingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachingenabled

getDataTraceEnabled

public final Object getDataTraceEnabled()

Description copied from interface: CfnStage.MethodSettingProperty

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.

Specified by:

getDataTraceEnabled in interface CfnStage.MethodSettingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-datatraceenabled

getHttpMethod

public final String getHttpMethod()

Description copied from interface: CfnStage.MethodSettingProperty

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 .

Specified by:

getHttpMethod in interface CfnStage.MethodSettingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-httpmethod

getLoggingLevel

public final String getLoggingLevel()

Description copied from interface: CfnStage.MethodSettingProperty

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.

Specified by:

getLoggingLevel in interface CfnStage.MethodSettingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-logginglevel

getMetricsEnabled

public final Object getMetricsEnabled()

Description copied from interface: CfnStage.MethodSettingProperty

Specifies whether Amazon CloudWatch metrics are enabled for this method.

Specified by:

getMetricsEnabled in interface CfnStage.MethodSettingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-metricsenabled

getResourcePath

public final String getResourcePath()

Description copied from interface: CfnStage.MethodSettingProperty

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 .

Specified by:

getResourcePath in interface CfnStage.MethodSettingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-resourcepath

getThrottlingBurstLimit

public final Number getThrottlingBurstLimit()

Description copied from interface: CfnStage.MethodSettingProperty

Specifies the throttling burst limit.

Specified by:

getThrottlingBurstLimit in interface CfnStage.MethodSettingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingburstlimit

getThrottlingRateLimit

public final Number getThrottlingRateLimit()

Description copied from interface: CfnStage.MethodSettingProperty

Specifies the throttling rate limit.

Specified by:

getThrottlingRateLimit in interface CfnStage.MethodSettingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingratelimit

$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