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

AWS::ApiGateway::BasePathMapping

AWS::ApiGateway::BasePathMapping リソースは、Amazon API Gateway API を呼び出すクライアントが呼び出し URL で必ず使用する基本パスを作成します。

トピック

構文

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

JSON

Copy
{ "Type" : "AWS::ApiGateway::BasePathMapping", "Properties" : { "BasePath" : String, "DomainName" : String, "RestApiId" : String, "Stage" : String } }

YAML

Copy
Type: "AWS::ApiGateway::BasePathMapping" Properties: BasePath: String DomainName: String RestApiId: String Stage: String

プロパティ

BasePath

API の呼び出し元が URL でドメイン名に続けて指定する必要がある基本パス名。

Required: No

Type: String

更新に伴う要件: 置換

DomainName

DomainName リソースのドメイン名。

Required: Yes

Type: String

更新に伴う要件: 置換

RestApiId

API の名前。

Required: Yes

Type: String

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

Stage

API のステージの名前。

Required: No

Type: String

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

このページの内容: