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 = '{{ region }}' 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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.cognito.user_pool_domains
WHERE
  Identifier = '{{ user_pool_id }}|{{ domain }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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