Interface CfnStage.MethodSettingProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnStage.MethodSettingProperty.Jsii$Proxy
- Enclosing class:
CfnStage
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();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnStage.MethodSettingProperty
static final class
An implementation forCfnStage.MethodSettingProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Specifies whether the cached responses are encrypted.default Number
Specifies the time to live (TTL), in seconds, for cached responses.default Object
Specifies whether responses should be cached and returned for requests.default Object
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.default String
The HTTP method.default String
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs.default Object
Specifies whether Amazon CloudWatch metrics are enabled for this method.default String
The resource path for this method.default Number
Specifies the throttling burst limit.default Number
Specifies the throttling rate limit.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCacheDataEncrypted
Specifies whether the cached responses are encrypted.- See Also:
-
getCacheTtlInSeconds
Specifies the time to live (TTL), in seconds, for cached responses.The higher the TTL, the longer the response will be cached.
- See Also:
-
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.
- See Also:
-
getDataTraceEnabled
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
- See Also:
-
getHttpMethod
The HTTP method.To apply settings to multiple resources and methods, specify an asterisk (
*
) for theHttpMethod
and/*
for theResourcePath
. This parameter is required when you specify aMethodSetting
.- See Also:
-
getLoggingLevel
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs.Valid values are
OFF
,ERROR
, andINFO
. ChooseERROR
to write only error-level entries to CloudWatch Logs, or chooseINFO
to include allERROR
events as well as extra informational events.- See Also:
-
getMetricsEnabled
Specifies whether Amazon CloudWatch metrics are enabled for this method.- See Also:
-
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 theHttpMethod
and/*
for theResourcePath
. This parameter is required when you specify aMethodSetting
.- See Also:
-
getThrottlingBurstLimit
Specifies the throttling burst limit.- See Also:
-
getThrottlingRateLimit
Specifies the throttling rate limit.- See Also:
-
builder
-