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

AWS::ApiGateway::Stage

AWS::ApiGateway::Stage リソースは、Amazon API Gateway (API Gateway) をデプロイするためのステージを作成します。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

Copy
{ "Type" : "AWS::ApiGateway::Stage", "Properties" : { "CacheClusterEnabled" : Boolean, "CacheClusterSize" : String, "ClientCertificateId" : String, "DeploymentId" : String, "Description" : String, "DocumentationVersion" : String, "MethodSettings" : [ MethodSetting, ... ], "RestApiId" : String, "StageName" : String, "Variables" : { 文字列: 文字列, ... } } }

YAML

Copy
Type: "AWS::ApiGateway::Stage" Properties: CacheClusterEnabled: Boolean CacheClusterSize: String ClientCertificateId: String DeploymentId: String Description: String DocumentationVersion: String MethodSettings: - MethodSetting RestApiId: String StageName: String Variables: 文字列: 文字列

プロパティ

CacheClusterEnabled

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

Required: No

Type: Boolean

更新に伴う要件: 中断はありません。

CacheClusterSize

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

Required: No

Type: String

更新に伴う要件: 中断はありません。

ClientCertificateId

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

Required: No

Type: String

更新に伴う要件: 中断はありません。

DeploymentId

ステージが指すデプロイメントの ID。

Required: Yes

Type: String

更新に伴う要件: 中断はありません。

Description

ステージの説明。

Required: No

Type: String

更新に伴う要件: 中断はありません。

DocumentationVersion

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

Required: No

Type: String

MethodSettings

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

Required: No

API Gateway ステージの MethodSettingType: リスト

更新に伴う要件: 中断はありません。

RestApiId

このステージでデプロイする RestApi リソースの ID。

Required: Yes

Type: String

更新に伴う要件: 置換

StageName

API Gateway によって呼び出された Uniform Resource Identifier (URI) で最初のパスセグメントとして使用されるステージの名前。

Required: Yes

Type: String

更新に伴う要件: 置換

Variables

ステージ変数を定義するマップ (文字列間のマップ)。変数名はキー、変数値は値です。変数名に使用できるのは英数字のみです。値は次の正規表現に一致する必要があります。[A-Za-z0-9-._~:/?#&=,]+

Required: No

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

更新に伴う要件: 中断はありません。

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref により MyTestStage のようなステージの名前が返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

次の例では、TestDeployment のデプロイメント用のステージを作成します。ステージは、MyRestApi API のメソッド設定も指定します。

JSON

Copy
{ "Resources": { "Prod": { "Type": "AWS::ApiGateway::Stage", "Properties": { "StageName": "Prod", "Description": "Prod Stage", "RestApiId": { "Ref": "MyRestApi" }, "DeploymentId": { "Ref": "TestDeployment" }, "DocumentationVersion": { "Ref": "MyDocumentationVersion" }, "ClientCertificateId": { "Ref": "ClientCertificate" }, "Variables": { "Stack": "Prod" }, "MethodSettings": [ { "ResourcePath": "/", "HttpMethod": "GET", "MetricsEnabled": "true", "DataTraceEnabled": "true" }, { "ResourcePath": "/stack", "HttpMethod": "POST", "MetricsEnabled": "true", "DataTraceEnabled": "true", "ThrottlingBurstLimit": "999" }, { "ResourcePath": "/stack", "HttpMethod": "GET", "MetricsEnabled": "true", "DataTraceEnabled": "true", "ThrottlingBurstLimit": "555" } ] } } } }

YAML

Copy
Resources: Prod: Type: 'AWS::ApiGateway::Stage' Properties: StageName: Prod Description: Prod Stage RestApiId: !Ref MyRestApi DeploymentId: !Ref TestDeployment DocumentationVersion: !Ref MyDocumentationVersion ClientCertificateId: !Ref ClientCertificate Variables: Stack: Prod MethodSettings: - ResourcePath: / HttpMethod: GET MetricsEnabled: 'true' DataTraceEnabled: 'true' - ResourcePath: /stack HttpMethod: POST MetricsEnabled: 'true' DataTraceEnabled: 'true' ThrottlingBurstLimit: '999' - ResourcePath: /stack HttpMethod: GET MetricsEnabled: 'true' DataTraceEnabled: 'true' ThrottlingBurstLimit: '555'

このページの内容: