Class CognitoDomainOptions

Options while specifying a cognito prefix domain.

Inheritance

object

CognitoDomainOptions

Implements

ICognitoDomainOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CognitoDomainOptions : ICognitoDomainOptions

Syntax (vb)

Public Class CognitoDomainOptions Implements ICognitoDomainOptions

Remarks

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

ExampleMetadata: infused

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

Synopsis

Constructors

CognitoDomainOptions()

Options while specifying a cognito prefix domain.

Properties

DomainPrefix

The prefix to the Cognito hosted domain name that will be associated with the user pool.

Constructors

CognitoDomainOptions()

Options while specifying a cognito prefix domain.

public CognitoDomainOptions()

Remarks

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

ExampleMetadata: infused

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

Properties

DomainPrefix

The prefix to the Cognito hosted domain name that will be associated with the user pool.

public string DomainPrefix { get; set; }

Property Value

string

Remarks

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

ExampleMetadata: infused

Implements

ICognitoDomainOptions