Interface ICfnIdentityPoolPrincipalTagProps

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Properties for defining a CfnIdentityPoolPrincipalTag.

public interface ICfnIdentityPoolPrincipalTagProps

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Cognito;

             var principalTags;

             var cfnIdentityPoolPrincipalTagProps = new CfnIdentityPoolPrincipalTagProps {
                 IdentityPoolId = "identityPoolId",
                 IdentityProviderName = "identityProviderName",

                 // the properties below are optional
                 PrincipalTags = principalTags,
                 UseDefaults = false
             };

Remarks

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

ExampleMetadata: fixture=_generated

Properties

IdentityPoolId

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

string IdentityPoolId { get; }

Property Value

string

Remarks

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

IdentityProviderName

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

string IdentityProviderName { get; }

Property Value

string

Remarks

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

PrincipalTags

A JSON-formatted list of user claims and the principal tags that you want to associate with them.

object? PrincipalTags { get; }

Property Value

object

Remarks

When Amazon Cognito requests credentials, it sets the value of the principal tag to the value of the user's claim.

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

UseDefaults

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

object? UseDefaults { get; }

Property Value

object

Remarks

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