aws_cognito_userpools Resource
Use the aws_cognito_userpools
InSpec audit resource to test properties of multiple Cognito user pools.
For additional information, including details on parameters and properties, see the AWS documentation on Cognito user pool.
Install
This resource is available in the Chef InSpec AWS resource pack.
For information on configuring your AWS environment for Chef InSpec and creating an InSpec profile that uses the InSpec AWS resource pack, see the Chef InSpec documentation on the AWS cloud platform.
Syntax
Ensure that a user pool exists.
describe aws_cognito_userpools do
it { should exist }
end
Parameters
This resource does not require any parameters.
Properties
ids
- The IDs of the user pools.
names
- The names of the user pools.
lambda_configs
- The lambda trigger configuration of the user pools.
statuses
- The statuses of the user pools.
last_modified_dates
- The last_modified_dates of the user pools.
creation_dates
- The creation_dates of the user pools.
Examples
Ensure an ID is available.
describe aws_cognito_userpools do
its('ids') { should include 'USER_POOL_ID' }
end
Ensure a name is available.
describe aws_cognito_userpools do
its('names') { should include 'USER_POOL_NAME' }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.The controls will pass if the list
method returns at least one result.
exist
Use should
to test that the entity exists.
describe aws_cognito_userpools do
it { should exist }
end
Use should_not
to test the entity does not exist.
describe aws_cognito_userpools do
it { should_not exist }
end
be_available
Use should
to check if the user pool is available.
describe aws_cognito_userpools do
it { should be_available }
end
AWS Permissions
Your Principal will need the CognitoIdentityProvider:Client:ListUserPoolsResponse
action with Effect
set to Allow
.