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	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	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
  Identifier = '{{ user_pool_id }}|{{ 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
  '{{ user_pool_id }}',
  '{{ domain }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.cognito.user_pool_domains (
  UserPoolId,
  Domain,
  CustomDomainConfig,
  ManagedLoginVersion,
  region
)
SELECT
  '{{ user_pool_id }}',
  '{{ domain }}',
  '{{ custom_domain_config }}',
  '{{ managed_login_version }}',
  '{{ 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: user_pool_id
        value: '{{ user_pool_id }}'
      - name: domain
        value: '{{ domain }}'
      - name: custom_domain_config
        value:
          certificate_arn: '{{ certificate_arn }}'
      - name: managed_login_version
        value: '{{ managed_login_version }}'

UPDATE example

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

/*+ update */
UPDATE awscc.cognito.user_pool_domains
SET PatchDocument = string('{{ {
    "CustomDomainConfig": custom_domain_config,
    "ManagedLoginVersion": managed_login_version
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ user_pool_id }}|{{ domain }}';

DELETE example

/*+ delete */
DELETE FROM awscc.cognito.user_pool_domains
WHERE
  Identifier = '{{ user_pool_id }}|{{ 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