AWS::ApiGatewayV2::ApiMapping - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::ApiGatewayV2::ApiMapping

AWS::ApiGatewayV2::ApiMapping 资源包含一个 API 映射。API 映射将自定义域名的路径与 API 的阶段相关联。自定义域名可以具有多个 API 映射,但路径不能重叠。自定义域只能映射到相同协议类型的 API。有关更多信息,请参阅 Amazon API Gateway V2 API 参考中的 CreateApiMapping

语法

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

JSON

{ "Type" : "AWS::ApiGatewayV2::ApiMapping", "Properties" : { "ApiId" : String, "ApiMappingKey" : String, "DomainName" : String, "Stage" : String } }

YAML

Type: AWS::ApiGatewayV2::ApiMapping Properties: ApiId: String ApiMappingKey: String DomainName: String Stage: String

属性

ApiId

API 的标识符。

必需:是

类型:字符串

Update requires: Replacement

ApiMappingKey

API 映射键。

必需:否

类型:字符串

Update requires: No interruption

DomainName

域名。

必需:是

类型:字符串

Update requires: Replacement

Stage

API 阶段。

必需:是

类型:字符串

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回 API 映射资源 ID。

For more information about using the Ref function, see Ref.

示例

API 映射创建示例

以下示例创建一个名为 MyApiMappingApiMapping 资源。

JSON

{ "MyApiMapping": { "Type": "AWS::ApiGatewayV2::ApiMapping", "Properties": { "DomainName": "mydomainame.us-east-1.com", "ApiId": { "Ref": "MyApi" }, "Stage": { "Ref": "MyStage" } } } }

YAML

MyApiMapping: Type: 'AWS::ApiGatewayV2::ApiMapping' Properties: DomainName: mydomainame.us-east-1.com ApiId: !Ref MyApi Stage: !Ref MyStage

另请参阅