Class CfnUserPoolDomainProps

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Properties for defining a CfnUserPoolDomain.

public class CfnUserPoolDomainProps : ICfnUserPoolDomainProps

Inheritance

object

CfnUserPoolDomainProps

Implements

ICfnUserPoolDomainProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Cognito;

             var cfnUserPoolDomainProps = new CfnUserPoolDomainProps {
                 Domain = "domain",
                 UserPoolId = "userPoolId",

                 // the properties below are optional
                 CustomDomainConfig = new CustomDomainConfigTypeProperty {
                     CertificateArn = "certificateArn"
                 }
             };

Remarks

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

ExampleMetadata: fixture=_generated

Constructors

CfnUserPoolDomainProps()

public CfnUserPoolDomainProps()

Properties

CustomDomainConfig

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

public object? CustomDomainConfig { get; set; }

Property Value

object

Remarks

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

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

Domain

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

public string Domain { get; set; }

Property Value

string

Remarks

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.

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

UserPoolId

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

public string UserPoolId { get; set; }

Property Value

string

Remarks

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