Class CfnUserPoolDomain

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

A CloudFormation AWS::Cognito::UserPoolDomain.

public class CfnUserPoolDomain : CfnResource, IInspectable

Inheritance

object

CfnUserPoolDomain

Implements

IInspectable

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 cfnUserPoolDomain = new CfnUserPoolDomain(this, "MyCfnUserPoolDomain", new CfnUserPoolDomainProps {
                 Domain = "domain",
                 UserPoolId = "userPoolId",

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

Remarks

The AWS::Cognito::UserPoolDomain resource creates a new domain for a user pool.

CloudformationResource: AWS::Cognito::UserPoolDomain

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

ExampleMetadata: fixture=_generated

Constructors

CfnUserPoolDomain(Construct, string, ICfnUserPoolDomainProps)

Create a new AWS::Cognito::UserPoolDomain.

public CfnUserPoolDomain(Construct scope, string id, ICfnUserPoolDomainProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnUserPoolDomainProps

• resource properties.

Properties

AttrCloudFrontDistribution

The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

public virtual string AttrCloudFrontDistribution { get; }

Property Value

string

Remarks

CloudformationAttribute: CloudFrontDistribution

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

CustomDomainConfig

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

public virtual 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 virtual 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 virtual 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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

• tree inspector to collect and process attributes.

RenderProperties(IDictionary<string, object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>