identity_pool_principal_tags

Expands all tag keys and values for identity_pool_principals in a region

Overview

Name	identity_pool_principal_tags
Type	Resource
Description	Resource Type definition for AWS::Cognito::IdentityPoolPrincipalTag
Id	aws.cognito.identity_pool_principal_tags

Fields

Name	Datatype	Description
identity_pool_id	string
identity_provider_name	string
use_defaults	boolean
principal_tags	object
tag_key	string	Tag key.
tag_value	string	Tag value.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	IdentityPoolId, IdentityProviderName, 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

Expands tags for all identity_pool_principals in a region.

SELECT
region,
identity_pool_id,
identity_provider_name,
use_defaults,
principal_tags,
tag_key,
tag_value
FROM aws.cognito.identity_pool_principal_tags
WHERE region = 'us-east-1';

Gets all properties from an individual identity_pool_principal_tag.

SELECT
region,
identity_pool_id,
identity_provider_name,
use_defaults,
principal_tags
FROM aws.cognito.identity_pool_principal_tags
WHERE region = 'us-east-1' AND data__Identifier = '<IdentityPoolId>|<IdentityProviderName>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.cognito.identity_pool_principal_tags (
 IdentityPoolId,
 IdentityProviderName,
 UseDefaults,
 PrincipalTags,
 region
)
SELECT 
 '{{ IdentityPoolId }}',
 '{{ IdentityProviderName }}',
 '{{ UseDefaults }}',
 '{{ PrincipalTags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: identity_pool_principal_tag
    props:
      - name: IdentityPoolId
        value: '{{ IdentityPoolId }}'
      - name: IdentityProviderName
        value: '{{ IdentityProviderName }}'
      - name: UseDefaults
        value: '{{ UseDefaults }}'
      - name: PrincipalTags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.cognito.identity_pool_principal_tags
WHERE data__Identifier = '<IdentityPoolId|IdentityProviderName>'
AND region = 'us-east-1';

Permissions

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

Create

cognito-identity:GetPrincipalTagAttributeMap,
cognito-identity:SetPrincipalTagAttributeMap

Read

cognito-identity:GetPrincipalTagAttributeMap

Update

cognito-identity:GetPrincipalTagAttributeMap,
cognito-identity:SetPrincipalTagAttributeMap

Delete

cognito-identity:GetPrincipalTagAttributeMap,
cognito-identity:SetPrincipalTagAttributeMap

List

cognito-identity:GetPrincipalTagAttributeMap