AWS::ApiGatewayV2::DomainName

ApiGatewayV2 DomainName

The AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway). You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*.

Properties

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

Filter:

Property	Type	Flags
`DomainName`	`string`	RequiredCreate-only
`DomainNameConfigurations`	`Array<DomainNameConfiguration>`
`MutualTlsAuthentication`	`MutualTlsAuthentication`
`RoutingMode`	`string`
`Tags`	`object`

Return Values

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

Attribute	Type	Description
`DomainNameArn`	`string`	-
`RegionalDomainName`	`string`	-
`RegionalHostedZoneId`	`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::ApiGatewayV2::DomainName

Resources:
  MyResource:
    Type: AWS::ApiGatewayV2::DomainName
    Properties:
      DomainName: "my-domainname"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

apigateway:POSTapigateway:GETapigateway:PUT

update

apigateway:PATCHapigateway:GETapigateway:PUT

read

apigateway:GET

delete

apigateway:GETapigateway:DELETE

list

apigateway:GET

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceApiGatewayV2

Properties8

Required1

TaggingSupported

Primary IDDomainName

Supported Operations

CreateUpdateReadDeleteList

Immutable After Creation

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

DomainName

Related Resources

External Links

AWS Documentation