Class CfnIdentityPoolPrincipalTag

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

A CloudFormation AWS::Cognito::IdentityPoolPrincipalTag.

public class CfnIdentityPoolPrincipalTag : CfnResource, IInspectable

Inheritance

object

CfnIdentityPoolPrincipalTag

Implements

IInspectable

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 cfnIdentityPoolPrincipalTag = new CfnIdentityPoolPrincipalTag(this, "MyCfnIdentityPoolPrincipalTag", new CfnIdentityPoolPrincipalTagProps {
                 IdentityPoolId = "identityPoolId",
                 IdentityProviderName = "identityProviderName",

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

Remarks

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

CloudformationResource: AWS::Cognito::IdentityPoolPrincipalTag

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

ExampleMetadata: fixture=_generated

Constructors

CfnIdentityPoolPrincipalTag(Construct, string, ICfnIdentityPoolPrincipalTagProps)

Create a new AWS::Cognito::IdentityPoolPrincipalTag.

public CfnIdentityPoolPrincipalTag(Construct scope, string id, ICfnIdentityPoolPrincipalTagProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnIdentityPoolPrincipalTagProps

• resource properties.

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

IdentityPoolId

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

public virtual string IdentityPoolId { get; set; }

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.

public virtual string IdentityProviderName { get; set; }

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.

public virtual object PrincipalTags { get; set; }

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.

public virtual object? UseDefaults { get; set; }

Property Value

object

Remarks

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

• tree inspector to collect and process attributes.

RenderProperties(IDictionary<string, object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>