public static interface CfnDeployment.StageDescriptionProperty
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.apigateway.*; StageDescriptionProperty stageDescriptionProperty = StageDescriptionProperty.builder() .accessLogSetting(AccessLogSettingProperty.builder() .destinationArn("destinationArn") .format("format") .build()) .cacheClusterEnabled(false) .cacheClusterSize("cacheClusterSize") .cacheDataEncrypted(false) .cacheTtlInSeconds(123) .cachingEnabled(false) .canarySetting(CanarySettingProperty.builder() .percentTraffic(123) .stageVariableOverrides(Map.of( "stageVariableOverridesKey", "stageVariableOverrides")) .useStageCache(false) .build()) .clientCertificateId("clientCertificateId") .dataTraceEnabled(false) .description("description") .documentationVersion("documentationVersion") .loggingLevel("loggingLevel") .methodSettings(List.of(MethodSettingProperty.builder() .cacheDataEncrypted(false) .cacheTtlInSeconds(123) .cachingEnabled(false) .dataTraceEnabled(false) .httpMethod("httpMethod") .loggingLevel("loggingLevel") .metricsEnabled(false) .resourcePath("resourcePath") .throttlingBurstLimit(123) .throttlingRateLimit(123) .build())) .metricsEnabled(false) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .throttlingBurstLimit(123) .throttlingRateLimit(123) .tracingEnabled(false) .variables(Map.of( "variablesKey", "variables")) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnDeployment.StageDescriptionProperty.Builder
A builder for
CfnDeployment.StageDescriptionProperty |
static class |
CfnDeployment.StageDescriptionProperty.Jsii$Proxy
An implementation for
CfnDeployment.StageDescriptionProperty |
Modifier and Type | Method and Description |
---|---|
static CfnDeployment.StageDescriptionProperty.Builder |
builder() |
default java.lang.Object |
getAccessLogSetting()
Specifies settings for logging access in this stage.
|
default java.lang.Object |
getCacheClusterEnabled()
Indicates whether cache clustering is enabled for the stage.
|
default java.lang.String |
getCacheClusterSize()
The size of the stage's cache cluster.
|
default java.lang.Object |
getCacheDataEncrypted()
Indicates whether the cached responses are encrypted.
|
default java.lang.Number |
getCacheTtlInSeconds()
The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
|
default java.lang.Object |
getCachingEnabled()
Indicates whether responses are cached and returned for requests.
|
default java.lang.Object |
getCanarySetting()
Specifies settings for the canary deployment in this stage.
|
default java.lang.String |
getClientCertificateId()
The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
|
default java.lang.Object |
getDataTraceEnabled()
Indicates whether data trace logging is enabled for methods in the stage.
|
default java.lang.String |
getDescription()
A description of the purpose of the stage.
|
default java.lang.String |
getDocumentationVersion()
The version identifier of the API documentation snapshot.
|
default java.lang.String |
getLoggingLevel()
The logging level for this method.
|
default java.lang.Object |
getMethodSettings()
Configures settings for all of the stage's methods.
|
default java.lang.Object |
getMetricsEnabled()
Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
|
default java.util.List<CfnTag> |
getTags()
An array of arbitrary tags (key-value pairs) to associate with the stage.
|
default java.lang.Number |
getThrottlingBurstLimit()
The target request burst rate limit.
|
default java.lang.Number |
getThrottlingRateLimit()
The target request steady-state rate limit.
|
default java.lang.Object |
getTracingEnabled()
Specifies whether active tracing with X-ray is enabled for this stage.
|
default java.lang.Object |
getVariables()
A map that defines the stage variables.
|
default java.lang.Object getAccessLogSetting()
default java.lang.Object getCacheClusterEnabled()
default java.lang.String getCacheClusterSize()
default java.lang.Object getCacheDataEncrypted()
default java.lang.Number getCacheTtlInSeconds()
default java.lang.Object getCachingEnabled()
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 .
default java.lang.Object getCanarySetting()
default java.lang.String getClientCertificateId()
default java.lang.Object getDataTraceEnabled()
API Gateway pushes these logs to Amazon CloudWatch Logs.
default java.lang.String getDescription()
default java.lang.String getDocumentationVersion()
default java.lang.String getLoggingLevel()
For valid values, see the loggingLevel
property of the Stage resource in the Amazon API Gateway API Reference .
default java.lang.Object getMethodSettings()
default java.lang.Object getMetricsEnabled()
default java.util.List<CfnTag> getTags()
default java.lang.Number getThrottlingBurstLimit()
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 .
default java.lang.Number getThrottlingRateLimit()
For more information, see Manage API Request Throttling in the API Gateway Developer Guide .
default java.lang.Object getTracingEnabled()
For more information, see Trace API Gateway API Execution with AWS X-Ray in the API Gateway Developer Guide .
default java.lang.Object getVariables()
Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+
.
static CfnDeployment.StageDescriptionProperty.Builder builder()