user_poolui_customization_attachments

Creates, updates, deletes or gets an user_poolui_customization_attachment resource or lists user_poolui_customization_attachments in a region

Overview

Name	user_poolui_customization_attachments
Type	Resource
Description	Resource Type definition for AWS::Cognito::UserPoolUICustomizationAttachment
Id	awscc.cognito.user_poolui_customization_attachments

Fields

Name	Datatype	Description
user_pool_id	string
client_id	string
c_ss	string
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	UserPoolId, ClientId, 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_poolui_customization_attachment.

SELECT
  region,
  user_pool_id,
  client_id,
  c_ss
FROM awscc.cognito.user_poolui_customization_attachments
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ user_pool_id }}|{{ client_id }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.cognito.user_poolui_customization_attachments (
  UserPoolId,
  ClientId,
  region
)
SELECT
  '{{ user_pool_id }}',
  '{{ client_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.cognito.user_poolui_customization_attachments (
  UserPoolId,
  ClientId,
  CSS,
  region
)
SELECT
  '{{ user_pool_id }}',
  '{{ client_id }}',
  '{{ c_ss }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: user_poolui_customization_attachment
    props:
      - name: user_pool_id
        value: '{{ user_pool_id }}'
      - name: client_id
        value: '{{ client_id }}'
      - name: c_ss
        value: '{{ c_ss }}'

UPDATE example

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

/*+ update */
UPDATE awscc.cognito.user_poolui_customization_attachments
SET PatchDocument = string('{{ {
    "CSS": c_ss
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ user_pool_id }}|{{ client_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.cognito.user_poolui_customization_attachments
WHERE
  Identifier = '{{ user_pool_id }}|{{ client_id }}' AND
  region = 'us-east-1';

Permissions

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

Create

cognito-idp:SetUICustomization,
cognito-idp:GetUICustomization

Read

cognito-idp:GetUICustomization

Update

cognito-idp:SetUICustomization

Delete

cognito-idp:SetUICustomization,
cognito-idp:GetUICustomization