public static final class StageOptions.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements StageOptions
StageOptions
StageOptions.Builder, StageOptions.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
Modifier and Type | Method and Description |
---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(java.lang.Object o) |
IAccessLogDestination |
getAccessLogDestination()
The CloudWatch Logs log group.
|
AccessLogFormat |
getAccessLogFormat()
A single line format of access logs of data, as specified by selected $content variables.
|
java.lang.Boolean |
getCacheClusterEnabled()
Indicates whether cache clustering is enabled for the stage.
|
java.lang.String |
getCacheClusterSize()
The stage's cache cluster size.
|
java.lang.Boolean |
getCacheDataEncrypted()
Indicates whether the cached responses are encrypted.
|
Duration |
getCacheTtl()
Specifies the time to live (TTL), in seconds, for cached responses.
|
java.lang.Boolean |
getCachingEnabled()
Specifies whether responses should be cached and returned for requests.
|
java.lang.String |
getClientCertificateId()
The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
|
java.lang.Boolean |
getDataTraceEnabled()
Specifies whether data trace logging is enabled for this method.
|
java.lang.String |
getDescription()
A description of the purpose of the stage.
|
java.lang.String |
getDocumentationVersion()
The version identifier of the API documentation snapshot.
|
MethodLoggingLevel |
getLoggingLevel()
Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
|
java.util.Map<java.lang.String,MethodDeploymentOptions> |
getMethodOptions()
Method deployment options for specific resources/methods.
|
java.lang.Boolean |
getMetricsEnabled()
Specifies whether Amazon CloudWatch metrics are enabled for this method.
|
java.lang.String |
getStageName()
The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
|
java.lang.Number |
getThrottlingBurstLimit()
Specifies the throttling burst limit.
|
java.lang.Number |
getThrottlingRateLimit()
Specifies the throttling rate limit.
|
java.lang.Boolean |
getTracingEnabled()
Specifies whether Amazon X-Ray tracing is enabled for this method.
|
java.util.Map<java.lang.String,java.lang.String> |
getVariables()
A map that defines the stage variables.
|
int |
hashCode() |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
builder
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef
- Reference to the JSII managed object.public final IAccessLogDestination getAccessLogDestination()
StageOptions
Default: - No destination
getAccessLogDestination
in interface StageOptions
public final AccessLogFormat getAccessLogFormat()
StageOptions
The format must include at least AccessLogFormat.contextRequestId()
.
Default: - Common Log Format
public final java.lang.Boolean getCacheClusterEnabled()
StageOptions
Default: - Disabled for the stage.
getCacheClusterEnabled
in interface StageOptions
public final java.lang.String getCacheClusterSize()
StageOptions
Default: 0.5
getCacheClusterSize
in interface StageOptions
public final java.lang.String getClientCertificateId()
StageOptions
Default: - None.
getClientCertificateId
in interface StageOptions
public final java.lang.String getDescription()
StageOptions
Default: - No description.
getDescription
in interface StageOptions
public final java.lang.String getDocumentationVersion()
StageOptions
Default: - No documentation version.
getDocumentationVersion
in interface StageOptions
public final java.util.Map<java.lang.String,MethodDeploymentOptions> getMethodOptions()
StageOptions
These will
override common options defined in StageOptions#methodOptions
.
Default: - Common options will be used.
getMethodOptions
in interface StageOptions
public final java.lang.String getStageName()
StageOptions
Default: - "prod"
getStageName
in interface StageOptions
public final java.lang.Boolean getTracingEnabled()
StageOptions
Default: false
getTracingEnabled
in interface StageOptions
public final java.util.Map<java.lang.String,java.lang.String> getVariables()
StageOptions
Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
Default: - No stage variables.
getVariables
in interface StageOptions
public final java.lang.Boolean getCacheDataEncrypted()
MethodDeploymentOptions
Default: false
getCacheDataEncrypted
in interface MethodDeploymentOptions
public final Duration getCacheTtl()
MethodDeploymentOptions
The higher the TTL, the longer the response will be cached.
Default: Duration.minutes(5)
getCacheTtl
in interface MethodDeploymentOptions
public final java.lang.Boolean getCachingEnabled()
MethodDeploymentOptions
A cache cluster must be enabled on the stage for responses to be cached.
Default: - Caching is Disabled.
getCachingEnabled
in interface MethodDeploymentOptions
public final java.lang.Boolean getDataTraceEnabled()
MethodDeploymentOptions
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
getDataTraceEnabled
in interface MethodDeploymentOptions
public final MethodLoggingLevel getLoggingLevel()
MethodDeploymentOptions
Default: - Off
getLoggingLevel
in interface MethodDeploymentOptions
public final java.lang.Boolean getMetricsEnabled()
MethodDeploymentOptions
Default: false
getMetricsEnabled
in interface MethodDeploymentOptions
public final java.lang.Number getThrottlingBurstLimit()
MethodDeploymentOptions
The total rate of all requests in your AWS account is limited to 5,000 requests.
Default: - No additional restriction.
getThrottlingBurstLimit
in interface MethodDeploymentOptions
public final java.lang.Number getThrottlingRateLimit()
MethodDeploymentOptions
The total rate of all requests in your AWS account is limited to 10,000 requests per second (rps).
Default: - No additional restriction.
getThrottlingRateLimit
in interface MethodDeploymentOptions
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
public final boolean equals(java.lang.Object o)
public final int hashCode()