user_pool_identity_providers

Creates, updates, deletes or gets an user_pool_identity_provider resource or lists user_pool_identity_providers in a region

Overview

Name	user_pool_identity_providers
Type	Resource
Description	Resource Type definition for AWS::Cognito::UserPoolIdentityProvider
Id	aws.cognito.user_pool_identity_providers

Fields

Name	Datatype	Description
user_pool_id	string
provider_name	string
provider_type	string
provider_details	object
idp_identifiers	array
attribute_mapping	object
region	string	AWS region.

For more information, see AWS::Cognito::UserPoolIdentityProvider.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	UserPoolId, ProviderName, ProviderType, ProviderDetails, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all user_pool_identity_providers in a region.

SELECT
region,
user_pool_id,
provider_name,
provider_type,
provider_details,
idp_identifiers,
attribute_mapping
FROM aws.cognito.user_pool_identity_providers
WHERE region = 'us-east-1';

Gets all properties from an individual user_pool_identity_provider.

SELECT
region,
user_pool_id,
provider_name,
provider_type,
provider_details,
idp_identifiers,
attribute_mapping
FROM aws.cognito.user_pool_identity_providers
WHERE region = 'us-east-1' AND data__Identifier = '<UserPoolId>|<ProviderName>';

INSERT example

Use the following StackQL query and manifest file to create a new user_pool_identity_provider resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.cognito.user_pool_identity_providers (
 UserPoolId,
 ProviderName,
 ProviderType,
 ProviderDetails,
 region
)
SELECT 
'{{ UserPoolId }}',
 '{{ ProviderName }}',
 '{{ ProviderType }}',
 '{{ ProviderDetails }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cognito.user_pool_identity_providers (
 UserPoolId,
 ProviderName,
 ProviderType,
 ProviderDetails,
 IdpIdentifiers,
 AttributeMapping,
 region
)
SELECT 
 '{{ UserPoolId }}',
 '{{ ProviderName }}',
 '{{ ProviderType }}',
 '{{ ProviderDetails }}',
 '{{ IdpIdentifiers }}',
 '{{ AttributeMapping }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: user_pool_identity_provider
    props:
      - name: UserPoolId
        value: '{{ UserPoolId }}'
      - name: ProviderName
        value: '{{ ProviderName }}'
      - name: ProviderType
        value: '{{ ProviderType }}'
      - name: ProviderDetails
        value: {}
      - name: IdpIdentifiers
        value:
          - '{{ IdpIdentifiers[0] }}'
      - name: AttributeMapping
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.cognito.user_pool_identity_providers
WHERE data__Identifier = '<UserPoolId|ProviderName>'
AND region = 'us-east-1';

Permissions

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

Create

cognito-idp:CreateIdentityProvider,
cognito-idp:DescribeIdentityProvider

Read

cognito-idp:DescribeIdentityProvider

Update

cognito-idp:UpdateIdentityProvider,
cognito-idp:DescribeIdentityProvider

Delete

cognito-idp:DeleteIdentityProvider,
cognito-idp:DescribeIdentityProvider

List

cognito-idp:ListIdentityProviders