Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
61 lines (48 sloc) 2.92 KB

AWS::ApiGateway::BasePathMapping

The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL.

Syntax

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

JSON

{
  "Type" : "AWS::ApiGateway::BasePathMapping",
  "Properties" : {
      "[BasePath](#cfn-apigateway-basepathmapping-basepath)" : String,
      "[DomainName](#cfn-apigateway-basepathmapping-domainname)" : String,
      "[RestApiId](#cfn-apigateway-basepathmapping-restapiid)" : String,
      "[Stage](#cfn-apigateway-basepathmapping-stage)" : String
    }
}

YAML

Type: AWS::ApiGateway::BasePathMapping
Properties: 
  [BasePath](#cfn-apigateway-basepathmapping-basepath): String
  [DomainName](#cfn-apigateway-basepathmapping-domainname): String
  [RestApiId](#cfn-apigateway-basepathmapping-restapiid): String
  [Stage](#cfn-apigateway-basepathmapping-stage): String

Properties

BasePath The base path name that callers of the API must provide in the URL after the domain name. If you specify this property, it can't be an empty string.
Required: No
Type: String
Update requires: Replacement

DomainName The DomainName of an AWS::ApiGateway::DomainName resource.
Required: Yes
Type: String
Update requires: Replacement

RestApiId The name of the API.
Required: No
Type: String
Update requires: No interruption

Stage The name of the API's stage.
Required: No
Type: String
Update requires: No interruption

See Also

You can’t perform that action at this time.