interface IDomainName

Language	Type name
.NET	Amazon.CDK.AWS.Apigatewayv2.IDomainName
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#IDomainName
Java	software.amazon.awscdk.services.apigatewayv2.IDomainName
Python	aws_cdk.aws_apigatewayv2.IDomainName
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2 » IDomainName

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IDomainNameRef

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
domainNameRef🔹	DomainNameReference	A reference to a DomainName resource.
env	ResourceEnvironment	The environment this resource belongs to.
name	string	The custom domain name.
node	Node	The tree node.
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.

---

domainNameRef🔹

Type: DomainNameReference

A reference to a DomainName resource.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

name

Type: string

The custom domain name.

---

node

Type: Node

The tree node.

---

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.
with(...mixins)	Applies one or more mixins to this construct.

---

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).

---

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.