user_pools_list_only

Lists user_pools in a region or regions, for all properties use user_pools

Overview

Name	user_pools_list_only
Type	Resource
Description	Resource Type definition for AWS::Cognito::UserPool
Id	aws.cognito.user_pools_list_only

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

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all user_pools in a region.

SELECT
region,
user_pool_id
FROM aws.cognito.user_pools_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the user_pools_list_only resource, see user_pools