Package 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(Stable) public static interface CfnDeployment.StageDescriptionProperty extends software.amazon.jsii.JsiiSerializable
StageDescription is a property of the AWS::ApiGateway::Deployment 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();

  • Method Details

    • getAccessLogSetting

      @Stability(Stable) @Nullable default Object getAccessLogSetting()
      Specifies settings for logging access in this stage.

    • getCacheClusterEnabled

      @Stability(Stable) @Nullable default Object getCacheClusterEnabled()
      Specifies whether a cache cluster is enabled for the stage.

    • getCacheClusterSize

      @Stability(Stable) @Nullable default String getCacheClusterSize()
      The size of the stage's cache cluster.

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

    • getCacheDataEncrypted

      @Stability(Stable) @Nullable default Object getCacheDataEncrypted()
      Indicates whether the cached responses are encrypted.

    • getCacheTtlInSeconds

      @Stability(Stable) @Nullable default Number getCacheTtlInSeconds()
      The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

    • getCachingEnabled

      @Stability(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(Stable) @Nullable default Object getCanarySetting()
      Specifies settings for the canary deployment in this stage.

    • getClientCertificateId

      @Stability(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(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(Stable) @Nullable default String getDescription()
      A description of the purpose of the stage.

    • getDocumentationVersion

      @Stability(Stable) @Nullable default String getDocumentationVersion()
      The version identifier of the API documentation snapshot.

    • getLoggingLevel

      @Stability(Stable) @Nullable default String getLoggingLevel()
      The logging level for this method.

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

    • getMethodSettings

      @Stability(Stable) @Nullable default Object getMethodSettings()
      Configures settings for all of the stage's methods.

    • getMetricsEnabled

      @Stability(Stable) @Nullable default Object getMetricsEnabled()
      Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      An array of arbitrary tags (key-value pairs) to associate with the stage.

    • getThrottlingBurstLimit

      @Stability(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(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(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(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(Stable) static CfnDeployment.StageDescriptionProperty.Builder builder()
      Returns:
      a CfnDeployment.StageDescriptionProperty.Builder of CfnDeployment.StageDescriptionProperty