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	awscc.cognito.user_pool_identity_providers

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
user_pool_id	string
provider_name	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	user_pool_identity_providers	INSERT	UserPoolId, ProviderName, ProviderType, ProviderDetails, region
delete_resource	user_pool_identity_providers	DELETE	Identifier, region
update_resource	user_pool_identity_providers	UPDATE	Identifier, PatchDocument, region
list_resources	user_pool_identity_providers_list_only	SELECT	region
get_resource	user_pool_identity_providers	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.cognito.user_pool_identity_providers
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ user_pool_id }}|{{ provider_name }}';

list (identifiers only)

Lists all user_pool_identity_providers in a region.

SELECT
  region,
  user_pool_id,
  provider_name
FROM awscc.cognito.user_pool_identity_providers_list_only
WHERE
  region = '{{ region }}';

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 awscc.cognito.user_pool_identity_providers (
  UserPoolId,
  ProviderName,
  ProviderType,
  ProviderDetails,
  region
)
SELECT
  '{{ user_pool_id }}',
  '{{ provider_name }}',
  '{{ provider_type }}',
  '{{ provider_details }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.cognito.user_pool_identity_providers (
  UserPoolId,
  ProviderName,
  ProviderType,
  ProviderDetails,
  IdpIdentifiers,
  AttributeMapping,
  region
)
SELECT
  '{{ user_pool_id }}',
  '{{ provider_name }}',
  '{{ provider_type }}',
  '{{ provider_details }}',
  '{{ idp_identifiers }}',
  '{{ attribute_mapping }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: user_pool_id
      value: '{{ user_pool_id }}'
    - name: provider_name
      value: '{{ provider_name }}'
    - name: provider_type
      value: '{{ provider_type }}'
    - name: provider_details
      value: {}
    - name: idp_identifiers
      value:
        - '{{ idp_identifiers[0] }}'
    - name: attribute_mapping
      value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.cognito.user_pool_identity_providers
SET PatchDocument = string('{{ {
    "ProviderDetails": provider_details,
    "IdpIdentifiers": idp_identifiers,
    "AttributeMapping": attribute_mapping
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ user_pool_id }}|{{ provider_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.cognito.user_pool_identity_providers
WHERE
  Identifier = '{{ user_pool_id }}|{{ provider_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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