software.amazon.awssdk.services.cognitoidentity.model

Interface CreateIdentityPoolRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CognitoIdentityRequest.Builder, CopyableBuilder<CreateIdentityPoolRequest.Builder,CreateIdentityPoolRequest>, SdkBuilder<CreateIdentityPoolRequest.Builder,CreateIdentityPoolRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateIdentityPoolRequest

public static interface CreateIdentityPoolRequest.Builder
extends CognitoIdentityRequest.Builder, SdkPojo, CopyableBuilder<CreateIdentityPoolRequest.Builder,CreateIdentityPoolRequest>

Method Summary

Modifier and Type	Method and Description
CreateIdentityPoolRequest.Builder	allowClassicFlow(Boolean allowClassicFlow) Enables or disables the Basic (Classic) authentication flow.
CreateIdentityPoolRequest.Builder	allowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities) TRUE if the identity pool supports unauthenticated logins.
CreateIdentityPoolRequest.Builder	cognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders) An array of Amazon Cognito user pools and their client IDs.
CreateIdentityPoolRequest.Builder	cognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders) An array of Amazon Cognito user pools and their client IDs.
CreateIdentityPoolRequest.Builder	cognitoIdentityProviders(Consumer<CognitoIdentityProvider.Builder>... cognitoIdentityProviders) An array of Amazon Cognito user pools and their client IDs.
CreateIdentityPoolRequest.Builder	developerProviderName(String developerProviderName) The "domain" by which Cognito will refer to your users.
CreateIdentityPoolRequest.Builder	identityPoolName(String identityPoolName) A string that you provide.
CreateIdentityPoolRequest.Builder	identityPoolTags(Map<String,String> identityPoolTags) Tags to assign to the identity pool.
CreateIdentityPoolRequest.Builder	openIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs) The Amazon Resource Names (ARN) of the OpenID Connect providers.
CreateIdentityPoolRequest.Builder	openIdConnectProviderARNs(String... openIdConnectProviderARNs) The Amazon Resource Names (ARN) of the OpenID Connect providers.
CreateIdentityPoolRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateIdentityPoolRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateIdentityPoolRequest.Builder	samlProviderARNs(Collection<String> samlProviderARNs) An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
CreateIdentityPoolRequest.Builder	samlProviderARNs(String... samlProviderARNs) An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
CreateIdentityPoolRequest.Builder	supportedLoginProviders(Map<String,String> supportedLoginProviders) Optional key:value pairs mapping provider names to provider app IDs.

Methods inherited from interface software.amazon.awssdk.services.cognitoidentity.model.CognitoIdentityRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

identityPoolName

CreateIdentityPoolRequest.Builder identityPoolName(String identityPoolName)

A string that you provide.

Parameters:

identityPoolName - A string that you provide.

Returns:

Returns a reference to this object so that method calls can be chained together.

allowUnauthenticatedIdentities

CreateIdentityPoolRequest.Builder allowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)

TRUE if the identity pool supports unauthenticated logins.

Parameters:

allowUnauthenticatedIdentities - TRUE if the identity pool supports unauthenticated logins.

Returns:

Returns a reference to this object so that method calls can be chained together.

allowClassicFlow

CreateIdentityPoolRequest.Builder allowClassicFlow(Boolean allowClassicFlow)

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

Parameters:

allowClassicFlow - Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedLoginProviders

CreateIdentityPoolRequest.Builder supportedLoginProviders(Map<String,String> supportedLoginProviders)

Optional key:value pairs mapping provider names to provider app IDs.

Parameters:

supportedLoginProviders - Optional key:value pairs mapping provider names to provider app IDs.

Returns:

Returns a reference to this object so that method calls can be chained together.

developerProviderName

CreateIdentityPoolRequest.Builder developerProviderName(String developerProviderName)

The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore ( _), and dash (-).

Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

Parameters:

developerProviderName - The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

openIdConnectProviderARNs

CreateIdentityPoolRequest.Builder openIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs)

The Amazon Resource Names (ARN) of the OpenID Connect providers.

Parameters:

openIdConnectProviderARNs - The Amazon Resource Names (ARN) of the OpenID Connect providers.

Returns:

Returns a reference to this object so that method calls can be chained together.

openIdConnectProviderARNs

CreateIdentityPoolRequest.Builder openIdConnectProviderARNs(String... openIdConnectProviderARNs)

The Amazon Resource Names (ARN) of the OpenID Connect providers.

Parameters:

openIdConnectProviderARNs - The Amazon Resource Names (ARN) of the OpenID Connect providers.

Returns:

Returns a reference to this object so that method calls can be chained together.

cognitoIdentityProviders

CreateIdentityPoolRequest.Builder cognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders)

An array of Amazon Cognito user pools and their client IDs.

Parameters:

cognitoIdentityProviders - An array of Amazon Cognito user pools and their client IDs.

Returns:

Returns a reference to this object so that method calls can be chained together.

cognitoIdentityProviders

CreateIdentityPoolRequest.Builder cognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders)

An array of Amazon Cognito user pools and their client IDs.

Parameters:

cognitoIdentityProviders - An array of Amazon Cognito user pools and their client IDs.

Returns:

Returns a reference to this object so that method calls can be chained together.

cognitoIdentityProviders

CreateIdentityPoolRequest.Builder cognitoIdentityProviders(Consumer<CognitoIdentityProvider.Builder>... cognitoIdentityProviders)

An array of Amazon Cognito user pools and their client IDs.

This is a convenience method that creates an instance of the CognitoIdentityProvider.Builder avoiding the need to create one manually via CognitoIdentityProvider.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #cognitoIdentityProviders(List).

Parameters:

cognitoIdentityProviders - a consumer that will call methods on CognitoIdentityProvider.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#cognitoIdentityProviders(java.util.Collection)

samlProviderARNs

CreateIdentityPoolRequest.Builder samlProviderARNs(Collection<String> samlProviderARNs)

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

Parameters:

samlProviderARNs - An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

samlProviderARNs

CreateIdentityPoolRequest.Builder samlProviderARNs(String... samlProviderARNs)

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

Parameters:

samlProviderARNs - An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

identityPoolTags

CreateIdentityPoolRequest.Builder identityPoolTags(Map<String,String> 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. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateIdentityPoolRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateIdentityPoolRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder