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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
identity_pool_id	string
identity_provider_name	string
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual identity_pool_principal_tag.

SELECT
  region,
  identity_pool_id,
  identity_provider_name,
  use_defaults,
  principal_tags
FROM awscc.cognito.identity_pool_principal_tags
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ identity_pool_id }}|{{ identity_provider_name }}';

list (identifiers only)

Lists all identity_pool_principal_tags in a region.

SELECT
  region,
  identity_pool_id,
  identity_provider_name
FROM awscc.cognito.identity_pool_principal_tags_list_only
WHERE
  region = 'us-east-1';

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

All Properties

/*+ create */
INSERT INTO awscc.cognito.identity_pool_principal_tags (
  IdentityPoolId,
  IdentityProviderName,
  UseDefaults,
  PrincipalTags,
  region
)
SELECT
  '{{ identity_pool_id }}',
  '{{ identity_provider_name }}',
  '{{ use_defaults }}',
  '{{ principal_tags }}',
  '{{ 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: identity_pool_id
        value: '{{ identity_pool_id }}'
      - name: identity_provider_name
        value: '{{ identity_provider_name }}'
      - name: use_defaults
        value: '{{ use_defaults }}'
      - name: principal_tags
        value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.cognito.identity_pool_principal_tags
SET PatchDocument = string('{{ {
    "UseDefaults": use_defaults,
    "PrincipalTags": principal_tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ identity_pool_id }}|{{ identity_provider_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.cognito.identity_pool_principal_tags
WHERE
  Identifier = '{{ identity_pool_id }}|{{ identity_provider_name }}' 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