Class UserPoolDomainOptions

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Options to create a UserPoolDomain.

public class UserPoolDomainOptions : IUserPoolDomainOptions

Inheritance

object

UserPoolDomainOptions

Implements

IUserPoolDomainOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

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
                }
            });

Remarks

ExampleMetadata: infused

Constructors

UserPoolDomainOptions()

public UserPoolDomainOptions()

Properties

CognitoDomain

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

public ICognitoDomainOptions? CognitoDomain { get; set; }

Property Value

ICognitoDomainOptions

Remarks

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

See: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html

CustomDomain

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

public ICustomDomainOptions? CustomDomain { get; set; }

Property Value

ICustomDomainOptions

Remarks

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

See: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html