AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::ApiGateway::Stage

AWS::ApiGateway::Stage 资源为 Amazon API Gateway (API 网关) 部署创建阶段。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "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

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 网关 用来调用阶段中的集成终端节点的客户端证书的标识符。

Required: No

Type: String

更新要求无需中断

DeploymentId

该阶段指向的部署的 ID。

Required: Yes

Type: String

更新要求无需中断

Description

阶段用途的描述。

Required: No

Type: String

更新要求无需中断

DocumentationVersion

API 文档快照的版本标识符。

Required: No

Type: String

MethodSettings

阶段中所有方法的设置。

Required: No

Type: Amazon API Gateway Stage MethodSetting

更新要求无需中断

RestApiId

使用此阶段部署的 RestApi 资源的 ID。

Required: Yes

Type: String

更新要求替换

StageName

阶段的名称,API 网关 将它用作调用的统一资源标识符 (URI) 中的第一个路径部分。

Required: Yes

Type: String

更新要求替换

Variables

一个定义阶段变量的映射 (字符串到字符串映射),其中变量名作为键,变量值作为值。变量名称只能包含字母数字字符。值必须匹配以下正则表达式:[A-Za-z0-9-._~:/?#&=,]+

Required: No

类型:键值对的映射

更新要求无需中断

返回值

Ref

当向 Ref 内部函数提供此资源的逻辑 ID 时,Ref 将返回阶段的名称,如 MyTestStage

有关使用 Ref 功能的更多信息,请参阅参考

示例

下面的示例为 TestDeployment 部署创建阶段。阶段还指定 MyRestApi API 的方法设置。

JSON

{ "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

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'

本页内容: