Class CfnIdentityPoolPropsMixin.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnIdentityPoolPropsMixin.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnIdentityPoolPropsMixin>
- Enclosing class:
CfnIdentityPoolPropsMixin
@Stability(Stable)
public static final class CfnIdentityPoolPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnIdentityPoolPropsMixin>
A fluent builder for
CfnIdentityPoolPropsMixin.-
Method Summary
Modifier and TypeMethodDescriptionallowClassicFlow(Boolean allowClassicFlow) Enables the Basic (Classic) authentication flow.allowClassicFlow(IResolvable allowClassicFlow) Enables the Basic (Classic) authentication flow.allowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities) Specifies whether the identity pool supports unauthenticated logins.allowUnauthenticatedIdentities(IResolvable allowUnauthenticatedIdentities) Specifies whether the identity pool supports unauthenticated logins.build()cognitoEvents(Object cognitoEvents) The events to configure.cognitoIdentityProviders(List<? extends Object> cognitoIdentityProviders) The Amazon Cognito user pools and their client IDs.cognitoIdentityProviders(IResolvable cognitoIdentityProviders) The Amazon Cognito user pools and their client IDs.cognitoStreams(CfnIdentityPoolPropsMixin.CognitoStreamsProperty cognitoStreams) Configuration options for configuring Amazon Cognito streams.cognitoStreams(IResolvable cognitoStreams) Configuration options for configuring Amazon Cognito streams.create()create(CfnPropertyMixinOptions options) developerProviderName(String developerProviderName) The "domain" Amazon Cognito uses when referencing your users.identityPoolName(String identityPoolName) The name of your Amazon Cognito identity pool.identityPoolTags(List<? extends CfnTag> identityPoolTags) Tags to assign to the identity pool.openIdConnectProviderArns(List<? extends Object> openIdConnectProviderArns) The Amazon Resource Names (ARNs) of the OpenID connect providers.The configuration options to be applied to the identity pool.pushSync(IResolvable pushSync) The configuration options to be applied to the identity pool.samlProviderArns(List<String> samlProviderArns) The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.supportedLoginProviders(Object supportedLoginProviders) Key-value pairs that map provider names to provider app IDs.
-
Method Details
-
create
@Stability(Stable) public static CfnIdentityPoolPropsMixin.Builder create(CfnPropertyMixinOptions options) - Parameters:
options- Mixin options.- Returns:
- a new instance of
CfnIdentityPoolPropsMixin.Builder.
-
create
- Returns:
- a new instance of
CfnIdentityPoolPropsMixin.Builder.
-
allowClassicFlow
@Stability(Stable) public CfnIdentityPoolPropsMixin.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:
-
allowClassicFlow
@Stability(Stable) public CfnIdentityPoolPropsMixin.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:
-
allowUnauthenticatedIdentities
@Stability(Stable) public CfnIdentityPoolPropsMixin.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:
-
allowUnauthenticatedIdentities
@Stability(Stable) public CfnIdentityPoolPropsMixin.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:
-
cognitoEvents
The events to configure.- Parameters:
cognitoEvents- The events to configure. This parameter is required.- Returns:
this- See Also:
-
cognitoIdentityProviders
@Stability(Stable) public CfnIdentityPoolPropsMixin.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:
-
cognitoIdentityProviders
@Stability(Stable) public CfnIdentityPoolPropsMixin.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:
-
cognitoStreams
@Stability(Stable) public CfnIdentityPoolPropsMixin.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:
-
cognitoStreams
@Stability(Stable) public CfnIdentityPoolPropsMixin.Builder cognitoStreams(CfnIdentityPoolPropsMixin.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:
-
developerProviderName
@Stability(Stable) public CfnIdentityPoolPropsMixin.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:
-
identityPoolName
@Stability(Stable) public CfnIdentityPoolPropsMixin.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:
-
identityPoolTags
@Stability(Stable) public CfnIdentityPoolPropsMixin.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:
-
openIdConnectProviderArns
@Stability(Stable) public CfnIdentityPoolPropsMixin.Builder openIdConnectProviderArns(List<? extends Object> 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:
-
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:
-
pushSync
@Stability(Stable) public CfnIdentityPoolPropsMixin.Builder pushSync(CfnIdentityPoolPropsMixin.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:
-
samlProviderArns
@Stability(Stable) public CfnIdentityPoolPropsMixin.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:
-
supportedLoginProviders
@Stability(Stable) public CfnIdentityPoolPropsMixin.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:
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnIdentityPoolPropsMixin>- Returns:
- a newly built instance of
CfnIdentityPoolPropsMixin.
-