Class CfnUserPoolDomain
A CloudFormation AWS::Cognito::UserPoolDomain
.
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class CfnUserPoolDomain : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnUserPoolDomain
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Cognito::UserPoolDomain resource creates a new domain for a user pool.
CloudformationResource: AWS::Cognito::UserPoolDomain
ExampleMetadata: fixture=_generated
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"
}
});
Synopsis
Constructors
CfnUserPoolDomain(Construct, String, ICfnUserPoolDomainProps) | Create a new |
CfnUserPoolDomain(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnUserPoolDomain(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
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. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CustomDomainConfig | The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. |
Domain | The domain name for the domain that hosts the sign-up and sign-in pages for your application. |
UserPoolId | The user pool ID for the user pool where you want to associate a user pool domain. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnUserPoolDomainProps
- resource properties.
CfnUserPoolDomain(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnUserPoolDomain(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnUserPoolDomain(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnUserPoolDomain(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
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
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
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
System.Object
Remarks
Use this object to specify an SSL certificate that is managed by ACM.
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
System.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.
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
System.String
Remarks
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 System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>