AWS::ApiGateway::DomainName

ApiGateway DomainName

The AWS::ApiGateway::DomainName resource specifies a public custom domain name for your API in API Gateway. To create a custom domain name for private APIs, use [AWS::ApiGateway::DomainNameV2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html). 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 i...

Properties

10 configurable properties. Click a row to see details.

Filter:

Property	Type	Flags
`CertificateArn`	`string`
`DomainName`	`string`	Create-only
`EndpointAccessMode`	`string`
`EndpointConfiguration`	`EndpointConfiguration`
`MutualTlsAuthentication`	`MutualTlsAuthentication`
`OwnershipVerificationCertificateArn`	`string`
`RegionalCertificateArn`	`string`
`RoutingMode`	`string`
`SecurityPolicy`	`string`
`Tags`	`Array<Tag>`

Return Values

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

Attribute	Type	Description
`DistributionDomainName`	`string`	-
`DistributionHostedZoneId`	`string`	-
`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::ApiGateway::DomainName

Resources:
  MyResource:
    Type: AWS::ApiGateway::DomainName
    Properties:
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

apigateway:POSTapigateway:PUTapigateway:GET

read

apigateway:GET

update

apigateway:GETapigateway:PUTapigateway:PATCH

delete

apigateway:GETapigateway: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

Properties15

Required0

TaggingSupported

Primary IDDomainName

Supported Operations

CreateReadUpdateDeleteList

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