AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ApiGateway::DomainNameV2

CfnDomainNameV2

The `AWS::ApiGateway::DomainNameV2` resource specifies a custom domain name for your private APIs in API Gateway. You can use a private custom domain name to provide a URL for your private API that's more intuitive and easier to recall.

Import

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

Or use the module namespace:

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

Properties

Configuration passed to the constructor as CfnDomainNameV2Props.

certificateArnOptional
string

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

domainNameOptional
string

Represents a custom domain name as a user-friendly host name of an API (RestApi).

endpointAccessModeOptional
string

The endpoint access mode for your DomainName.

endpointConfigurationOptional
IResolvable | EndpointConfigurationProperty

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.

policyOptional
any

A stringified JSON policy document that applies to the `execute-api` service for this DomainName regardless of the caller and Method configuration. You can use `Fn::ToJsonString` to enter your `policy` . For more information, see [Fn::ToJsonString](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html) .

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 private 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::DomainNameV2View 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::DomainNameV2
Properties8

Related Constructs

Explore This Service

External Links