identity_sources

Creates, updates, deletes or gets an identity_source resource or lists identity_sources in a region

Overview

Name	identity_sources
Type	Resource
Description	Definition of AWS::VerifiedPermissions::IdentitySource Resource Type
Id	aws.verifiedpermissions.identity_sources

Fields

Name	Datatype	Description
configuration	undefined
details	object
identity_source_id	string
policy_store_id	string
principal_entity_type	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Configuration, PolicyStoreId, 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 identity_sources in a region.

SELECT
region,
configuration,
details,
identity_source_id,
policy_store_id,
principal_entity_type
FROM aws.verifiedpermissions.identity_sources
WHERE region = 'us-east-1';

Gets all properties from an individual identity_source.

SELECT
region,
configuration,
details,
identity_source_id,
policy_store_id,
principal_entity_type
FROM aws.verifiedpermissions.identity_sources
WHERE region = 'us-east-1' AND data__Identifier = '<IdentitySourceId>|<PolicyStoreId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.verifiedpermissions.identity_sources (
 Configuration,
 PolicyStoreId,
 region
)
SELECT 
'{{ Configuration }}',
 '{{ PolicyStoreId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.verifiedpermissions.identity_sources (
 Configuration,
 PolicyStoreId,
 PrincipalEntityType,
 region
)
SELECT 
 '{{ Configuration }}',
 '{{ PolicyStoreId }}',
 '{{ PrincipalEntityType }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: identity_source
    props:
      - name: Configuration
        value: null
      - name: PolicyStoreId
        value: '{{ PolicyStoreId }}'
      - name: PrincipalEntityType
        value: '{{ PrincipalEntityType }}'

DELETE example

/*+ delete */
DELETE FROM aws.verifiedpermissions.identity_sources
WHERE data__Identifier = '<IdentitySourceId|PolicyStoreId>'
AND region = 'us-east-1';

Permissions

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

Create

verifiedpermissions:CreateIdentitySource,
verifiedpermissions:GetIdentitySource,
cognito-idp:DescribeUserPool,
cognito-idp:ListUserPoolClients

Read

verifiedpermissions:GetIdentitySource,
cognito-idp:DescribeUserPool,
cognito-idp:ListUserPoolClients

Update

verifiedpermissions:UpdateIdentitySource,
verifiedpermissions:GetIdentitySource,
cognito-idp:DescribeUserPool,
cognito-idp:ListUserPoolClients

Delete

verifiedpermissions:DeleteIdentitySource,
verifiedpermissions:GetIdentitySource,
cognito-idp:DescribeUserPool,
cognito-idp:ListUserPoolClients

List

verifiedpermissions:ListIdentitySources,
verifiedpermissions:GetIdentitySource,
cognito-idp:DescribeUserPool,
cognito-idp:ListUserPoolClients