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

Amazon API Gateway デプロイの StageDescription

StageDescription は、Amazon API Gateway (API Gateway) デプロイステージを設定する AWS::ApiGateway::Deployment リソースです。

構文

JSON

Copy
{ "CacheClusterEnabled" : Boolean, "CacheClusterSize" : String, "CacheDataEncrypted" : Boolean, "CacheTtlInSeconds" : Integer, "CachingEnabled" : Boolean, "ClientCertificateId" : String, "DataTraceEnabled" : Boolean, "Description" : String, "DocumentationVersion" : String, "LoggingLevel" : String, "MethodSettings" : [ MethodSetting, ... ], "MetricsEnabled" : Boolean, "ThrottlingBurstLimit" : Integer, "ThrottlingRateLimit" : Number, "Variables" : { 文字列: 文字列, ... } }

プロパティ

CacheClusterEnabled

ステージでキャッシュのクラスタリングが有効かどうかを示します。

Required: No

Type: Boolean

CacheClusterSize

ステージのキャッシュクラスターのサイズ。

Required: No

Type: String

CacheDataEncrypted

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

Required: No

Type: Boolean

CacheTtlInSeconds

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

Required: No

Type: Integer

CachingEnabled

リクエストに対してレスポンスがキャッシュされ返されるかどうかを示します。レスポンスをキャッシュするには、ステージのキャッシュクラスターを有効にする必要があります。詳細については、API Gateway 開発者ガイドAPI のパフォーマンス向上のためにステージで API Gateway キャッシュを有効にするを参照してください。

Required: No

Type: Boolean

ClientCertificateId

API Gateway がステージで統合エンドポイントを呼び出すために使用するクライアント証明書の識別子。

Required: No

Type: String

DataTraceEnabled

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

Required: No

Type: Boolean

Description

ステージの目的の説明。

Required: No

Type: String

DocumentationVersion

API ドキュメントスナップショットのバージョン識別子。

Required: No

Type: String

LoggingLevel

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

Required: No

Type: String

MethodSettings

ステージのすべてのメソッドを設定します。

Required: No

API Gateway デプロイの MethodSettingType: リスト

MetricsEnabled

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

Required: No

Type: Boolean

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

Variables

ステージ変数を定義するマップ。変数名は、英数字で構成されている必要があり、値は次の正規表現に一致する必要があります。[A-Za-z0-9-._~:/?#&=,]+.

Required: No

: キーと値のペアのマッピング

このページの内容: