com.amazonaws.services.cognitoidentity.model

Class UpdateIdentityPoolRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentity.model.UpdateIdentityPoolRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UpdateIdentityPoolRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

An object representing a Cognito identity pool.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateIdentityPoolRequest()

Method Summary

Modifier and Type	Method and Description
UpdateIdentityPoolRequest	addSupportedLoginProvidersEntry(String key, String value)
UpdateIdentityPoolRequest	clearSupportedLoginProvidersEntries() Removes all the entries added into SupportedLoginProviders.
UpdateIdentityPoolRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Boolean	getAllowUnauthenticatedIdentities() TRUE if the identity pool supports unauthenticated logins.
List<CognitoIdentityProvider>	getCognitoIdentityProviders() A list representing an Amazon Cognito Identity User Pool and its client ID.
String	getDeveloperProviderName() The "domain" by which Cognito will refer to your users.
String	getIdentityPoolId() An identity pool ID in the format REGION:GUID.
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) A list representing an Amazon Cognito Identity User Pool and its client ID.
void	setDeveloperProviderName(String developerProviderName) The "domain" by which Cognito will refer to your users.
void	setIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.
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.
UpdateIdentityPoolRequest	withAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities) TRUE if the identity pool supports unauthenticated logins.
UpdateIdentityPoolRequest	withCognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders) A list representing an Amazon Cognito Identity User Pool and its client ID.
UpdateIdentityPoolRequest	withCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders) A list representing an Amazon Cognito Identity User Pool and its client ID.
UpdateIdentityPoolRequest	withDeveloperProviderName(String developerProviderName) The "domain" by which Cognito will refer to your users.
UpdateIdentityPoolRequest	withIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.
UpdateIdentityPoolRequest	withIdentityPoolName(String identityPoolName) A string that you provide.
UpdateIdentityPoolRequest	withOpenIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs) A list of OpendID Connect provider ARNs.
UpdateIdentityPoolRequest	withOpenIdConnectProviderARNs(String... openIdConnectProviderARNs) A list of OpendID Connect provider ARNs.
UpdateIdentityPoolRequest	withSamlProviderARNs(Collection<String> samlProviderARNs) An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
UpdateIdentityPoolRequest	withSamlProviderARNs(String... samlProviderARNs) An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
UpdateIdentityPoolRequest	withSupportedLoginProviders(Map<String,String> supportedLoginProviders) Optional key:value pairs mapping provider names to provider app IDs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateIdentityPoolRequest

public UpdateIdentityPoolRequest()

Method Detail

setIdentityPoolId

public void setIdentityPoolId(String identityPoolId)

An identity pool ID in the format REGION:GUID.

Parameters:

identityPoolId - An identity pool ID in the format REGION:GUID.

getIdentityPoolId

public String getIdentityPoolId()

An identity pool ID in the format REGION:GUID.

Returns:

An identity pool ID in the format REGION:GUID.

withIdentityPoolId

public UpdateIdentityPoolRequest withIdentityPoolId(String identityPoolId)

An identity pool ID in the format REGION:GUID.

Parameters:

identityPoolId - An identity pool ID in the format REGION:GUID.

Returns:

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

setIdentityPoolName

public void setIdentityPoolName(String identityPoolName)

A string that you provide.

Parameters:

identityPoolName - A string that you provide.

getIdentityPoolName

public String getIdentityPoolName()

A string that you provide.

Returns:

A string that you provide.

withIdentityPoolName

public UpdateIdentityPoolRequest withIdentityPoolName(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.

setAllowUnauthenticatedIdentities

public void setAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)

TRUE if the identity pool supports unauthenticated logins.

Parameters:

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

withAllowUnauthenticatedIdentities

public UpdateIdentityPoolRequest withAllowUnauthenticatedIdentities(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.

isAllowUnauthenticatedIdentities

public Boolean isAllowUnauthenticatedIdentities()

TRUE if the identity pool supports unauthenticated logins.

Returns:

TRUE if the identity pool supports unauthenticated logins.

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 UpdateIdentityPoolRequest withSupportedLoginProviders(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.

addSupportedLoginProvidersEntry

public UpdateIdentityPoolRequest addSupportedLoginProvidersEntry(String key,
                                                                 String value)

clearSupportedLoginProvidersEntries

public UpdateIdentityPoolRequest clearSupportedLoginProvidersEntries()

Removes all the entries added into SupportedLoginProviders. <p> Returns a reference to this object so that method calls can be chained together.

setDeveloperProviderName

public void setDeveloperProviderName(String developerProviderName)

The "domain" by which Cognito will refer to your users.

Parameters:

developerProviderName - The "domain" by which Cognito will refer to your users.

getDeveloperProviderName

public String getDeveloperProviderName()

The "domain" by which Cognito will refer to your users.

Returns:

The "domain" by which Cognito will refer to your users.

withDeveloperProviderName

public UpdateIdentityPoolRequest withDeveloperProviderName(String developerProviderName)

The "domain" by which Cognito will refer to your users.

Parameters:

developerProviderName - The "domain" by which Cognito will refer to your users.

Returns:

Returns a reference to this 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 UpdateIdentityPoolRequest withOpenIdConnectProviderARNs(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.

withOpenIdConnectProviderARNs

public UpdateIdentityPoolRequest withOpenIdConnectProviderARNs(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.

getCognitoIdentityProviders

public List<CognitoIdentityProvider> getCognitoIdentityProviders()

A list representing an Amazon Cognito Identity User Pool and its client ID.

Returns:

A list representing an Amazon Cognito Identity User Pool and its client ID.

setCognitoIdentityProviders

public void setCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders)

A list representing an Amazon Cognito Identity User Pool and its client ID.

Parameters:

cognitoIdentityProviders - A list representing an Amazon Cognito Identity User Pool and its client ID.

withCognitoIdentityProviders

public UpdateIdentityPoolRequest withCognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders)

A list representing an Amazon Cognito Identity User Pool and its client ID.

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 - A list representing an Amazon Cognito Identity User Pool and its client ID.

Returns:

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

withCognitoIdentityProviders

public UpdateIdentityPoolRequest withCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders)

A list representing an Amazon Cognito Identity User Pool and its client ID.

Parameters:

cognitoIdentityProviders - A list representing an Amazon Cognito Identity User Pool and its client ID.

Returns:

Returns a reference to this 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 UpdateIdentityPoolRequest withSamlProviderARNs(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.

withSamlProviderARNs

public UpdateIdentityPoolRequest withSamlProviderARNs(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.

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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateIdentityPoolRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()