com.amazonaws.services.cognitoidentity.model

Class CreateIdentityPoolResult

java.lang.Object

com.amazonaws.services.cognitoidentity.model.CreateIdentityPoolResult

All Implemented Interfaces:

Serializable

public class CreateIdentityPoolResult
extends Object
implements Serializable

An object representing a Cognito identity pool.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateIdentityPoolResult()

Method Summary

Methods

Modifier and Type	Method and Description
CreateIdentityPoolResult	addSupportedLoginProvidersEntry(String key, String value) Optional key:value pairs mapping provider names to provider app IDs.
CreateIdentityPoolResult	clearSupportedLoginProvidersEntries() Removes all the entries added into SupportedLoginProviders.
boolean	equals(Object obj)
Boolean	getAllowUnauthenticatedIdentities() TRUE if the identity pool supports unauthenticated logins.
String	getIdentityPoolId() An identity pool ID in the format REGION:GUID.
String	getIdentityPoolName() A string that you provide.
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	setIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.
void	setIdentityPoolName(String identityPoolName) A string that you provide.
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.
CreateIdentityPoolResult	withAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities) TRUE if the identity pool supports unauthenticated logins.
CreateIdentityPoolResult	withIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.
CreateIdentityPoolResult	withIdentityPoolName(String identityPoolName) A string that you provide.
CreateIdentityPoolResult	withSupportedLoginProviders(Map<String,String> supportedLoginProviders) Optional key:value pairs mapping provider names to provider app IDs.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateIdentityPoolResult

public CreateIdentityPoolResult()

Method Detail

getIdentityPoolId

public String getIdentityPoolId()

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Returns:

An identity pool ID in the format REGION:GUID.

setIdentityPoolId

public void setIdentityPoolId(String identityPoolId)

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

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

withIdentityPoolId

public CreateIdentityPoolResult withIdentityPoolId(String identityPoolId)

An identity pool ID in the format REGION:GUID.

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

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

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

Returns:

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

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

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

getAllowUnauthenticatedIdentities

public Boolean getAllowUnauthenticatedIdentities()

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.

Constraints:
Length: 0 - 3

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.

Constraints:
Length: 0 - 3

Parameters:

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

withSupportedLoginProviders

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

Constraints:
Length: 0 - 3

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

Constraints:
Length: 0 - 3

Parameters:

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

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

clearSupportedLoginProvidersEntries

public CreateIdentityPoolResult clearSupportedLoginProvidersEntries()

Removes all the entries added into SupportedLoginProviders.

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object