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

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	identity_pool_role_attachments	INSERT	IdentityPoolId, region
delete_resource	identity_pool_role_attachments	DELETE	Identifier, region
update_resource	identity_pool_role_attachments	UPDATE	Identifier, PatchDocument, region
list_resources	identity_pool_role_attachments_list_only	SELECT	region
get_resource	identity_pool_role_attachments	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual identity_pool_role_attachment.

SELECT
  region,
  identity_pool_id,
  roles,
  id,
  role_mappings
FROM awscc.cognito.identity_pool_role_attachments
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all identity_pool_role_attachments in a region.

SELECT
  region,
  id
FROM awscc.cognito.identity_pool_role_attachments_list_only
WHERE
  region = 'us-east-1';

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 awscc.cognito.identity_pool_role_attachments (
  IdentityPoolId,
  region
)
SELECT
  '{{ identity_pool_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.cognito.identity_pool_role_attachments (
  IdentityPoolId,
  Roles,
  RoleMappings,
  region
)
SELECT
  '{{ identity_pool_id }}',
  '{{ roles }}',
  '{{ role_mappings }}',
  '{{ 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: identity_pool_id
        value: '{{ identity_pool_id }}'
      - name: roles
        value: null
      - name: role_mappings
        value: null

UPDATE example

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

/*+ update */
UPDATE awscc.cognito.identity_pool_role_attachments
SET PatchDocument = string('{{ {
    "Roles": roles,
    "RoleMappings": role_mappings
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.cognito.identity_pool_role_attachments
WHERE
  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