user_pool

Gets an individual user_pool resource

Overview

Name	user_pool
Type	Resource
Description	user_pool
Id	awscc.cognito.user_pool

Fields

Name	Datatype	Description
user_pool_name	string
policies	object
account_recovery_setting	object
admin_create_user_config	object
alias_attributes	array
username_attributes	array
auto_verified_attributes	array
device_configuration	object
email_configuration	object
email_verification_message	string
email_verification_subject	string
deletion_protection	string
lambda_config	object
mfa_configuration	string
enabled_mfas	array
sms_authentication_message	string
sms_configuration	object
sms_verification_message	string
schema	array
username_configuration	object
user_attribute_update_settings	object
user_pool_tags	object
verification_message_template	object
user_pool_add_ons	object
provider_name	string
provider_url	string
arn	string
user_pool_id	string
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
user_pool_name,
policies,
account_recovery_setting,
admin_create_user_config,
alias_attributes,
username_attributes,
auto_verified_attributes,
device_configuration,
email_configuration,
email_verification_message,
email_verification_subject,
deletion_protection,
lambda_config,
mfa_configuration,
enabled_mfas,
sms_authentication_message,
sms_configuration,
sms_verification_message,
schema,
username_configuration,
user_attribute_update_settings,
user_pool_tags,
verification_message_template,
user_pool_add_ons,
provider_name,
provider_url,
arn,
user_pool_id
FROM awscc.cognito.user_pool
WHERE data__Identifier = '<UserPoolId>';

Permissions

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

Read

cognito-idp:DescribeUserPool

Update

cognito-idp:UpdateUserPool,
cognito-idp:ListTagsForResource,
cognito-idp:UntagResource,
cognito-idp:TagResource,
cognito-idp:SetUserPoolMfaConfig,
cognito-idp:AddCustomAttributes,
cognito-idp:DescribeUserPool,
iam:PassRole

Delete

cognito-idp:DeleteUserPool