Package software.amazon.awssdk.services.cognitoidentity.model

Interface CreateIdentityPoolRequest.Builder

All Superinterfaces:

CopyableBuilder<CreateIdentityPoolRequest.Builder,CreateIdentityPoolRequest>, SdkBuilder<CreateIdentityPoolRequest.Builder,CreateIdentityPoolRequest>

Enclosing class:

CreateIdentityPoolRequest

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

Method Summary

Modifier and Type	Method	Description
CreateIdentityPoolRequest.Builder	allowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)	TRUE if the identity pool supports unauthenticated logins.
CreateIdentityPoolRequest.Builder	cognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders)	An array of Amazon Cognito Identity user pools and their client IDs.
CreateIdentityPoolRequest.Builder	cognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders)	An array of Amazon Cognito Identity 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	openIdConnectProviderARNs(String... openIdConnectProviderARNs)	A list of OpendID Connect provider ARNs.
CreateIdentityPoolRequest.Builder	openIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs)	A list of OpendID Connect provider ARNs.
CreateIdentityPoolRequest.Builder	samlProviderARNs(String... samlProviderARNs)	An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
CreateIdentityPoolRequest.Builder	samlProviderARNs(Collection<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.utils.builder.CopyableBuilder

copy

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

apply, 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.

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)

A list of OpendID Connect provider ARNs.

Parameters:

openIdConnectProviderARNs - A list of OpendID Connect provider ARNs.

Returns:

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

openIdConnectProviderARNs

CreateIdentityPoolRequest.Builder openIdConnectProviderARNs(String... openIdConnectProviderARNs)

A list of OpendID Connect provider ARNs.

NOTE: This method appends the values to the existing list (if any). Use #setOpenIdConnectProviderARNs(java.util.Collection) or #withOpenIdConnectProviderARNs(java.util.Collection) if you want to override the existing values.

Parameters:

openIdConnectProviderARNs - A list of OpendID Connect provider ARNs.

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 Identity user pools and their client IDs.

Parameters:

cognitoIdentityProviders - An array of Amazon Cognito Identity 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 Identity user pools and their client IDs.

NOTE: This method appends the values to the existing list (if any). Use #setCognitoIdentityProviders(java.util.Collection) or #withCognitoIdentityProviders(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

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

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.

NOTE: This method appends the values to the existing list (if any). Use #setSamlProviderARNs(java.util.Collection) or #withSamlProviderARNs(java.util.Collection) if you want to override the existing values.

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.