software.amazon.awscdk.services.apigateway

Interface CfnStage.MethodSettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStage.MethodSettingProperty.Jsii$Proxy

Enclosing class:

CfnStage

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

The `MethodSetting` property type configures settings for all methods in a stage.

The MethodSettings property of the AWS::ApiGateway::Stage resource 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnStage.MethodSettingProperty.Builder A builder for CfnStage.MethodSettingProperty
static class	CfnStage.MethodSettingProperty.Jsii$Proxy An implementation for CfnStage.MethodSettingProperty

Method Summary

Modifier and Type	Method and Description
static CfnStage.MethodSettingProperty.Builder	builder()
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	getDataTraceEnabled() Indicates whether data trace logging is enabled for methods in the stage.
default String	getHttpMethod() The HTTP method.
default String	getLoggingLevel() The logging level for this method.
default Object	getMetricsEnabled() Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
default String	getResourcePath() The resource path for this method.
default Number	getThrottlingBurstLimit() The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account .
default Number	getThrottlingRateLimit() The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

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.

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.

getHttpMethod

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

The HTTP method.

To apply settings to multiple resources and methods, specify an asterisk ( * ) for the HttpMethod and /* for the ResourcePath . This parameter is required when you specify a MethodSetting .

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 .

getMetricsEnabled

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

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

getResourcePath

@Stability(value=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 ( / ). To apply settings to multiple resources and methods, specify an asterisk ( * ) for the HttpMethod and /* for the ResourcePath . This parameter is required when you specify a MethodSetting .

getThrottlingBurstLimit

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

The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account .

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

getThrottlingRateLimit

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

The number of steady-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account .

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

builder

@Stability(value=Stable)
static CfnStage.MethodSettingProperty.Builder builder()

Returns:

a CfnStage.MethodSettingProperty.Builder of CfnStage.MethodSettingProperty