Package software.amazon.awscdk.services.cognito

Class CfnIdentityPoolPrincipalTag.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.CfnIdentityPoolPrincipalTag.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIdentityPoolPrincipalTag>

Enclosing class:

CfnIdentityPoolPrincipalTag

@Stability(Stable)
public static final class CfnIdentityPoolPrincipalTag.Builder
extends Object
implements software.amazon.jsii.Builder<CfnIdentityPoolPrincipalTag>

A fluent builder for CfnIdentityPoolPrincipalTag.

Method Summary

Modifier and Type	Method	Description
CfnIdentityPoolPrincipalTag	build()
static CfnIdentityPoolPrincipalTag.Builder	create(software.constructs.Construct scope, String id)
CfnIdentityPoolPrincipalTag.Builder	identityPoolId(String identityPoolId)	The identity pool that you want to associate with this principal tag map.
CfnIdentityPoolPrincipalTag.Builder	identityProviderName(String identityProviderName)	The identity pool identity provider (IdP) that you want to associate with this principal tag map.
CfnIdentityPoolPrincipalTag.Builder	principalTags(Object principalTags)	A JSON-formatted list of user claims and the principal tags that you want to associate with them.
CfnIdentityPoolPrincipalTag.Builder	useDefaults(Boolean useDefaults)	Use a default set of mappings between claims and tags for this provider, instead of a custom map.
CfnIdentityPoolPrincipalTag.Builder	useDefaults(IResolvable useDefaults)	Use a default set of mappings between claims and tags for this provider, instead of a custom map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnIdentityPoolPrincipalTag.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnIdentityPoolPrincipalTag.Builder.

identityPoolId

@Stability(Stable)
public CfnIdentityPoolPrincipalTag.Builder identityPoolId(String identityPoolId)

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

Parameters:

identityPoolId - The identity pool that you want to associate with this principal tag map. This parameter is required.

Returns:

this

See Also:

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

identityProviderName

@Stability(Stable)
public CfnIdentityPoolPrincipalTag.Builder identityProviderName(String identityProviderName)

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

Parameters:

identityProviderName - The identity pool identity provider (IdP) that you want to associate with this principal tag map. This parameter is required.

Returns:

this

See Also:

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

principalTags

@Stability(Stable)
public CfnIdentityPoolPrincipalTag.Builder principalTags(Object principalTags)

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.

Parameters:

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

Returns:

this

See Also:

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

useDefaults

@Stability(Stable)
public CfnIdentityPoolPrincipalTag.Builder useDefaults(Boolean useDefaults)

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

Parameters:

useDefaults - Use a default set of mappings between claims and tags for this provider, instead of a custom map. This parameter is required.

Returns:

this

See Also:

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

useDefaults

@Stability(Stable)
public CfnIdentityPoolPrincipalTag.Builder useDefaults(IResolvable useDefaults)

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

Parameters:

useDefaults - Use a default set of mappings between claims and tags for this provider, instead of a custom map. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnIdentityPoolPrincipalTag build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnIdentityPoolPrincipalTag>

Returns:

a newly built instance of CfnIdentityPoolPrincipalTag.