com.amazonaws.services.cognitoidentity.model

Class UpdateIdentityPoolRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentity.model.UpdateIdentityPoolRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateIdentityPoolRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

An object representing an Amazon Cognito identity pool.

See Also:

AWS API Documentation, 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	addIdentityPoolTagsEntry(String key, String value) Add a single IdentityPoolTags entry
UpdateIdentityPoolRequest	addSupportedLoginProvidersEntry(String key, String value) Add a single SupportedLoginProviders entry
UpdateIdentityPoolRequest	clearIdentityPoolTagsEntries() Removes all the entries added into IdentityPoolTags.
UpdateIdentityPoolRequest	clearSupportedLoginProvidersEntries() Removes all the entries added into SupportedLoginProviders.
UpdateIdentityPoolRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getAllowClassicFlow() Enables or disables the Basic (Classic) authentication flow.
Boolean	getAllowUnauthenticatedIdentities() TRUE if the identity pool supports unauthenticated logins.
List<CognitoIdentityProvider>	getCognitoIdentityProviders() A list representing an Amazon Cognito 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.
Map<String,String>	getIdentityPoolTags() The tags that are assigned to the identity pool.
List<String>	getOpenIdConnectProviderARNs() The ARNs of the OpenID Connect providers.
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	isAllowClassicFlow() Enables or disables the Basic (Classic) authentication flow.
Boolean	isAllowUnauthenticatedIdentities() TRUE if the identity pool supports unauthenticated logins.
void	setAllowClassicFlow(Boolean allowClassicFlow) Enables or disables the Basic (Classic) authentication flow.
void	setAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities) TRUE if the identity pool supports unauthenticated logins.
void	setCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders) A list representing an Amazon Cognito 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	setIdentityPoolTags(Map<String,String> identityPoolTags) The tags that are assigned to the identity pool.
void	setOpenIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs) The ARNs of the OpenID Connect providers.
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.
UpdateIdentityPoolRequest	withAllowClassicFlow(Boolean allowClassicFlow) Enables or disables the Basic (Classic) authentication flow.
UpdateIdentityPoolRequest	withAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities) TRUE if the identity pool supports unauthenticated logins.
UpdateIdentityPoolRequest	withCognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders) A list representing an Amazon Cognito user pool and its client ID.
UpdateIdentityPoolRequest	withCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders) A list representing an Amazon Cognito 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	withIdentityPoolTags(Map<String,String> identityPoolTags) The tags that are assigned to the identity pool.
UpdateIdentityPoolRequest	withOpenIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs) The ARNs of the OpenID Connect providers.
UpdateIdentityPoolRequest	withOpenIdConnectProviderARNs(String... openIdConnectProviderARNs) The ARNs of the OpenID Connect providers.
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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, 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.

setAllowClassicFlow

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

getAllowClassicFlow

public Boolean getAllowClassicFlow()

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:

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

withAllowClassicFlow

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

isAllowClassicFlow

public Boolean isAllowClassicFlow()

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:

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

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)

Add a single SupportedLoginProviders entry

See Also:

withSupportedLoginProviders(java.util.Map<java.lang.String, java.lang.String>)

clearSupportedLoginProvidersEntries

public UpdateIdentityPoolRequest clearSupportedLoginProvidersEntries()

Removes all the entries added into SupportedLoginProviders.

Returns:

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

The ARNs of the OpenID Connect providers.

Returns:

The ARNs of the OpenID Connect providers.

setOpenIdConnectProviderARNs

public void setOpenIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs)

The ARNs of the OpenID Connect providers.

Parameters:

openIdConnectProviderARNs - The ARNs of the OpenID Connect providers.

withOpenIdConnectProviderARNs

public UpdateIdentityPoolRequest withOpenIdConnectProviderARNs(String... openIdConnectProviderARNs)

The ARNs of the OpenID Connect providers.

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 - The ARNs of the OpenID Connect providers.

Returns:

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

withOpenIdConnectProviderARNs

public UpdateIdentityPoolRequest withOpenIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs)

The ARNs of the OpenID Connect providers.

Parameters:

openIdConnectProviderARNs - The ARNs of the OpenID Connect providers.

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 user pool and its client ID.

Returns:

A list representing an Amazon Cognito user pool and its client ID.

setCognitoIdentityProviders

public void setCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders)

A list representing an Amazon Cognito user pool and its client ID.

Parameters:

cognitoIdentityProviders - A list representing an Amazon Cognito user pool and its client ID.

withCognitoIdentityProviders

public UpdateIdentityPoolRequest withCognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders)

A list representing an Amazon Cognito 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 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 user pool and its client ID.

Parameters:

cognitoIdentityProviders - A list representing an Amazon Cognito 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.

getIdentityPoolTags

public Map<String,String> getIdentityPoolTags()

The tags that are assigned 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:

The tags that are assigned 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.

setIdentityPoolTags

public void setIdentityPoolTags(Map<String,String> identityPoolTags)

The tags that are assigned 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 - The tags that are assigned 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.

withIdentityPoolTags

public UpdateIdentityPoolRequest withIdentityPoolTags(Map<String,String> identityPoolTags)

The tags that are assigned 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 - The tags that are assigned 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.

addIdentityPoolTagsEntry

public UpdateIdentityPoolRequest addIdentityPoolTagsEntry(String key,
                                                          String value)

Add a single IdentityPoolTags entry

See Also:

withIdentityPoolTags(java.util.Map<java.lang.String, java.lang.String>)

clearIdentityPoolTagsEntries

public UpdateIdentityPoolRequest clearIdentityPoolTagsEntries()

Removes all the entries added into IdentityPoolTags.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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 object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()