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	aws.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	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_poolui_customization_attachment.

SELECT
region,
user_pool_id,
client_id,
c_ss
FROM aws.cognito.user_poolui_customization_attachments
WHERE region = 'us-east-1' AND data__Identifier = '<UserPoolId>|<ClientId>';

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 aws.cognito.user_poolui_customization_attachments (
 UserPoolId,
 ClientId,
 region
)
SELECT 
'{{ UserPoolId }}',
 '{{ ClientId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cognito.user_poolui_customization_attachments (
 UserPoolId,
 ClientId,
 CSS,
 region
)
SELECT 
 '{{ UserPoolId }}',
 '{{ ClientId }}',
 '{{ CSS }}',
 '{{ 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: UserPoolId
        value: '{{ UserPoolId }}'
      - name: ClientId
        value: '{{ ClientId }}'
      - name: CSS
        value: '{{ CSS }}'

DELETE example

/*+ delete */
DELETE FROM aws.cognito.user_poolui_customization_attachments
WHERE data__Identifier = '<UserPoolId|ClientId>'
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