software.amazon.awscdk.services.apigateway

Class CfnDeployment.StageDescriptionProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.CfnDeployment.StageDescriptionProperty.Jsii$Proxy

All Implemented Interfaces:

CfnDeployment.StageDescriptionProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDeployment.StageDescriptionProperty

@Stability(value=Stable)
 @Internal
public static final class CfnDeployment.StageDescriptionProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnDeployment.StageDescriptionProperty

An implementation for CfnDeployment.StageDescriptionProperty

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.CfnDeployment.StageDescriptionProperty

CfnDeployment.StageDescriptionProperty.Builder, CfnDeployment.StageDescriptionProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(CfnDeployment.StageDescriptionProperty.Builder builder) Constructor that initializes the object based on literal property values passed by the CfnDeployment.AccessLogSettingProperty.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 and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
Object	getAccessLogSetting() Specifies settings for logging access in this stage.
Object	getCacheClusterEnabled() Indicates whether cache clustering is enabled for the stage.
String	getCacheClusterSize() The size of the stage's cache cluster.
Object	getCacheDataEncrypted() Indicates whether the cached responses are encrypted.
Number	getCacheTtlInSeconds() The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
Object	getCachingEnabled() Indicates whether responses are cached and returned for requests.
Object	getCanarySetting() Specifies settings for the canary deployment in this stage.
String	getClientCertificateId() The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
Object	getDataTraceEnabled() Indicates whether data trace logging is enabled for methods in the stage.
String	getDescription() A description of the purpose of the stage.
String	getDocumentationVersion() The version identifier of the API documentation snapshot.
String	getLoggingLevel() The logging level for this method.
Object	getMethodSettings() Configures settings for all of the stage's methods.
Object	getMetricsEnabled() Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
List<CfnTag>	getTags() An array of arbitrary tags (key-value pairs) to associate with the stage.
Number	getThrottlingBurstLimit() The target request burst rate limit.
Number	getThrottlingRateLimit() The target request steady-state rate limit.
Object	getTracingEnabled() Specifies whether active tracing with X-ray is enabled for this stage.
Object	getVariables() A map that defines the stage variables.
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

Methods inherited from interface software.amazon.awscdk.services.apigateway.CfnDeployment.StageDescriptionProperty

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.

Jsii$Proxy

protected Jsii$Proxy(CfnDeployment.StageDescriptionProperty.Builder builder)

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

Method Detail

getAccessLogSetting

public final Object getAccessLogSetting()

Description copied from interface: CfnDeployment.StageDescriptionProperty

Specifies settings for logging access in this stage.

Specified by:

getAccessLogSetting in interface CfnDeployment.StageDescriptionProperty

getCacheClusterEnabled

public final Object getCacheClusterEnabled()

Description copied from interface: CfnDeployment.StageDescriptionProperty

Indicates whether cache clustering is enabled for the stage.

Specified by:

getCacheClusterEnabled in interface CfnDeployment.StageDescriptionProperty

getCacheClusterSize

public final String getCacheClusterSize()

Description copied from interface: CfnDeployment.StageDescriptionProperty

The size of the stage's cache cluster.

Specified by:

getCacheClusterSize in interface CfnDeployment.StageDescriptionProperty

getCacheDataEncrypted

public final Object getCacheDataEncrypted()

Description copied from interface: CfnDeployment.StageDescriptionProperty

Indicates whether the cached responses are encrypted.

Specified by:

getCacheDataEncrypted in interface CfnDeployment.StageDescriptionProperty

getCacheTtlInSeconds

public final Number getCacheTtlInSeconds()

Description copied from interface: CfnDeployment.StageDescriptionProperty

The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

Specified by:

getCacheTtlInSeconds in interface CfnDeployment.StageDescriptionProperty

getCachingEnabled

public final Object getCachingEnabled()

Description copied from interface: CfnDeployment.StageDescriptionProperty

Indicates whether responses are cached and returned for requests.

You must enable a cache cluster on the stage to cache responses. For more information, see Enable API Gateway Caching in a Stage to Enhance API Performance in the API Gateway Developer Guide .

Specified by:

getCachingEnabled in interface CfnDeployment.StageDescriptionProperty

getCanarySetting

public final Object getCanarySetting()

Description copied from interface: CfnDeployment.StageDescriptionProperty

Specifies settings for the canary deployment in this stage.

Specified by:

getCanarySetting in interface CfnDeployment.StageDescriptionProperty

getClientCertificateId

public final String getClientCertificateId()

Description copied from interface: CfnDeployment.StageDescriptionProperty

The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.

Specified by:

getClientCertificateId in interface CfnDeployment.StageDescriptionProperty

getDataTraceEnabled

public final Object getDataTraceEnabled()

Description copied from interface: CfnDeployment.StageDescriptionProperty

Indicates whether data trace logging is enabled for methods in the stage.

API Gateway pushes these logs to Amazon CloudWatch Logs.

Specified by:

getDataTraceEnabled in interface CfnDeployment.StageDescriptionProperty

getDescription

public final String getDescription()

Description copied from interface: CfnDeployment.StageDescriptionProperty

A description of the purpose of the stage.

Specified by:

getDescription in interface CfnDeployment.StageDescriptionProperty

getDocumentationVersion

public final String getDocumentationVersion()

Description copied from interface: CfnDeployment.StageDescriptionProperty

The version identifier of the API documentation snapshot.

Specified by:

getDocumentationVersion in interface CfnDeployment.StageDescriptionProperty

getLoggingLevel

public final String getLoggingLevel()

Description copied from interface: CfnDeployment.StageDescriptionProperty

The logging level for this method.

For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference .

Specified by:

getLoggingLevel in interface CfnDeployment.StageDescriptionProperty

getMethodSettings

public final Object getMethodSettings()

Description copied from interface: CfnDeployment.StageDescriptionProperty

Configures settings for all of the stage's methods.

Specified by:

getMethodSettings in interface CfnDeployment.StageDescriptionProperty

getMetricsEnabled

public final Object getMetricsEnabled()

Description copied from interface: CfnDeployment.StageDescriptionProperty

Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

Specified by:

getMetricsEnabled in interface CfnDeployment.StageDescriptionProperty

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnDeployment.StageDescriptionProperty

An array of arbitrary tags (key-value pairs) to associate with the stage.

Specified by:

getTags in interface CfnDeployment.StageDescriptionProperty

getThrottlingBurstLimit

public final Number getThrottlingBurstLimit()

Description copied from interface: CfnDeployment.StageDescriptionProperty

The target request burst rate limit.

This allows more requests through for a period of time than the target rate limit. For more information, see Manage API Request Throttling in the API Gateway Developer Guide .

Specified by:

getThrottlingBurstLimit in interface CfnDeployment.StageDescriptionProperty

getThrottlingRateLimit

public final Number getThrottlingRateLimit()

Description copied from interface: CfnDeployment.StageDescriptionProperty

The target request steady-state rate limit.

For more information, see Manage API Request Throttling in the API Gateway Developer Guide .

Specified by:

getThrottlingRateLimit in interface CfnDeployment.StageDescriptionProperty

getTracingEnabled

public final Object getTracingEnabled()

Description copied from interface: CfnDeployment.StageDescriptionProperty

Specifies whether active tracing with X-ray is enabled for this stage.

For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .

Specified by:

getTracingEnabled in interface CfnDeployment.StageDescriptionProperty

getVariables

public final Object getVariables()

Description copied from interface: CfnDeployment.StageDescriptionProperty

A map that defines the stage variables.

Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+ .

Specified by:

getVariables in interface CfnDeployment.StageDescriptionProperty

$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