identity_pool_configurations
Creates, updates, deletes, gets or lists an identity_pool_configurations resource.
Overview
| Name | identity_pool_configurations |
| Type | Resource |
| Id | aws.cognito_sync.identity_pool_configurations |
Fields
The following fields are returned by SELECT queries:
- get_identity_pool_configuration
| Name | Datatype | Description |
|---|---|---|
cognito_streams | object | Options to apply to this identity pool for Amazon Cognito streams. |
identity_pool_id | string | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. (pattern: <code>[\w-]+:[0-9a-f-]+</code>) |
push_sync | object | Options to apply to this identity pool for push synchronization. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_identity_pool_configuration | select | identity_pool_id, region | Gets the configuration settings of an identity pool. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. | |
set_identity_pool_configuration | update | identity_pool_id, region | Sets the necessary configuration for push sync. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. |
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 |
|---|---|---|
identity_pool_id | string | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_identity_pool_configuration
Gets the configuration settings of an identity pool. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
SELECT
cognito_streams,
identity_pool_id,
push_sync
FROM aws.cognito_sync.identity_pool_configurations
WHERE identity_pool_id = '{{ identity_pool_id }}' -- required
AND region = '{{ region }}' -- required
;
UPDATE examples
- set_identity_pool_configuration
Sets the necessary configuration for push sync. This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.
UPDATE aws.cognito_sync.identity_pool_configurations
SET
PushSync = '{{ PushSync }}',
CognitoStreams = '{{ CognitoStreams }}'
WHERE
identity_pool_id = '{{ identity_pool_id }}' --required
AND region = '{{ region }}' --required
RETURNING
cognito_streams,
identity_pool_id,
push_sync;