software.amazon.awscdk.services.apigateway

Interface CfnDeployment.StageDescriptionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeployment.StageDescriptionProperty.Jsii$Proxy

Enclosing class:

CfnDeployment

@Stability(value=Stable)
public static interface CfnDeployment.StageDescriptionProperty
extends software.amazon.jsii.JsiiSerializable

`StageDescription` is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccessLogSetting

@Stability(value=Stable)
 @Nullable
default Object getAccessLogSetting()

Specifies settings for logging access in this stage.

getCacheClusterEnabled

@Stability(value=Stable)
 @Nullable
default Object getCacheClusterEnabled()

Indicates whether cache clustering is enabled for the stage.

getCacheClusterSize

@Stability(value=Stable)
 @Nullable
default String getCacheClusterSize()

The size of the stage's cache cluster.

getCacheDataEncrypted

@Stability(value=Stable)
 @Nullable
default Object getCacheDataEncrypted()

Indicates whether the cached responses are encrypted.

getCacheTtlInSeconds

@Stability(value=Stable)
 @Nullable
default Number getCacheTtlInSeconds()

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

getCachingEnabled

@Stability(value=Stable)
 @Nullable
default Object getCachingEnabled()

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 .

getCanarySetting

@Stability(value=Stable)
 @Nullable
default Object getCanarySetting()

Specifies settings for the canary deployment in this stage.

getClientCertificateId

@Stability(value=Stable)
 @Nullable
default String getClientCertificateId()

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

getDataTraceEnabled

@Stability(value=Stable)
 @Nullable
default Object getDataTraceEnabled()

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

API Gateway pushes these logs to Amazon CloudWatch Logs.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A description of the purpose of the stage.

getDocumentationVersion

@Stability(value=Stable)
 @Nullable
default String getDocumentationVersion()

The version identifier of the API documentation snapshot.

getLoggingLevel

@Stability(value=Stable)
 @Nullable
default String getLoggingLevel()

The logging level for this method.

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

getMethodSettings

@Stability(value=Stable)
 @Nullable
default Object getMethodSettings()

Configures settings for all of the stage's methods.

getMetricsEnabled

@Stability(value=Stable)
 @Nullable
default Object getMetricsEnabled()

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

getThrottlingBurstLimit

@Stability(value=Stable)
 @Nullable
default Number getThrottlingBurstLimit()

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 .

getThrottlingRateLimit

@Stability(value=Stable)
 @Nullable
default Number getThrottlingRateLimit()

The target request steady-state rate limit.

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

getTracingEnabled

@Stability(value=Stable)
 @Nullable
default Object getTracingEnabled()

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 .

getVariables

@Stability(value=Stable)
 @Nullable
default Object getVariables()

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-._~:/?#&=,]+ .

builder

@Stability(value=Stable)
static CfnDeployment.StageDescriptionProperty.Builder builder()

Returns:

a CfnDeployment.StageDescriptionProperty.Builder of CfnDeployment.StageDescriptionProperty