Skip to content
v2.278.0

UserPoolDomainOptions Struct ​

Options to create a UserPoolDomain.

Example ​

ts
const pool = new cognito.UserPool(this, 'Pool');

pool.addDomain('CognitoDomain', {
  cognitoDomain: {
    domainPrefix: 'my-awesome-app',
  },
});

const certificateArn = 'arn:aws:acm:us-east-1:123456789012:certificate/11-3336f1-44483d-adc7-9cd375c5169d';

const domainCert = certificatemanager.Certificate.fromCertificateArn(this, 'domainCert', certificateArn);
pool.addDomain('CustomDomain', {
  customDomain: {
    domainName: 'user.myapp.com',
    certificate: domainCert,
  },
});
python
pool = cognito.UserPool(self, "Pool")

pool.add_domain("CognitoDomain",
    cognito_domain=cognito.CognitoDomainOptions(
        domain_prefix="my-awesome-app"
    )
)

certificate_arn = "arn:aws:acm:us-east-1:123456789012:certificate/11-3336f1-44483d-adc7-9cd375c5169d"

domain_cert = certificatemanager.Certificate.from_certificate_arn(self, "domainCert", certificate_arn)
pool.add_domain("CustomDomain",
    custom_domain=cognito.CustomDomainOptions(
        domain_name="user.myapp.com",
        certificate=domain_cert
    )
)
java
UserPool pool = new UserPool(this, "Pool");

pool.addDomain("CognitoDomain", UserPoolDomainOptions.builder()
        .cognitoDomain(CognitoDomainOptions.builder()
                .domainPrefix("my-awesome-app")
                .build())
        .build());

String certificateArn = "arn:aws:acm:us-east-1:123456789012:certificate/11-3336f1-44483d-adc7-9cd375c5169d";

ICertificate domainCert = Certificate.fromCertificateArn(this, "domainCert", certificateArn);
pool.addDomain("CustomDomain", UserPoolDomainOptions.builder()
        .customDomain(CustomDomainOptions.builder()
                .domainName("user.myapp.com")
                .certificate(domainCert)
                .build())
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
var pool = new UserPool(this, "Pool");

pool.AddDomain("CognitoDomain", new UserPoolDomainOptions {
    CognitoDomain = new CognitoDomainOptions {
        DomainPrefix = "my-awesome-app"
    }
});

var certificateArn = "arn:aws:acm:us-east-1:123456789012:certificate/11-3336f1-44483d-adc7-9cd375c5169d";

var domainCert = Certificate.FromCertificateArn(this, "domainCert", certificateArn);
pool.AddDomain("CustomDomain", new UserPoolDomainOptions {
    CustomDomain = new CustomDomainOptions {
        DomainName = "user.myapp.com",
        Certificate = domainCert
    }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
pool := cognito.NewUserPool(this, jsii.String("Pool"))

pool.addDomain(jsii.String("CognitoDomain"), &UserPoolDomainOptions{
	CognitoDomain: &CognitoDomainOptions{
		DomainPrefix: jsii.String("my-awesome-app"),
	},
})

certificateArn := "arn:aws:acm:us-east-1:123456789012:certificate/11-3336f1-44483d-adc7-9cd375c5169d"

domainCert := certificatemanager.Certificate_FromCertificateArn(this, jsii.String("domainCert"), certificateArn)
pool.addDomain(jsii.String("CustomDomain"), &UserPoolDomainOptions{
	CustomDomain: &CustomDomainOptions{
		DomainName: jsii.String("user.myapp.com"),
		Certificate: domainCert,
	},
})

Properties ​

cognitoDomainoptionalCognitoDomainOptionscognito_domainoptionalCognitoDomainOptionscognitoDomainoptionalCognitoDomainOptionsCognitoDomainoptionalCognitoDomainOptionsCognitoDomainoptionalCognitoDomainOptions #
Associate a cognito prefix domain with your user pool Either `customDomain` or `cognitoDomain` must be specified.

Default: not set if customDomain is specified, otherwise, throws an error.

customDomainoptionalCustomDomainOptionscustom_domainoptionalCustomDomainOptionscustomDomainoptionalCustomDomainOptionsCustomDomainoptionalCustomDomainOptionsCustomDomainoptionalCustomDomainOptions #
Associate a custom domain with your user pool Either `customDomain` or `cognitoDomain` must be specified.

Default: not set if cognitoDomain is specified, otherwise, throws an error.

managedLoginVersionoptionalManagedLoginVersionmanaged_login_versionoptionalManagedLoginVersionmanagedLoginVersionoptionalManagedLoginVersionManagedLoginVersionoptionalManagedLoginVersionManagedLoginVersionoptionalManagedLoginVersion #
A version that indicates the state of managed login.

Default: undefined - Cognito default setting is ManagedLoginVersion.CLASSIC_HOSTED_UI

This choice applies to all app clients that host services at the domain.