Package software.amazon.awscdk.services.apigateway

Interface CfnDeployment.MethodSettingProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDeployment.MethodSettingProperty.Jsii$Proxy
Enclosing class:
CfnDeployment
@Stability(Stable) public static interface CfnDeployment.MethodSettingProperty extends software.amazon.jsii.JsiiSerializable
The MethodSetting property type configures settings for all methods in a stage.

The MethodSettings property of the Amazon API Gateway Deployment StageDescription property type contains a list of MethodSetting property types.

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.*;
 MethodSettingProperty methodSettingProperty = MethodSettingProperty.builder()
         .cacheDataEncrypted(false)
         .cacheTtlInSeconds(123)
         .cachingEnabled(false)
         .dataTraceEnabled(false)
         .httpMethod("httpMethod")
         .loggingLevel("loggingLevel")
         .metricsEnabled(false)
         .resourcePath("resourcePath")
         .throttlingBurstLimit(123)
         .throttlingRateLimit(123)
         .build();

  • Method Details

    • getCacheDataEncrypted

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

    • getCacheTtlInSeconds

      @Stability(Stable) @Nullable default Number getCacheTtlInSeconds()
      Specifies the time to live (TTL), in seconds, for cached responses.

      The higher the TTL, the longer the response will be cached.

    • getCachingEnabled

      @Stability(Stable) @Nullable default Object getCachingEnabled()
      Specifies whether responses should be cached and returned for requests.

      A cache cluster must be enabled on the stage for responses to be cached.

    • getDataTraceEnabled

      @Stability(Stable) @Nullable default Object getDataTraceEnabled()
      Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.

    • getHttpMethod

      @Stability(Stable) @Nullable default String getHttpMethod()
      The HTTP method.

    • getLoggingLevel

      @Stability(Stable) @Nullable default String getLoggingLevel()
      Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs.

      Valid values are OFF , ERROR , and INFO . Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

    • getMetricsEnabled

      @Stability(Stable) @Nullable default Object getMetricsEnabled()
      Specifies whether Amazon CloudWatch metrics are enabled for this method.

    • getResourcePath

      @Stability(Stable) @Nullable default String getResourcePath()
      The resource path for this method.

      Forward slashes ( / ) are encoded as ~1 and the initial slash must include a forward slash. For example, the path value /resource/subresource must be encoded as /~1resource~1subresource . To specify the root path, use only a slash ( / ).

    • getThrottlingBurstLimit

      @Stability(Stable) @Nullable default Number getThrottlingBurstLimit()
      Specifies the throttling burst limit.

    • getThrottlingRateLimit

      @Stability(Stable) @Nullable default Number getThrottlingRateLimit()
      Specifies the throttling rate limit.

    • builder

      @Stability(Stable) static CfnDeployment.MethodSettingProperty.Builder builder()
      Returns:
      a CfnDeployment.MethodSettingProperty.Builder of CfnDeployment.MethodSettingProperty