interface IUserPoolDomain
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Cognito.IUserPoolDomain |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#IUserPoolDomain |
 Java | software.amazon.awscdk.services.cognito.IUserPoolDomain |
 Python | aws_cdk.aws_cognito.IUserPoolDomain |
 TypeScript (source) | aws-cdk-lib » aws_cognito » IUserPoolDomain |
Implemented by
User
Obtainable from
User.fromDomainName()
Represents a user pool domain.
Properties
| Name | Type | Description |
|---|---|---|
| domain | string | The domain that was specified to be created. |
| env | Resource | The environment this resource belongs to. |
| node | Node | The tree node. |
| stack | Stack | The stack in which this resource is defined. |
domainName
Type:
string
The domain that was specified to be created.
If customDomain was selected, this holds the full domain name that was specified.
If the cognitoDomain was used, it contains the prefix to the Cognito hosted domain.
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
| Name | Description |
|---|---|
| apply | Apply the given removal policy to this resource. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
RemovalPolicy
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN).