Package software.amazon.awscdk.services.cognito

Interface CfnUserPoolDomainProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolDomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:04.668Z")
@Stability(Stable)
public interface CfnUserPoolDomainProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUserPoolDomain.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CfnUserPoolDomainProps cfnUserPoolDomainProps = CfnUserPoolDomainProps.builder()
         .domain("domain")
         .userPoolId("userPoolId")
         // the properties below are optional
         .customDomainConfig(CustomDomainConfigTypeProperty.builder()
                 .certificateArn("certificateArn")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPoolDomainProps.Builder	A builder for CfnUserPoolDomainProps
static final class	CfnUserPoolDomainProps.Jsii$Proxy	An implementation for CfnUserPoolDomainProps

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolDomainProps.Builder	builder()
default Object	getCustomDomainConfig()	The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
String	getDomain()	The domain name for the domain that hosts the sign-up and sign-in pages for your application.
String	getUserPoolId()	The user pool ID for the user pool where you want to associate a user pool domain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomain

@Stability(Stable)
@NotNull
String getDomain()

The domain name for the domain that hosts the sign-up and sign-in pages for your application.

For example: auth.example.com . If you're using a prefix domain, this field denotes the first part of the domain before .auth.[region].amazoncognito.com .

This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-domain

getUserPoolId

@Stability(Stable)
@NotNull
String getUserPoolId()

The user pool ID for the user pool where you want to associate a user pool domain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-userpoolid

getCustomDomainConfig

@Stability(Stable)
@Nullable
default Object getCustomDomainConfig()

The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.

Use this object to specify an SSL certificate that is managed by ACM.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooldomain.html#cfn-cognito-userpooldomain-customdomainconfig

builder

@Stability(Stable)
static CfnUserPoolDomainProps.Builder builder()

Returns:

a CfnUserPoolDomainProps.Builder of CfnUserPoolDomainProps