Package software.amazon.awscdk.services.cognito

Class CfnIdentityPool.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.CfnIdentityPool.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIdentityPool>

Enclosing class:

CfnIdentityPool

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

A fluent builder for CfnIdentityPool.

Method Summary

Modifier and Type	Method	Description
CfnIdentityPool.Builder	allowClassicFlow(Boolean allowClassicFlow)	Enables the Basic (Classic) authentication flow.
CfnIdentityPool.Builder	allowClassicFlow(IResolvable allowClassicFlow)	Enables the Basic (Classic) authentication flow.
CfnIdentityPool.Builder	allowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)	Specifies whether the identity pool supports unauthenticated logins.
CfnIdentityPool.Builder	allowUnauthenticatedIdentities(IResolvable allowUnauthenticatedIdentities)	Specifies whether the identity pool supports unauthenticated logins.
CfnIdentityPool	build()
CfnIdentityPool.Builder	cognitoEvents(Object cognitoEvents)	The events to configure.
CfnIdentityPool.Builder	cognitoIdentityProviders(List<? extends Object> cognitoIdentityProviders)	The Amazon Cognito user pools and their client IDs.
CfnIdentityPool.Builder	cognitoIdentityProviders(IResolvable cognitoIdentityProviders)	The Amazon Cognito user pools and their client IDs.
CfnIdentityPool.Builder	cognitoStreams(IResolvable cognitoStreams)	Configuration options for configuring Amazon Cognito streams.
CfnIdentityPool.Builder	cognitoStreams(CfnIdentityPool.CognitoStreamsProperty cognitoStreams)	Configuration options for configuring Amazon Cognito streams.
static CfnIdentityPool.Builder	create(software.constructs.Construct scope, String id)
CfnIdentityPool.Builder	developerProviderName(String developerProviderName)	The "domain" Amazon Cognito uses when referencing your users.
CfnIdentityPool.Builder	identityPoolName(String identityPoolName)	The name of your Amazon Cognito identity pool.
CfnIdentityPool.Builder	identityPoolTags(List<? extends CfnTag> identityPoolTags)	Tags to assign to the identity pool.
CfnIdentityPool.Builder	openIdConnectProviderArns(List<String> openIdConnectProviderArns)	The Amazon Resource Names (ARNs) of the OpenID connect providers.
CfnIdentityPool.Builder	pushSync(IResolvable pushSync)	The configuration options to be applied to the identity pool.
CfnIdentityPool.Builder	pushSync(CfnIdentityPool.PushSyncProperty pushSync)	The configuration options to be applied to the identity pool.
CfnIdentityPool.Builder	samlProviderArns(List<String> samlProviderArns)	The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
CfnIdentityPool.Builder	supportedLoginProviders(Object supportedLoginProviders)	Key-value pairs that map provider names to provider app IDs.

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 CfnIdentityPool.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 CfnIdentityPool.Builder.

allowUnauthenticatedIdentities

@Stability(Stable)
public CfnIdentityPool.Builder allowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)

Specifies whether the identity pool supports unauthenticated logins.

Parameters:

allowUnauthenticatedIdentities - Specifies whether the identity pool supports unauthenticated logins. This parameter is required.

Returns:

this

See Also:

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

allowUnauthenticatedIdentities

@Stability(Stable)
public CfnIdentityPool.Builder allowUnauthenticatedIdentities(IResolvable allowUnauthenticatedIdentities)

Specifies whether the identity pool supports unauthenticated logins.

Parameters:

allowUnauthenticatedIdentities - Specifies whether the identity pool supports unauthenticated logins. This parameter is required.

Returns:

this

See Also:

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

allowClassicFlow

@Stability(Stable)
public CfnIdentityPool.Builder allowClassicFlow(Boolean allowClassicFlow)

Enables the Basic (Classic) authentication flow.

Parameters:

allowClassicFlow - Enables the Basic (Classic) authentication flow. This parameter is required.

Returns:

this

See Also:

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

allowClassicFlow

@Stability(Stable)
public CfnIdentityPool.Builder allowClassicFlow(IResolvable allowClassicFlow)

Enables the Basic (Classic) authentication flow.

Parameters:

allowClassicFlow - Enables the Basic (Classic) authentication flow. This parameter is required.

Returns:

this

See Also:

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

cognitoEvents

@Stability(Stable)
public CfnIdentityPool.Builder cognitoEvents(Object cognitoEvents)

The events to configure.

