AWS::ApiGateway::BasePathMappingV2

ApiGateway BasePathMappingV2

Resource Type definition for AWS::ApiGateway::BasePathMappingV2

Properties

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

Filter:

Property	Type	Flags
`DomainNameArn`	`string`	RequiredCreate-only
`RestApiId`	`string`	Required
`BasePath`	`string`	Create-only
`Stage`	`string`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`BasePathMappingArn`	`string`	Amazon Resource Name (ARN) of the resource.

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::BasePathMappingV2

Resources:
  MyResource:
    Type: AWS::ApiGateway::BasePathMappingV2
    Properties:
      DomainNameArn: "arn:aws:service:region:account:resource"
      RestApiId: "my-restapiid"

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

Properties5

Required2

TaggingNot supported

Primary IDBasePathMappingArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

DomainNameArnBasePath

Related Resources

External Links

AWS Documentation