com.amazonaws.services.cognitoidentity.model

Class CreateIdentityPoolRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentity.model.CreateIdentityPoolRequest

All Implemented Interfaces:

Serializable, Cloneable

public class CreateIdentityPoolRequest
extends AmazonWebServiceRequest
implements Serializable

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for SupportedLoginProviders are as follows:

• Facebook: graph.facebook.com

• Google: accounts.google.com

• Amazon: www.amazon.com

• Twitter: api.twitter.com

• Digits: www.digits.com

You must use AWS Developer credentials to call this API.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateIdentityPoolRequest()

Method Summary

Modifier and Type	Method and Description
CreateIdentityPoolRequest	addSupportedLoginProvidersEntry(String key, String value) Optional key:value pairs mapping provider names to provider app IDs.
CreateIdentityPoolRequest	clearSupportedLoginProvidersEntries() Removes all the entries added into SupportedLoginProviders.
boolean	equals(Object obj)
Boolean	getAllowUnauthenticatedIdentities() TRUE if the identity pool supports unauthenticated logins.
List<CognitoIdentityProvider>	getCognitoIdentityProviders() An array of Amazon Cognito Identity user pools and their client IDs.
String	getDeveloperProviderName() The "domain" by which Cognito will refer to your users.
String	getIdentityPoolName() A string that you provide.
List<String>	getOpenIdConnectProviderARNs() A list of OpendID Connect provider ARNs.
List<String>	getSamlProviderARNs() An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
Map<String,String>	getSupportedLoginProviders() Optional key:value pairs mapping provider names to provider app IDs.
int	hashCode()
Boolean	isAllowUnauthenticatedIdentities() TRUE if the identity pool supports unauthenticated logins.
void	setAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities) TRUE if the identity pool supports unauthenticated logins.
void	setCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders) An array of Amazon Cognito Identity user pools and their client IDs.
void	setDeveloperProviderName(String developerProviderName) The "domain" by which Cognito will refer to your users.
void	setIdentityPoolName(String identityPoolName) A string that you provide.
void	setOpenIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs) A list of OpendID Connect provider ARNs.
void	setSamlProviderARNs(Collection<String> samlProviderARNs) An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
void	setSupportedLoginProviders(Map<String,String> supportedLoginProviders) Optional key:value pairs mapping provider names to provider app IDs.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateIdentityPoolRequest	withAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities) TRUE if the identity pool supports unauthenticated logins.
CreateIdentityPoolRequest	withCognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders) An array of Amazon Cognito Identity user pools and their client IDs.
CreateIdentityPoolRequest	withCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders) An array of Amazon Cognito Identity user pools and their client IDs.
CreateIdentityPoolRequest	withDeveloperProviderName(String developerProviderName) The "domain" by which Cognito will refer to your users.
CreateIdentityPoolRequest	withIdentityPoolName(String identityPoolName) A string that you provide.
CreateIdentityPoolRequest	withOpenIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs) A list of OpendID Connect provider ARNs.
CreateIdentityPoolRequest	withOpenIdConnectProviderARNs(String... openIdConnectProviderARNs) A list of OpendID Connect provider ARNs.
CreateIdentityPoolRequest	withSamlProviderARNs(Collection<String> samlProviderARNs) An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
CreateIdentityPoolRequest	withSamlProviderARNs(String... samlProviderARNs) An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
CreateIdentityPoolRequest	withSupportedLoginProviders(Map<String,String> supportedLoginProviders) Optional key:value pairs mapping provider names to provider app IDs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateIdentityPoolRequest

public CreateIdentityPoolRequest()

Method Detail

getIdentityPoolName

public String getIdentityPoolName()

A string that you provide.

Constraints:
Length: 1 - 128
Pattern: [\w ]+

Returns:

A string that you provide.

setIdentityPoolName

public void setIdentityPoolName(String identityPoolName)

A string that you provide.

Constraints:
Length: 1 - 128
Pattern: [\w ]+

Parameters:

identityPoolName -

A string that you provide.

withIdentityPoolName

public CreateIdentityPoolRequest withIdentityPoolName(String identityPoolName)

A string that you provide.

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

Constraints:
Length: 1 - 128
Pattern: [\w ]+

Parameters:

identityPoolName -

A string that you provide.

Returns:

A reference to this updated object so that method calls can be chained together.

isAllowUnauthenticatedIdentities

public Boolean isAllowUnauthenticatedIdentities()

TRUE if the identity pool supports unauthenticated logins.

Returns:

