Package software.amazon.awscdk.services.apigateway

Interface IDomainName

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IDomainNameRef, IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IDomainName.Jsii$Default

All Known Implementing Classes:

DomainName, IDomainName.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:27.742Z")
@Stability(Stable)
public interface IDomainName
extends software.amazon.jsii.JsiiSerializable, IResource, IDomainNameRef

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IDomainName.Jsii$Default	Internal default implementation for IDomainName.
static final class	IDomainName.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getDomainName()	The domain name (e.g.
String	getDomainNameAliasDomainName()	The Route53 alias target to use in order to connect a record set to this domain through an alias.
String	getDomainNameAliasHostedZoneId()	The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.
ResourceEnvironment	getEnv()	The environment this resource belongs to.
software.constructs.Node	getNode()	The tree node.

Methods inherited from interface software.amazon.awscdk.interfaces.apigateway.IDomainNameRef

getDomainNameRef

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The domain name (e.g. example.com).

getDomainNameAliasDomainName

@Stability(Stable)
@NotNull
String getDomainNameAliasDomainName()

The Route53 alias target to use in order to connect a record set to this domain through an alias.

getDomainNameAliasHostedZoneId

@Stability(Stable)
@NotNull
String getDomainNameAliasHostedZoneId()

The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.

getNode

@Stability(Stable)
@NotNull
software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

getEnv

@Stability(Stable)
@NotNull
ResourceEnvironment getEnv()

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.

Specified by:

getEnv in interface IEnvironmentAware