CfnIdentityPoolPrincipalTagProps

class aws_cdk.aws_cognito.CfnIdentityPoolPrincipalTagProps(*, identity_pool_id, identity_provider_name, principal_tags=None, use_defaults=None)

Bases: object

Properties for defining a CfnIdentityPoolPrincipalTag.

Parameters:

  • identity_pool_id (str) – The identity pool that you want to associate with this principal tag map.

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

  • principal_tags (Optional[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.

  • use_defaults (Union[bool, IResolvable, None]) – Use a default set of mappings between claims and tags for this provider, instead of a custom map.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito

# principal_tags: Any

cfn_identity_pool_principal_tag_props = cognito.CfnIdentityPoolPrincipalTagProps(
    identity_pool_id="identityPoolId",
    identity_provider_name="identityProviderName",

    # the properties below are optional
    principal_tags=principal_tags,
    use_defaults=False
)

Attributes

identity_pool_id

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html#cfn-cognito-identitypoolprincipaltag-identitypoolid

identity_provider_name

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html#cfn-cognito-identitypoolprincipaltag-identityprovidername

principal_tags

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html#cfn-cognito-identitypoolprincipaltag-principaltags

use_defaults

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html#cfn-cognito-identitypoolprincipaltag-usedefaults