Class CustomDomainOptions

Options while specifying custom domain.

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()

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CustomDomainOptions : ICustomDomainOptions

Syntax (vb)

Public Class CustomDomainOptions Implements ICustomDomainOptions

Remarks

See: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.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

CustomDomainOptions()

Options while specifying custom domain.

Properties

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

Constructors

CustomDomainOptions()

Options while specifying custom domain.

public CustomDomainOptions()

Remarks

See: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.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

Certificate

The certificate to associate with this domain.

public ICertificateRef Certificate { get; set; }

Property Value

ICertificateRef

Remarks

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

ExampleMetadata: infused

DomainName

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

public string DomainName { get; set; }

Property Value

string

Remarks

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

ExampleMetadata: infused

Implements

ICustomDomainOptions