AWS Fundamentals Logo
AWS Fundamentals
AWS::Cognito::UserPoolUser

Cognito UserPoolUser

Resource Type definition for AWS::Cognito::UserPoolUser

Properties

8 configurable properties. 1 required. Click a row to see details.

Filter:
PropertyTypeFlags
UserPoolId
string
RequiredCreate-only
ClientMetadata
object
Create-onlyWrite-only
DesiredDeliveryMediums
Array<string>
Create-onlyWrite-only
ForceAliasCreation
boolean
Create-onlyWrite-only
MessageAction
string
Create-onlyWrite-only
UserAttributes
Array<AttributeType>
Create-only
Username
string
Create-only
ValidationData
Array<AttributeType>
Create-onlyWrite-only

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Cognito::UserPoolUser

Resources:
  MyResource:
    Type: AWS::Cognito::UserPoolUser
    Properties:
      UserPoolId: "my-userpoolid"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

cognito-idp:AdminCreateUsercognito-idp:AdminGetUseriam:PassRole

read

cognito-idp:AdminGetUser

delete

cognito-idp:AdminDeleteUser

list

cognito-idp:ListUsers

Get the Cognito Cheat Sheet

Everything you need to know about Cognito on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceCognito
Properties8
Required1
TaggingNot supported
Primary IDUserPoolId

Supported Operations

CreateReadDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DesiredDeliveryMediumsForceAliasCreationUserAttributesUsernameUserPoolIdValidationDataClientMetadataMessageAction

Related Resources

External Links