TRUE if the identity pool supports unauthenticated logins.

getAllowUnauthenticatedIdentities

public Boolean getAllowUnauthenticatedIdentities()

TRUE if the identity pool supports unauthenticated logins.

Returns:

TRUE if the identity pool supports unauthenticated logins.

setAllowUnauthenticatedIdentities

public void setAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)

TRUE if the identity pool supports unauthenticated logins.

Parameters:

allowUnauthenticatedIdentities -

TRUE if the identity pool supports unauthenticated logins.

withAllowUnauthenticatedIdentities

public CreateIdentityPoolRequest withAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)

TRUE if the identity pool supports unauthenticated logins.

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

Parameters:

allowUnauthenticatedIdentities -

TRUE if the identity pool supports unauthenticated logins.

Returns:

A reference to this updated object so that method calls can be chained together.

getSupportedLoginProviders

public Map<String,String> getSupportedLoginProviders()

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

Returns:

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

setSupportedLoginProviders

public void setSupportedLoginProviders(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.

withSupportedLoginProviders

public CreateIdentityPoolRequest withSupportedLoginProviders(Map<String,String> supportedLoginProviders)

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

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

Parameters:

supportedLoginProviders -

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

Returns:

A reference to this updated object so that method calls can be chained together.

addSupportedLoginProvidersEntry

public CreateIdentityPoolRequest addSupportedLoginProvidersEntry(String key,
                                                                 String value)

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

The method adds a new key-value pair into SupportedLoginProviders parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into SupportedLoginProviders.

value - The corresponding value of the entry to be added into SupportedLoginProviders.

Returns:

A reference to this updated object so that method calls can be chained together.

clearSupportedLoginProvidersEntries

public CreateIdentityPoolRequest clearSupportedLoginProvidersEntries()

Removes all the entries added into SupportedLoginProviders.

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

getDeveloperProviderName

public String getDeveloperProviderName()

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.

Constraints:
Length: 1 - 128
Pattern: [\w._-]+

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.

setDeveloperProviderName

public void setDeveloperProviderName(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.

Constraints:
Length: 1 - 128
Pattern: [\w._-]+

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.

withDeveloperProviderName

public CreateIdentityPoolRequest withDeveloperProviderName(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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [\w._-]+

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:

A reference to this updated object so that method calls can be chained together.

getOpenIdConnectProviderARNs

public List<String> getOpenIdConnectProviderARNs()

A list of OpendID Connect provider ARNs.

Returns:

A list of OpendID Connect provider ARNs.

setOpenIdConnectProviderARNs

public void setOpenIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs)

A list of OpendID Connect provider ARNs.

Parameters:

openIdConnectProviderARNs -

A list of OpendID Connect provider ARNs.

withOpenIdConnectProviderARNs

public CreateIdentityPoolRequest withOpenIdConnectProviderARNs(String... openIdConnectProviderARNs)

A list of OpendID Connect provider ARNs.

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

Parameters:

openIdConnectProviderARNs -

A list of OpendID Connect provider ARNs.

Returns:

A reference to this updated object so that method calls can be chained together.

withOpenIdConnectProviderARNs

public CreateIdentityPoolRequest withOpenIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs)

A list of OpendID Connect provider ARNs.

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

Parameters:

openIdConnectProviderARNs -

A list of OpendID Connect provider ARNs.

Returns:

A reference to this updated object so that method calls can be chained together.

getCognitoIdentityProviders

public List<CognitoIdentityProvider> getCognitoIdentityProviders()

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.

setCognitoIdentityProviders

public void setCognitoIdentityProviders(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.

withCognitoIdentityProviders

public CreateIdentityPoolRequest withCognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders)

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

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

Parameters:

cognitoIdentityProviders -

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

Returns:

A reference to this updated object so that method calls can be chained together.

withCognitoIdentityProviders

public CreateIdentityPoolRequest withCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders)

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

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

Parameters:

cognitoIdentityProviders -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getSamlProviderARNs

public List<String> getSamlProviderARNs()

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.

setSamlProviderARNs

public void setSamlProviderARNs(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.

withSamlProviderARNs

public CreateIdentityPoolRequest withSamlProviderARNs(String... samlProviderARNs)

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

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

Parameters:

samlProviderARNs -

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

Returns:

A reference to this updated object so that method calls can be chained together.

withSamlProviderARNs

public CreateIdentityPoolRequest withSamlProviderARNs(Collection<String> samlProviderARNs)

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

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

Parameters:

samlProviderARNs -

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object