user_pool_user
Gets an individual user_pool_user
resource
Overview
Name | user_pool_user |
Type | Resource |
Description | user_pool_user |
Id | awscc.cognito.user_pool_user |
Fields
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. |
Methods
Currently only SELECT
is supported for this resource resource.
Example
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_user
WHERE data__Identifier = '<UserPoolId>|<Username>';
Permissions
To operate on the user_pool_user
resource, the following permissions are required:
Read
cognito-idp:AdminGetUser
Delete
cognito-idp:AdminDeleteUser