メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

Amazon API Gateway ステージの MethodSetting

MethodSetting プロパティタイプは、Amazon API Gateway (API Gateway) ステージの全てのメソッドの設定を構成します。

AWS::ApiGateway::Stage リソースの MethodSettings プロパティには、MethodSetting プロパティタイプのリストが含まれます。

構文

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

プロパティ

CacheDataEncrypted

キャッシュされたレスポンスが暗号化されているかどうかを示します。

Required: No

Type: Boolean

CacheTtlInSeconds

API Gateway キャッシュが応答する時間を指定する有効期限 (TTL) (秒) です。

Required: No

Type: Integer

CachingEnabled

リクエストに対してレスポンスがキャッシュされ返されるかどうかを示します。レスポンスをキャッシュするには、ステージのキャッシュクラスターを有効にする必要があります。

Required: No

Type: Boolean

DataTraceEnabled

データトレースロギングがステージのメソッドに対して有効かどうかを示します。API Gateway はこれらのログを Amazon CloudWatch Logs にプッシュします。

Required: No

Type: Boolean

HttpMethod

HTTP メソッド。

Required: Yes

Type: String

LoggingLevel

このメソッドのログレベル。有効な値については、Amazon API Gateway API リファレンスステージリソースの loggingLevel プロパティを参照してください。

Required: No

Type: String

MetricsEnabled

Amazon CloudWatch メトリクスがステージのメソッドで有効かどうかを示します。

Required: No

Type: Boolean

ResourcePath

このメソッドのリソースのパス。スラッシュ (/) は ~1 としてエンコードされ、最初のスラッシュにはスラッシュを含める必要があります。たとえば、パス値 /resource/subresource/~1resource~1subresource としてエンコードされる必要があります。ルートパスを指定するには、スラッシュのみ (/) を使用します。

Required: Yes

Type: String

ThrottlingBurstLimit

API Gateway が AWS アカウントのすべての API、ステージ、メソッドで許可する 1 秒あたりのバーストリクエスト数。詳細については、API Gateway 開発者ガイドAPI リクエストのスロットリングの管理を参照してください。

Required: No

Type: Integer

ThrottlingRateLimit

API Gateway が AWS アカウントのすべての API、ステージ、メソッドで許可する 1 秒あたりの定常状態のリクエスト数。詳細については、API Gateway 開発者ガイドAPI リクエストのスロットリングの管理を参照してください。

Required: No

Type: Number

このページの内容: