user_pool_domains

Creates, updates, deletes or gets an user_pool_domain resource or lists user_pool_domains in a region

Overview

Name	user_pool_domains
Type	Resource
Description	Resource Type definition for AWS::Cognito::UserPoolDomain
Id	awscc.cognito.user_pool_domains

Fields

Name	Datatype	Description
user_pool_id	string
domain	string
▶custom_domain_config	object
cloud_front_distribution	string
managed_login_version	integer
region	string	AWS region.

For more information, see AWS::Cognito::UserPoolDomain.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	UserPoolId, Domain, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual user_pool_domain.

SELECT
region,
user_pool_id,
domain,
custom_domain_config,
cloud_front_distribution,
managed_login_version
FROM awscc.cognito.user_pool_domains
WHERE region = 'us-east-1' AND data__Identifier = '<UserPoolId>|<Domain>';

INSERT example

Use the following StackQL query and manifest file to create a new user_pool_domain resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.cognito.user_pool_domains (
 UserPoolId,
 Domain,
 region
)
SELECT 
'{{ UserPoolId }}',
 '{{ Domain }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.cognito.user_pool_domains (
 UserPoolId,
 Domain,
 CustomDomainConfig,
 ManagedLoginVersion,
 region
)
SELECT 
 '{{ UserPoolId }}',
 '{{ Domain }}',
 '{{ CustomDomainConfig }}',
 '{{ ManagedLoginVersion }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: user_pool_domain
    props:
      - name: UserPoolId
        value: '{{ UserPoolId }}'
      - name: Domain
        value: '{{ Domain }}'
      - name: CustomDomainConfig
        value:
          CertificateArn: '{{ CertificateArn }}'
      - name: ManagedLoginVersion
        value: '{{ ManagedLoginVersion }}'

DELETE example

/*+ delete */
DELETE FROM awscc.cognito.user_pool_domains
WHERE data__Identifier = '<UserPoolId|Domain>'
AND region = 'us-east-1';

Permissions

To operate on the user_pool_domains resource, the following permissions are required:

Create

cognito-idp:CreateUserPoolDomain,
cognito-idp:DescribeUserPoolDomain,
cloudfront:updateDistribution

Read

cognito-idp:DescribeUserPoolDomain

Update

cognito-idp:UpdateUserPoolDomain,
cognito-idp:DescribeUserPoolDomain,
cloudfront:updateDistribution

Delete

cognito-idp:DeleteUserPoolDomain,
cognito-idp:DescribeUserPoolDomain