interface IDomainName 🔹

Language	Type name
.NET	Amazon.CDK.AWS.APIGatewayv2.IDomainName
Java	software.amazon.awscdk.services.apigatewayv2.IDomainName
Python	aws_cdk.aws_apigatewayv2.IDomainName
TypeScript (source)	@aws-cdk/aws-apigatewayv2 » IDomainName

Implemented by DomainName

Obtainable from DomainName.fromDomainNameAttributes()

Represents an APIGatewayV2 DomainName.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
name🔹	string	The custom domain name.
node🔹	ConstructNode	The construct tree node for this construct.
regionalDomainName🔹	string	The domain name associated with the regional endpoint for this custom domain name.
regionalHostedZoneId🔹	string	The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
stack🔹	Stack	The stack in which this resource is defined.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

name🔹

Type: string

The custom domain name.

---

node🔹

Type: ConstructNode

The construct tree node for this construct.

---

regionalDomainName🔹

Type: string

The domain name associated with the regional endpoint for this custom domain name.

---

regionalHostedZoneId🔹

Type: string

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).