AWS CDK Reference

Appearance

v2.273.0

UserPoolDomainTarget Class ​

Use a user pool domain as an alias record target.

Source
aws-route53-targets/lib/userpool-domain.ts
Type last changed
v2.174.0 · 4 Jan 2025

Example ​

ts
import * as cognito from 'aws-cdk-lib/aws-cognito';

declare const zone: route53.HostedZone;
declare const domain: cognito.UserPoolDomain;
new route53.ARecord(this, 'AliasRecord', {
  zone,
  target: route53.RecordTarget.fromAlias(new targets.UserPoolDomainTarget(domain)),
});
python
import aws_cdk.aws_cognito as cognito

# zone: route53.HostedZone
# domain: cognito.UserPoolDomain

route53.ARecord(self, "AliasRecord",
    zone=zone,
    target=route53.RecordTarget.from_alias(targets.UserPoolDomainTarget(domain))
)
java
import software.amazon.awscdk.services.cognito.*;

HostedZone zone;
UserPoolDomain domain;

ARecord.Builder.create(this, "AliasRecord")
        .zone(zone)
        .target(RecordTarget.fromAlias(new UserPoolDomainTarget(domain)))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.Cognito;

HostedZone zone;
UserPoolDomain domain;

new ARecord(this, "AliasRecord", new ARecordProps {
    Zone = zone,
    Target = RecordTarget.FromAlias(new UserPoolDomainTarget(domain))
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import cognito "github.com/aws/aws-cdk-go/awscdk"

var zone HostedZone
var domain UserPoolDomain

route53.NewARecord(this, jsii.String("AliasRecord"), &ARecordProps{
	Zone: Zone,
	Target: route53.RecordTarget_FromAlias(targets.NewUserPoolDomainTarget(domain)),
})

Initializer ​

ts
new UserPoolDomainTarget(domain: UserPoolDomain)
python
UserPoolDomainTarget(domain: UserPoolDomain)
java
new UserPoolDomainTarget(UserPoolDomain domain)
csharp
new UserPoolDomainTarget(UserPoolDomain domain)
go
NewUserPoolDomainTarget(Domain UserPoolDomain)

Methods ​

bind(record: IRecordSet, _zone?: IHostedZone): AliasRecordTargetConfigdef bind(self, record: IRecordSet, _zone: typing.Optional[IHostedZone] = None) -> AliasRecordTargetConfigpublic AliasRecordTargetConfig bind(IRecordSet record, IHostedZone _zone)public AliasRecordTargetConfig Bind(IRecordSet record, IHostedZone? _zone = null)func Bind(Record IRecordSet, _zone IHostedZone) AliasRecordTargetConfig#
Return hosted zone ID and DNS name, usable for Route53 alias targets.