user_pool_users

Creates, updates, deletes or gets an user_pool_user resource or lists user_pool_users in a region

Overview

Name	user_pool_users
Type	Resource
Description	Resource Type definition for AWS::Cognito::UserPoolUser
Id	awscc.cognito.user_pool_users

Fields

get (all properties)

Name	Datatype	Description
desired_delivery_mediums	array
force_alias_creation	boolean
▶user_attributes	array
message_action	string
username	string
user_pool_id	string
validation_data	array
client_metadata	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
username	string
user_pool_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	user_pool_users	INSERT	UserPoolId, region
delete_resource	user_pool_users	DELETE	Identifier, region
list_resources	user_pool_users_list_only	SELECT	region
get_resource	user_pool_users	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual user_pool_user.

SELECT
  region,
  desired_delivery_mediums,
  force_alias_creation,
  user_attributes,
  message_action,
  username,
  user_pool_id,
  validation_data,
  client_metadata
FROM awscc.cognito.user_pool_users
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ user_pool_id }}|{{ username }}';

list (identifiers only)

Lists all user_pool_users in a region.

SELECT
  region,
  user_pool_id,
  username
FROM awscc.cognito.user_pool_users_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.cognito.user_pool_users (
  DesiredDeliveryMediums,
  ForceAliasCreation,
  UserAttributes,
  MessageAction,
  Username,
  UserPoolId,
  ValidationData,
  ClientMetadata,
  region
)
SELECT
  '{{ desired_delivery_mediums }}',
  '{{ force_alias_creation }}',
  '{{ user_attributes }}',
  '{{ message_action }}',
  '{{ username }}',
  '{{ user_pool_id }}',
  '{{ validation_data }}',
  '{{ client_metadata }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: user_pool_user
    props:
      - name: desired_delivery_mediums
        value:
          - '{{ desired_delivery_mediums[0] }}'
      - name: force_alias_creation
        value: '{{ force_alias_creation }}'
      - name: user_attributes
        value:
          - name: '{{ name }}'
            value: '{{ value }}'
      - name: message_action
        value: '{{ message_action }}'
      - name: username
        value: '{{ username }}'
      - name: user_pool_id
        value: '{{ user_pool_id }}'
      - name: validation_data
        value:
          - null
      - name: client_metadata
        value: {}

DELETE example

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

Permissions

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

Create

cognito-idp:AdminCreateUser,
cognito-idp:AdminGetUser,
iam:PassRole

Read

cognito-idp:AdminGetUser

Delete

cognito-idp:AdminDeleteUser

List

cognito-idp:ListUsers