Class CustomDomainOptions

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Options while specifying custom domain.

public class CustomDomainOptions : ICustomDomainOptions

Inheritance

object

CustomDomainOptions

Implements

ICustomDomainOptions

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

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

ExampleMetadata: infused

Constructors

CustomDomainOptions()

public CustomDomainOptions()

Properties

Certificate

The certificate to associate with this domain.

public ICertificate Certificate { get; set; }

Property Value

ICertificate

DomainName

The custom domain name that you would like to associate with this User Pool.

public string DomainName { get; set; }

Property Value

string