Package software.amazon.awscdk.services.cognito

Interface CfnIdentityPoolPrincipalTagProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdentityPoolPrincipalTagProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:16.577Z")
@Stability(Stable)
public interface CfnIdentityPoolPrincipalTagProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIdentityPoolPrincipalTag.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 Object principalTags;
 CfnIdentityPoolPrincipalTagProps cfnIdentityPoolPrincipalTagProps = CfnIdentityPoolPrincipalTagProps.builder()
         .identityPoolId("identityPoolId")
         .identityProviderName("identityProviderName")
         // the properties below are optional
         .principalTags(principalTags)
         .useDefaults(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIdentityPoolPrincipalTagProps.Builder	A builder for CfnIdentityPoolPrincipalTagProps
static final class	CfnIdentityPoolPrincipalTagProps.Jsii$Proxy	An implementation for CfnIdentityPoolPrincipalTagProps

Method Summary

Modifier and Type	Method	Description
static CfnIdentityPoolPrincipalTagProps.Builder	builder()
String	getIdentityPoolId()	The identity pool that you want to associate with this principal tag map.
String	getIdentityProviderName()	The identity pool identity provider (IdP) that you want to associate with this principal tag map.
default Object	getPrincipalTags()	A JSON-formatted list of user claims and the principal tags that you want to associate with them.
default Object	getUseDefaults()	Use a default set of mappings between claims and tags for this provider, instead of a custom map.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIdentityPoolId

@Stability(Stable)
@NotNull
String getIdentityPoolId()

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

See Also:

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

getIdentityProviderName

@Stability(Stable)
@NotNull
String getIdentityProviderName()

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

See Also:

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

getPrincipalTags

@Stability(Stable)
@Nullable
default Object getPrincipalTags()

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 Also:

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

getUseDefaults

@Stability(Stable)
@Nullable
default Object getUseDefaults()

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

See Also:

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

builder

@Stability(Stable)
static CfnIdentityPoolPrincipalTagProps.Builder builder()

Returns:

a CfnIdentityPoolPrincipalTagProps.Builder of CfnIdentityPoolPrincipalTagProps