AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ApiGateway::DomainName

CfnDomainName

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 in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide* .

Import

import { CfnDomainName } from 'aws-cdk-lib/aws-apigateway';

Or use the module namespace:

import * as apigateway from 'aws-cdk-lib/aws-apigateway';
// apigateway.CfnDomainName

Properties

Configuration passed to the constructor as CfnDomainNameProps.

certificateArnOptional
string

The reference to an AWS -managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.

domainNameOptional
string

The custom domain name as an API host name, for example, `my-api.example.com` .

endpointAccessModeOptional
string

The endpoint access mode for your DomainName.

endpointConfigurationOptional
IResolvable | EndpointConfigurationProperty

The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.

mutualTlsAuthenticationOptional
IResolvable | MutualTlsAuthenticationProperty

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

ownershipVerificationCertificateArnOptional
string

The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.

regionalCertificateArnOptional
string

The reference to an AWS -managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.

routingModeOptional
string

The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your public APIs.

Default: - "BASE_PATH_MAPPING_ONLY"

securityPolicyOptional
string

The Transport Layer Security (TLS) version + cipher suite for this DomainName.

tagsOptional
CfnTag[]

The collection of tags. Each tag element is associated with a given resource.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::ApiGateway::DomainNameView in CloudFormation Explorer

Get the Amazon API Gateway Cheat Sheet

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

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-apigateway
CFN TypeAWS::ApiGateway::DomainName
Properties10

Related Constructs

Explore This Service

External Links