Class CfnDeployment.StageDescriptionProperty.Jsii$Proxy
- All Implemented Interfaces:
CfnDeployment.StageDescriptionProperty
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnDeployment.StageDescriptionProperty
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
ConstructorsModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theCfnDeployment.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 TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Object
Specifies settings for logging access in this stage.final Object
Specifies whether a cache cluster is enabled for the stage.final String
The size of the stage's cache cluster.final Object
Indicates whether the cached responses are encrypted.final Number
The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.final Object
Indicates whether responses are cached and returned for requests.final Object
Specifies settings for the canary deployment in this stage.final String
The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.final Object
Indicates whether data trace logging is enabled for methods in the stage.final String
A description of the purpose of the stage.final String
The version identifier of the API documentation snapshot.final String
The logging level for this method.final Object
Configures settings for all of the stage's methods.final Object
Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.getTags()
An array of arbitrary tags (key-value pairs) to associate with the stage.final Number
The target request burst rate limit.final Number
The target request steady-state rate limit.final Object
Specifies whether active tracing with X-ray is enabled for this stage.final Object
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
-
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
Constructor that initializes the object based on literal property values passed by theCfnDeployment.StageDescriptionProperty.Builder
.
-
-
Method Details
-
getAccessLogSetting
Description copied from interface:CfnDeployment.StageDescriptionProperty
Specifies settings for logging access in this stage.- Specified by:
getAccessLogSetting
in interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
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
totrue
for a method.- Specified by:
getCacheClusterEnabled
in interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
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 interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
getCacheDataEncrypted
Description copied from interface:CfnDeployment.StageDescriptionProperty
Indicates whether the cached responses are encrypted.- Specified by:
getCacheDataEncrypted
in interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
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 interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
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 interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
getCanarySetting
Description copied from interface:CfnDeployment.StageDescriptionProperty
Specifies settings for the canary deployment in this stage.- Specified by:
getCanarySetting
in interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
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 interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
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 interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
getDescription
Description copied from interface:CfnDeployment.StageDescriptionProperty
A description of the purpose of the stage.- Specified by:
getDescription
in interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
getDocumentationVersion
Description copied from interface:CfnDeployment.StageDescriptionProperty
The version identifier of the API documentation snapshot.- Specified by:
getDocumentationVersion
in interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
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 interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
getMethodSettings
Description copied from interface:CfnDeployment.StageDescriptionProperty
Configures settings for all of the stage's methods.- Specified by:
getMethodSettings
in interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
getMetricsEnabled
Description copied from interface:CfnDeployment.StageDescriptionProperty
Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.- Specified by:
getMetricsEnabled
in interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
getTags
Description copied from interface:CfnDeployment.StageDescriptionProperty
An array of arbitrary tags (key-value pairs) to associate with the stage.- Specified by:
getTags
in interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
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 interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
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 interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
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 interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
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 interfaceCfnDeployment.StageDescriptionProperty
- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-