Interface CfnStage.IMethodSettingProperty
The MethodSetting property type configures settings for all methods in a stage.
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IMethodSettingPropertySyntax (vb)
Public Interface IMethodSettingPropertyRemarks
The MethodSettings property of the AWS::ApiGateway::Stage resource contains a list of MethodSetting property types.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGateway;
var methodSettingProperty = new MethodSettingProperty {
CacheDataEncrypted = false,
CacheTtlInSeconds = 123,
CachingEnabled = false,
DataTraceEnabled = false,
HttpMethod = "httpMethod",
LoggingLevel = "loggingLevel",
MetricsEnabled = false,
ResourcePath = "resourcePath",
ThrottlingBurstLimit = 123,
ThrottlingRateLimit = 123
};Synopsis
Properties
| Cache |
Specifies whether the cached responses are encrypted. |
| Cache |
Specifies the time to live (TTL), in seconds, for cached responses. |
| Caching |
Specifies whether responses should be cached and returned for requests. |
| Data |
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. |
| Http |
The HTTP method. |
| Logging |
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. |
| Metrics |
Specifies whether Amazon CloudWatch metrics are enabled for this method. |
| Resource |
The resource path for this method. |
| Throttling |
Specifies the throttling burst limit. |
| Throttling |
Specifies the throttling rate limit. |
Properties
CacheDataEncrypted
Specifies whether the cached responses are encrypted.
virtual object CacheDataEncrypted { get; }Property Value
System.
Remarks
CacheTtlInSeconds
Specifies the time to live (TTL), in seconds, for cached responses.
virtual Nullable<double> CacheTtlInSeconds { get; }Property Value
System.
Remarks
The higher the TTL, the longer the response will be cached.
CachingEnabled
Specifies whether responses should be cached and returned for requests.
virtual object CachingEnabled { get; }Property Value
System.
Remarks
A cache cluster must be enabled on the stage for responses to be cached.
DataTraceEnabled
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
virtual object DataTraceEnabled { get; }Property Value
System.
Remarks
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.
HttpMethod
The HTTP method.
virtual string HttpMethod { get; }Property Value
System.
Remarks
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 .
LoggingLevel
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
virtual string LoggingLevel { get; }Property Value
System.
Remarks
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.
MetricsEnabled
Specifies whether Amazon CloudWatch metrics are enabled for this method.
virtual object MetricsEnabled { get; }Property Value
System.
Remarks
ResourcePath
The resource path for this method.
virtual string ResourcePath { get; }Property Value
System.
Remarks
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 .
ThrottlingBurstLimit
Specifies the throttling burst limit.
virtual Nullable<double> ThrottlingBurstLimit { get; }Property Value
System.
Remarks
ThrottlingRateLimit
Specifies the throttling rate limit.
virtual Nullable<double> ThrottlingRateLimit { get; }Property Value
System.