AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Cognito::IdentityPoolPrincipalTag

CfnIdentityPoolPrincipalTag

A list of the identity pool principal tag assignments for attributes for access control.

Import

import { CfnIdentityPoolPrincipalTag } from 'aws-cdk-lib/aws-cognito';

Or use the module namespace:

import * as cognito from 'aws-cdk-lib/aws-cognito';
// cognito.CfnIdentityPoolPrincipalTag

Properties

Configuration passed to the constructor as CfnIdentityPoolPrincipalTagProps.

identityPoolIdRequired
string

The identity pool that you want to associate with this principal tag map.

identityProviderNameRequired
string

The identity pool identity provider (IdP) that you want to associate with this principal tag map.

principalTagsOptional
any

A JSON-formatted list of user claims and the principal tags that you want to associate with them. When Amazon Cognito requests credentials, it sets the value of the principal tag to the value of the user's claim.

useDefaultsOptional
boolean | IResolvable

Use a default set of mappings between claims and tags for this provider, instead of a custom map.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Cognito::IdentityPoolPrincipalTagView in CloudFormation Explorer

Get the Amazon Cognito Cheat Sheet

Everything you need to know about Amazon Cognito on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-cognito
CFN TypeAWS::Cognito::IdentityPoolPrincipalTag
Properties4

Related Constructs

Explore This Service

External Links