Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

Amazon API Gateway Stage MethodSetting

MethodSetting is a property of the AWS::ApiGateway::Stage resource that configures settings for all methods in an Amazon API Gateway (API Gateway) stage.

Syntax

JSON

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

YAML

Copy
CacheDataEncrypted: Boolean CacheTtlInSeconds: Integer CachingEnabled: Boolean DataTraceEnabled: Boolean HttpMethod: String LoggingLevel: String MetricsEnabled: Boolean ResourcePath: String ThrottlingBurstLimit: Integer ThrottlingRateLimit: Number

Properties

CacheDataEncrypted

Indicates whether the cached responses are encrypted.

Required: No

Type: Boolean

CacheTtlInSeconds

The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.

Required: No

Type: Integer

CachingEnabled

Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses.

Required: No

Type: Boolean

DataTraceEnabled

Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.

Required: No

Type: Boolean

HttpMethod

The HTTP method.

Required: Yes

Type: String

LoggingLevel

The logging level for this method. For valid values, see the loggingLevel property of the Stage resource in the Amazon API Gateway API Reference.

Required: No

Type: String

MetricsEnabled

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

Required: No

Type: Boolean

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 (/).

Required: Yes

Type: String

ThrottlingBurstLimit

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.

Required: No

Type: Integer

ThrottlingRateLimit

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.

Required: No

Type: Number

On this page: