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

Class CreateIdentityPoolRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cognitoidentity.model.CreateIdentityPoolRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateIdentityPoolRequest.Builder,CreateIdentityPoolRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateIdentityPoolRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateIdentityPoolRequest.Builder,CreateIdentityPoolRequest>

Input to the CreateIdentityPool action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateIdentityPoolRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
Boolean	allowUnauthenticatedIdentities()	TRUE if the identity pool supports unauthenticated logins.
static CreateIdentityPoolRequest.Builder	builder()
List<CognitoIdentityProvider>	cognitoIdentityProviders()	An array of Amazon Cognito Identity user pools and their client IDs.
String	developerProviderName()	The "domain" by which Cognito will refer to your users.
boolean	equals(Object obj)
int	hashCode()
String	identityPoolName()	A string that you provide.
List<String>	openIdConnectProviderARNs()	A list of OpendID Connect provider ARNs.
List<String>	samlProviderARNs()	An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
static Class<? extends CreateIdentityPoolRequest.Builder>	serializableBuilderClass()
Map<String,String>	supportedLoginProviders()	Optional key:value pairs mapping provider names to provider app IDs.
CreateIdentityPoolRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

identityPoolName

public String identityPoolName()

A string that you provide.

Returns:

A string that you provide.

allowUnauthenticatedIdentities

public Boolean allowUnauthenticatedIdentities()

TRUE if the identity pool supports unauthenticated logins.

Returns:

TRUE if the identity pool supports unauthenticated logins.

supportedLoginProviders

public Map<String,String> supportedLoginProviders()

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

Returns:

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

developerProviderName

public 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.

Returns:

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.

openIdConnectProviderARNs

public List<String> openIdConnectProviderARNs()

A list of OpendID Connect provider ARNs.

Returns:

A list of OpendID Connect provider ARNs.

cognitoIdentityProviders

public List<CognitoIdentityProvider> cognitoIdentityProviders()

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

Returns:

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

samlProviderARNs

public List<String> samlProviderARNs()

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

Returns:

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

toBuilder

public CreateIdentityPoolRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateIdentityPoolRequest.Builder,CreateIdentityPoolRequest>

Returns:

a builder for type T

builder

public static CreateIdentityPoolRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateIdentityPoolRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object