Interface CfnDeployment.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 CfnDeployment.IMethodSettingPropertySyntax (vb)
Public Interface CfnDeployment.IMethodSettingPropertyRemarks
If you modify this property type, you must create a new deployment for your API.
The MethodSettings property of the Amazon API Gateway Deployment StageDescription property type 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
| CacheDataEncrypted | Specifies whether the cached responses are encrypted. |
| CacheTtlInSeconds | Specifies the time to live (TTL), in seconds, for cached responses. |
| CachingEnabled | Specifies whether responses should be cached and returned for requests. |
| DataTraceEnabled | Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. |
| HttpMethod | The HTTP method. |
| LoggingLevel | Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. |
| MetricsEnabled | Specifies whether Amazon CloudWatch metrics are enabled for this method. |
| ResourcePath | The resource path for this method. |
| ThrottlingBurstLimit | Specifies the throttling burst limit. |
| ThrottlingRateLimit | Specifies the throttling rate limit. |
Properties
CacheDataEncrypted
Specifies whether the cached responses are encrypted.
object? CacheDataEncrypted { get; }Property Value
Remarks
CacheTtlInSeconds
Specifies the time to live (TTL), in seconds, for cached responses.
double? CacheTtlInSeconds { get; }Property Value
Remarks
The higher the TTL, the longer the response will be cached.
CachingEnabled
Specifies whether responses should be cached and returned for requests.
object? CachingEnabled { get; }Property Value
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.
object? DataTraceEnabled { get; }Property Value
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.
string? HttpMethod { get; }Property Value
Remarks
LoggingLevel
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
string? LoggingLevel { get; }Property Value
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.
object? MetricsEnabled { get; }Property Value
Remarks
ResourcePath
The resource path for this method.
string? ResourcePath { get; }Property Value
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 ( / ).
ThrottlingBurstLimit
Specifies the throttling burst limit.
double? ThrottlingBurstLimit { get; }Property Value
Remarks
ThrottlingRateLimit
Specifies the throttling rate limit.
double? ThrottlingRateLimit { get; }