AWS::ApiGateway::BasePathMapping - Amazon CloudFormation
SyntaxPropertiesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::ApiGateway::BasePathMapping

The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL. Supported only for public custom domain names.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

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

YAML

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

Properties

BasePath

The base path name that callers of the API must provide as part of the URL after the domain name.

Required: No

Type: String

Update requires: Replacement

DomainName

The domain name of the BasePathMapping resource to be described.

Required: Yes

Type: String

Update requires: Replacement

RestApiId

The string identifier of the associated RestApi.

Required: No

Type: String

Update requires: No interruption

Stage

The name of the associated stage.

Required: No

Type: String

Update requires: No interruption

See also