AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

A container for information about the user pool domain associated with the hosted UI and OAuth endpoints.

Inheritance Hierarchy

System.Object
  Amazon.CognitoIdentityProvider.Model.DomainDescriptionType

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C#
public class DomainDescriptionType

The DomainDescriptionType type exposes the following members

Constructors

NameDescription
Public Method DomainDescriptionType()

Properties

NameTypeDescription
Public Property AWSAccountId System.String

Gets and sets the property AWSAccountId.

The Amazon Web Services account that you created the user pool in.

Public Property CloudFrontDistribution System.String

Gets and sets the property CloudFrontDistribution.

The Amazon CloudFront endpoint that hosts your custom domain.

Public Property CustomDomainConfig Amazon.CognitoIdentityProvider.Model.CustomDomainConfigType

Gets and sets the property CustomDomainConfig.

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

Public Property Domain System.String

Gets and sets the property Domain.

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

Public Property ManagedLoginVersion System.Int32

Gets and sets the property ManagedLoginVersion.

The version of managed login branding that you want to apply to your domain. A value of 1 indicates hosted UI (classic) branding and a version of 2 indicates managed login branding.

Managed login requires that your user pool be configured for any feature plan other than Lite.

Public Property S3Bucket System.String

Gets and sets the property S3Bucket.

The Amazon S3 bucket where the static files for this domain are stored.

Public Property Status Amazon.CognitoIdentityProvider.DomainStatusType

Gets and sets the property Status.

The domain status.

Public Property UserPoolId System.String

Gets and sets the property UserPoolId.

The ID of the user pool that the domain is attached to.

Public Property Version System.String

Gets and sets the property Version.

The app version.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5