AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGateway::BasePathMapping

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.

Properties

4 configurable properties. 1 required. Click a row to see details.

Filter:
PropertyTypeFlags
DomainName
string
RequiredCreate-only
BasePath
string
Create-only
RestApiId
string
Stage
string

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ApiGateway::BasePathMapping

Resources:
  MyResource:
    Type: AWS::ApiGateway::BasePathMapping
    Properties:
      DomainName: "my-domainname"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

apigateway:POSTapigateway:GET

read

apigateway:GET

update

apigateway:GETapigateway:DELETEapigateway:PATCH

delete

apigateway:DELETE

list

apigateway:GET

Get the ApiGateway Cheat Sheet

Everything you need to know about ApiGateway on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceApiGateway
Properties4
Required1
TaggingNot supported
Primary IDDomainName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DomainNameBasePath

Related Resources

External Links