Package software.amazon.awscdk.services.route53.targets

Class ApiGatewayDomain

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.route53.targets.ApiGatewayDomain

All Implemented Interfaces:

IAliasRecordTarget, software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

ApiGateway

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:19.418Z")
@Stability(Stable)
public class ApiGatewayDomain
extends software.amazon.jsii.JsiiObject
implements IAliasRecordTarget

Defines an API Gateway domain name as the alias target.

Use the ApiGateway class if you wish to map the alias to an REST API with a domain name defined through the RestApiProps.domainName prop.

Example:

 Object hostedZoneForExampleCom;
 DomainName domainName;
 import software.amazon.awscdk.services.route53.*;
 import software.amazon.awscdk.services.route53.targets.*;
 ARecord.Builder.create(this, "CustomDomainAliasRecord")
         .zone(hostedZoneForExampleCom)
         .target(RecordTarget.fromAlias(new ApiGatewayDomain(domainName)))
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.route53.IAliasRecordTarget

IAliasRecordTarget.Jsii$Default, IAliasRecordTarget.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	ApiGatewayDomain(IDomainName domainName)
protected	ApiGatewayDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ApiGatewayDomain(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
AliasRecordTargetConfig	bind(IRecordSet _record)	Return hosted zone ID and DNS name, usable for Route53 alias targets.
AliasRecordTargetConfig	bind(IRecordSet _record, IHostedZone _zone)	Return hosted zone ID and DNS name, usable for Route53 alias targets.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

ApiGatewayDomain

protected ApiGatewayDomain(software.amazon.jsii.JsiiObjectRef objRef)

ApiGatewayDomain

protected ApiGatewayDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ApiGatewayDomain

@Stability(Stable)
public ApiGatewayDomain(@NotNull
 IDomainName domainName)

Parameters:

domainName - This parameter is required.

Method Details

bind

@Stability(Stable)
@NotNull
public AliasRecordTargetConfig bind(@NotNull
 IRecordSet _record,
 @Nullable
 IHostedZone _zone)

Return hosted zone ID and DNS name, usable for Route53 alias targets.

Specified by:

bind in interface IAliasRecordTarget

Parameters:

_record - This parameter is required.

_zone -

bind

@Stability(Stable)
@NotNull
public AliasRecordTargetConfig bind(@NotNull
 IRecordSet _record)

Return hosted zone ID and DNS name, usable for Route53 alias targets.

Specified by:

bind in interface IAliasRecordTarget

Parameters:

_record - This parameter is required.