Parameters:

cognitoEvents - The events to configure. This parameter is required.

Returns:

this

See Also:

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

cognitoIdentityProviders

@Stability(Stable)
public CfnIdentityPool.Builder cognitoIdentityProviders(IResolvable cognitoIdentityProviders)

The Amazon Cognito user pools and their client IDs.

Parameters:

cognitoIdentityProviders - The Amazon Cognito user pools and their client IDs. This parameter is required.

Returns:

this

See Also:

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

cognitoIdentityProviders

@Stability(Stable)
public CfnIdentityPool.Builder cognitoIdentityProviders(List<? extends Object> cognitoIdentityProviders)

The Amazon Cognito user pools and their client IDs.

Parameters:

cognitoIdentityProviders - The Amazon Cognito user pools and their client IDs. This parameter is required.

Returns:

this

See Also:

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

cognitoStreams

@Stability(Stable)
public CfnIdentityPool.Builder cognitoStreams(IResolvable cognitoStreams)

Configuration options for configuring Amazon Cognito streams.

Parameters:

cognitoStreams - Configuration options for configuring Amazon Cognito streams. This parameter is required.

Returns:

this

See Also:

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

cognitoStreams

@Stability(Stable)
public CfnIdentityPool.Builder cognitoStreams(CfnIdentityPool.CognitoStreamsProperty cognitoStreams)

Configuration options for configuring Amazon Cognito streams.

Parameters:

cognitoStreams - Configuration options for configuring Amazon Cognito streams. This parameter is required.

Returns:

this

See Also:

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

developerProviderName

@Stability(Stable)
public CfnIdentityPool.Builder developerProviderName(String developerProviderName)

The "domain" Amazon Cognito uses when referencing your users.

This name acts as a placeholder that allows your backend and the Amazon Cognito service to communicate about the developer provider. For the DeveloperProviderName , you can use letters and periods (.), underscores (_), and dashes (-).

Minimum length : 1

Maximum length : 100

Parameters:

developerProviderName - The "domain" Amazon Cognito uses when referencing your users. This parameter is required.

Returns:

this

See Also:

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

identityPoolName

@Stability(Stable)
public CfnIdentityPool.Builder identityPoolName(String identityPoolName)

The name of your Amazon Cognito identity pool.

Minimum length : 1

Maximum length : 128

Pattern : [\w\s+=,.@-]+

Parameters:

identityPoolName - The name of your Amazon Cognito identity pool. This parameter is required.

Returns:

this

See Also:

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

identityPoolTags

@Stability(Stable)
public CfnIdentityPool.Builder identityPoolTags(List<? extends CfnTag> identityPoolTags)

Tags to assign to the identity pool.

A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

Parameters:

identityPoolTags - Tags to assign to the identity pool. This parameter is required.

Returns:

this

See Also:

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

openIdConnectProviderArns

@Stability(Stable)
public CfnIdentityPool.Builder openIdConnectProviderArns(List<String> openIdConnectProviderArns)

The Amazon Resource Names (ARNs) of the OpenID connect providers.

Parameters:

openIdConnectProviderArns - The Amazon Resource Names (ARNs) of the OpenID connect providers. This parameter is required.

Returns:

this

See Also:

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

pushSync

@Stability(Stable)
public CfnIdentityPool.Builder pushSync(IResolvable pushSync)

The configuration options to be applied to the identity pool.

Parameters:

pushSync - The configuration options to be applied to the identity pool. This parameter is required.

Returns:

this

See Also:

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

pushSync

@Stability(Stable)
public CfnIdentityPool.Builder pushSync(CfnIdentityPool.PushSyncProperty pushSync)

The configuration options to be applied to the identity pool.

Parameters:

pushSync - The configuration options to be applied to the identity pool. This parameter is required.

Returns:

this

See Also:

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

samlProviderArns

@Stability(Stable)
public CfnIdentityPool.Builder samlProviderArns(List<String> samlProviderArns)

The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.

Parameters:

samlProviderArns - The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers. This parameter is required.

Returns:

this

See Also:

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

supportedLoginProviders

@Stability(Stable)
public CfnIdentityPool.Builder supportedLoginProviders(Object supportedLoginProviders)

Key-value pairs that map provider names to provider app IDs.

Parameters:

supportedLoginProviders - Key-value pairs that map provider names to provider app IDs. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnIdentityPool build()

Specified by:

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

Returns:

a newly built instance of CfnIdentityPool.