identity_pools

Creates, updates, deletes, gets or lists an identity_pools resource.

Overview

Name	identity_pools
Type	Resource
Id	aws.cognito_identity.identity_pools

Fields

The following fields are returned by SELECT queries:

describe_identity_pool

Name	Datatype	Description
allow_classic_flow	boolean	Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
allow_unauthenticated_identities	boolean	TRUE if the identity pool supports unauthenticated logins.
cognito_identity_providers	array	A list representing an Amazon Cognito user pool and its client ID.
developer_provider_name	string	The "domain" by which Cognito will refer to your users. (pattern: <code>[\w._-]+</code>)
identity_pool_id	string	An identity pool ID in the format REGION:GUID. (pattern: <code>[\w-]+:[0-9a-f-]+</code>)
identity_pool_name	string	A string that you provide. (pattern: <code>[\w\s+=,.@-]+</code>)
identity_pool_tags	object	The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
open_id_connect_provider_arns	array	The ARNs of the OpenID Connect providers.
saml_provider_arns	array	An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
supported_login_providers	object	Optional key:value pairs mapping provider names to provider app IDs.

list_identity_pools

Name	Datatype	Description
identity_pool_id	string	An identity pool ID in the format REGION:GUID. (pattern: <code>[\w-]+:[0-9a-f-]+</code>)
identity_pool_name	string	A string that you provide. (pattern: <code>[\w\s+=,.@-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_identity_pool	select	region		Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. You must use Amazon Web Services developer credentials to call this operation.
list_identity_pools	select	region		Lists all of the Cognito identity pools registered for your account. You must use Amazon Web Services developer credentials to call this operation.
create_identity_pool	insert	region, IdentityPoolName, AllowUnauthenticatedIdentities		Creates a new identity pool. The identity pool is a store of user identity information that is specific to your Amazon Web Services account. The keys for SupportedLoginProviders are as follows: Facebook: graph.facebook.com Google: accounts.google.com Sign in With Apple: appleid.apple.com Amazon: www.amazon.com Twitter: api.twitter.com Digits: www.digits.com If you don't provide a value for a parameter, Amazon Cognito sets it to its default value. You must use Amazon Web Services developer credentials to call this operation.
update_identity_pool	update	region, IdentityPoolId, IdentityPoolName, AllowUnauthenticatedIdentities		Updates the configuration of an identity pool. If you don't provide a value for a parameter, Amazon Cognito sets it to its default value. You must use Amazon Web Services developer credentials to call this operation.
delete_identity_pool	delete	region		Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool. You must use Amazon Web Services developer credentials to call this operation.
unlink_developer_identity	exec	region, IdentityId, IdentityPoolId, DeveloperProviderName, DeveloperUserIdentifier		Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible. You must use Amazon Web Services developer credentials to call this operation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_identity_pool

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. You must use Amazon Web Services developer credentials to call this operation.

SELECT
allow_classic_flow,
allow_unauthenticated_identities,
cognito_identity_providers,
developer_provider_name,
identity_pool_id,
identity_pool_name,
identity_pool_tags,
open_id_connect_provider_arns,
saml_provider_arns,
supported_login_providers
FROM aws.cognito_identity.identity_pools
WHERE region = '{{ region }}' -- required
;

list_identity_pools

Lists all of the Cognito identity pools registered for your account. You must use Amazon Web Services developer credentials to call this operation.

SELECT
identity_pool_id,
identity_pool_name
FROM aws.cognito_identity.identity_pools
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_identity_pool

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your Amazon Web Services account. The keys for SupportedLoginProviders are as follows: Facebook: graph.facebook.com Google: accounts.google.com Sign in With Apple: appleid.apple.com Amazon: www.amazon.com Twitter: api.twitter.com Digits: www.digits.com If you don't provide a value for a parameter, Amazon Cognito sets it to its default value. You must use Amazon Web Services developer credentials to call this operation.

INSERT INTO aws.cognito_identity.identity_pools (
IdentityPoolName,
AllowUnauthenticatedIdentities,
AllowClassicFlow,
SupportedLoginProviders,
DeveloperProviderName,
OpenIdConnectProviderARNs,
CognitoIdentityProviders,
SamlProviderARNs,
IdentityPoolTags,
region
)
SELECT 
'{{ IdentityPoolName }}' /* required */,
{{ AllowUnauthenticatedIdentities }} /* required */,
{{ AllowClassicFlow }},
'{{ SupportedLoginProviders }}',
'{{ DeveloperProviderName }}',
'{{ OpenIdConnectProviderARNs }}',
'{{ CognitoIdentityProviders }}',
'{{ SamlProviderARNs }}',
'{{ IdentityPoolTags }}',
'{{ region }}'
RETURNING
allow_classic_flow,
allow_unauthenticated_identities,
cognito_identity_providers,
developer_provider_name,
identity_pool_id,
identity_pool_name,
identity_pool_tags,
open_id_connect_provider_arns,
saml_provider_arns,
supported_login_providers
;

Manifest

# Description fields are for documentation purposes
- name: identity_pools
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the identity_pools resource.
  - name: IdentityPoolName
    value: "{{ IdentityPoolName }}"
    description: |
      A string that you provide.
  - name: AllowUnauthenticatedIdentities
    value: {{ AllowUnauthenticatedIdentities }}
    description: |
      TRUE if the identity pool supports unauthenticated logins.
  - name: AllowClassicFlow
    value: {{ AllowClassicFlow }}
    description: |
      Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
  - name: SupportedLoginProviders
    value: "{{ SupportedLoginProviders }}"
    description: |
      Optional key:value pairs mapping provider names to provider app IDs.
  - name: DeveloperProviderName
    value: "{{ DeveloperProviderName }}"
    description: |
      The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-). Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
  - name: OpenIdConnectProviderARNs
    value:
      - "{{ OpenIdConnectProviderARNs }}"
    description: |
      The Amazon Resource Names (ARN) of the OpenID Connect providers.
  - name: CognitoIdentityProviders
    description: |
      An array of Amazon Cognito user pools and their client IDs.
    value:
      - ProviderName: "{{ ProviderName }}"
        ClientId: "{{ ClientId }}"
        ServerSideTokenCheck: {{ ServerSideTokenCheck }}
  - name: SamlProviderARNs
    value:
      - "{{ SamlProviderARNs }}"
    description: |
      An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
  - name: IdentityPoolTags
    value: "{{ IdentityPoolTags }}"
    description: |
      Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

UPDATE examples

update_identity_pool

Updates the configuration of an identity pool. If you don't provide a value for a parameter, Amazon Cognito sets it to its default value. You must use Amazon Web Services developer credentials to call this operation.

UPDATE aws.cognito_identity.identity_pools
SET 
IdentityPoolId = '{{ IdentityPoolId }}',
IdentityPoolName = '{{ IdentityPoolName }}',
AllowUnauthenticatedIdentities = {{ AllowUnauthenticatedIdentities }},
AllowClassicFlow = {{ AllowClassicFlow }},
SupportedLoginProviders = '{{ SupportedLoginProviders }}',
DeveloperProviderName = '{{ DeveloperProviderName }}',
OpenIdConnectProviderARNs = '{{ OpenIdConnectProviderARNs }}',
CognitoIdentityProviders = '{{ CognitoIdentityProviders }}',
SamlProviderARNs = '{{ SamlProviderARNs }}',
IdentityPoolTags = '{{ IdentityPoolTags }}'
WHERE 
region = '{{ region }}' --required
AND IdentityPoolId = '{{ IdentityPoolId }}' --required
AND IdentityPoolName = '{{ IdentityPoolName }}' --required
AND AllowUnauthenticatedIdentities = {{ AllowUnauthenticatedIdentities }} --required
RETURNING
allow_classic_flow,
allow_unauthenticated_identities,
cognito_identity_providers,
developer_provider_name,
identity_pool_id,
identity_pool_name,
identity_pool_tags,
open_id_connect_provider_arns,
saml_provider_arns,
supported_login_providers;

DELETE examples

delete_identity_pool

Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool. You must use Amazon Web Services developer credentials to call this operation.

DELETE FROM aws.cognito_identity.identity_pools
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

unlink_developer_identity

Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible. You must use Amazon Web Services developer credentials to call this operation.

EXEC aws.cognito_identity.identity_pools.unlink_developer_identity 
@region='{{ region }}' --required 
@@json=
'{
"IdentityId": "{{ IdentityId }}", 
"IdentityPoolId": "{{ IdentityPoolId }}", 
"DeveloperProviderName": "{{ DeveloperProviderName }}", 
"DeveloperUserIdentifier": "{{ DeveloperUserIdentifier }}"
}'
;