AWS::ApiGateway::Stage MethodSetting - AWS CloudFormation
SyntaxPropertiesSee also

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::ApiGateway::Stage MethodSetting

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "CacheDataEncrypted" : Boolean,
  "CacheTtlInSeconds" : Integer,
  "CachingEnabled" : Boolean,
  "DataTraceEnabled" : Boolean,
  "HttpMethod" : String,
  "LoggingLevel" : String,
  "MetricsEnabled" : Boolean,
  "ResourcePath" : String,
  "ThrottlingBurstLimit" : Integer,
  "ThrottlingRateLimit" : Number
}

Properties

CacheDataEncrypted

Specifies whether the cached responses are encrypted.

Required: No

Type: Boolean

Update requires: No interruption

CacheTtlInSeconds

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.

Required: No

Type: Integer

Update requires: No interruption

CachingEnabled

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.

Required: No

Type: Boolean

Update requires: No interruption

DataTraceEnabled

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.

Required: No

Type: Boolean

Update requires: No interruption

HttpMethod

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.

Required: Conditional

Type: String

Update requires: No interruption

LoggingLevel

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.

Required: No

Type: String

Update requires: No interruption

MetricsEnabled

Specifies whether Amazon CloudWatch metrics are enabled for this method.

Required: No

Type: Boolean

Update requires: No interruption

ResourcePath

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.

Required: Conditional

Type: String

Update requires: No interruption

ThrottlingBurstLimit

Specifies the throttling burst limit.

Required: No

Type: Integer

Minimum: 0

Update requires: No interruption

ThrottlingRateLimit

Specifies the throttling rate limit.

Required: No

Type: Number

Minimum: 0

Update requires: No interruption

See also

  • Stage in the Amazon API Gateway REST API Reference