Skip to main content

User Pool Domain

Manages a Cognito User Pool Domain.

Sample code

Create a user pool domain provider by Cognito:

exports.createResources = () => [
{
type: "UserPoolDomain",
group: "CognitoIdentityServiceProvider",
properties: ({}) => ({
Domain: "my-user-pool-domain",
}),
dependencies: () => ({ userPool: "my-user-pool" }),
},
];

Create a user pool domain attached to a ACM certificate:

exports.createResources = () => [
{
type: "UserPoolDomain",
group: "CognitoIdentityServiceProvider",
name: "auth.grucloud.org",
dependencies: () => ({
userPool: "my-user-pool",
certificate: "grucloud.org",
}),
},
];

Properties

Dependencies

Full Examples

List

The user pool domains can be filtered with the CognitoIdentityServiceProvider::UserPoolDomain type:

gc l -t CognitoIdentityServiceProvider::UserPoolDomain
Listing resources on 1 provider: aws
✓ aws
✓ Initialising
✓ Listing 2/2
┌────────────────────────────────────────────────────────────────────────┐
│ 1 CognitoIdentityServiceProvider::UserPoolDomain from aws │
├────────────────────────────────────────────────────────────────────────┤
│ name: grucloudtest │
│ managedByUs: Yes │
│ live: │
│ AWSAccountId: 840541460064 │
│ CloudFrontDistribution: d3oia8etllorh5.cloudfront.net │
│ CustomDomainConfig: │
│ Domain: grucloudtest │
│ S3Bucket: aws-cognito-prod-iad-assets │
│ Status: ACTIVE │
│ UserPoolId: us-east-1_tDHdxw26v │
│ Version: 20220313205736 │
│ │
└────────────────────────────────────────────────────────────────────────┘


List Summary:
Provider: aws
┌───────────────────────────────────────────────────────────────────────┐
│ aws │
├────────────────────────────────────────────────┬──────────────────────┤
│ CognitoIdentityServiceProvider::UserPoolDomain │ grucloudtest │
└────────────────────────────────────────────────┴──────────────────────┘
1 resource, 1 type, 1 provider
Command "gc l -t CognitoIdentityServiceProvider::UserPoolDomain" executed in 4s, 131 MB