identity_pool_role_attachments

Creates, updates, deletes or gets an identity_pool_role_attachment resource or lists identity_pool_role_attachments in a region

Overview

Name	identity_pool_role_attachments
Type	Resource
Description	Resource Type definition for AWS::Cognito::IdentityPoolRoleAttachment
Id	aws.cognito.identity_pool_role_attachments

Fields

Name	Datatype	Description
identity_pool_id	string
roles
id	string
role_mappings
region	string	AWS region.

Methods

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

SELECT
region,
identity_pool_id,
roles,
id,
role_mappings
FROM aws.cognito.identity_pool_role_attachments
WHERE region = 'us-east-1';

Gets all properties from an individual identity_pool_role_attachment.

SELECT
region,
identity_pool_id,
roles,
id,
role_mappings
FROM aws.cognito.identity_pool_role_attachments
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.cognito.identity_pool_role_attachments (
 IdentityPoolId,
 region
)
SELECT 
'{{ IdentityPoolId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cognito.identity_pool_role_attachments (
 IdentityPoolId,
 Roles,
 RoleMappings,
 region
)
SELECT 
 '{{ IdentityPoolId }}',
 '{{ Roles }}',
 '{{ RoleMappings }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: identity_pool_role_attachment
    props:
      - name: IdentityPoolId
        value: '{{ IdentityPoolId }}'
      - name: Roles
        value: null
      - name: RoleMappings
        value: null

DELETE example

/*+ delete */
DELETE FROM aws.cognito.identity_pool_role_attachments
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

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

Create

cognito-identity:GetIdentityPoolRoles,
cognito-identity:SetIdentityPoolRoles,
iam:PassRole

Read

cognito-identity:GetIdentityPoolRoles

Update

cognito-identity:GetIdentityPoolRoles,
cognito-identity:SetIdentityPoolRoles,
iam:PassRole

Delete

cognito-identity:GetIdentityPoolRoles,
cognito-identity:SetIdentityPoolRoles

List

cognito-identity:GetIdentityPoolRoles