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

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

Method Details

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-accesslogsetting

getCacheClusterEnabled

public final Object getCacheClusterEnabled()

Description copied from interface: CfnDeployment.StageDescriptionProperty

Specifies whether a cache cluster is enabled for the stage.

To activate a method-level cache, set CachingEnabled to true for a method.

Specified by:

getCacheClusterEnabled in interface CfnDeployment.StageDescriptionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclusterenabled

getCacheClusterSize

public final String getCacheClusterSize()

Description copied from interface: CfnDeployment.StageDescriptionProperty

The size of the stage's cache cluster.

For more information, see cacheClusterSize in the API Gateway API Reference .

Specified by:

getCacheClusterSize in interface CfnDeployment.StageDescriptionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclustersize

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

See Also:

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

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

See Also:

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

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

See Also:

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-canarysetting

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-clientcertificateid

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

See Also:

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-description

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-documentationversion

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 MethodSetting resource in the Amazon API Gateway API Reference .

Specified by:

getLoggingLevel in interface CfnDeployment.StageDescriptionProperty

See Also:

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-methodsettings

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

See Also:

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-tags

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

See Also:

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

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

See Also:

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-tracingenabled

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-variables

$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