Class DescribeIdentityPoolResult
- java.lang.Object
-
- com.amazonaws.services.cognitoidentity.model.DescribeIdentityPoolResult
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class DescribeIdentityPoolResult extends Object implements Serializable, Cloneable
An object representing a Cognito identity pool.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DescribeIdentityPoolResult()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeIdentityPoolResult
addSupportedLoginProvidersEntry(String key, String value)
DescribeIdentityPoolResult
clearSupportedLoginProvidersEntries()
Removes all the entries added into SupportedLoginProviders.DescribeIdentityPoolResult
clone()
boolean
equals(Object obj)
Boolean
getAllowUnauthenticatedIdentities()
TRUE if the identity pool supports unauthenticated logins.List<CognitoIdentityProvider>
getCognitoIdentityProviders()
A list representing a Cognito User Identity 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.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 a Cognito User Identity 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
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.DescribeIdentityPoolResult
withAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities)
TRUE if the identity pool supports unauthenticated logins.DescribeIdentityPoolResult
withCognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders)
A list representing a Cognito User Identity Pool and its client ID.DescribeIdentityPoolResult
withCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders)
A list representing a Cognito User Identity Pool and its client ID.DescribeIdentityPoolResult
withDeveloperProviderName(String developerProviderName)
The "domain" by which Cognito will refer to your users.DescribeIdentityPoolResult
withIdentityPoolId(String identityPoolId)
An identity pool ID in the format REGION:GUID.DescribeIdentityPoolResult
withIdentityPoolName(String identityPoolName)
A string that you provide.DescribeIdentityPoolResult
withOpenIdConnectProviderARNs(String... openIdConnectProviderARNs)
A list of OpendID Connect provider ARNs.DescribeIdentityPoolResult
withOpenIdConnectProviderARNs(Collection<String> openIdConnectProviderARNs)
A list of OpendID Connect provider ARNs.DescribeIdentityPoolResult
withSupportedLoginProviders(Map<String,String> supportedLoginProviders)
Optional key:value pairs mapping provider names to provider app IDs.
-
-
-
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 DescribeIdentityPoolResult 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 DescribeIdentityPoolResult 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 DescribeIdentityPoolResult 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 DescribeIdentityPoolResult 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 DescribeIdentityPoolResult addSupportedLoginProvidersEntry(String key, String value)
-
clearSupportedLoginProvidersEntries
public DescribeIdentityPoolResult 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 DescribeIdentityPoolResult 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 DescribeIdentityPoolResult 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)
orwithOpenIdConnectProviderARNs(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 DescribeIdentityPoolResult 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 a Cognito User Identity Pool and its client ID.
- Returns:
- A list representing a Cognito User Identity Pool and its client ID.
-
setCognitoIdentityProviders
public void setCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders)
A list representing a Cognito User Identity Pool and its client ID.
- Parameters:
cognitoIdentityProviders
- A list representing a Cognito User Identity Pool and its client ID.
-
withCognitoIdentityProviders
public DescribeIdentityPoolResult withCognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders)
A list representing a Cognito User Identity Pool and its client ID.
NOTE: This method appends the values to the existing list (if any). Use
setCognitoIdentityProviders(java.util.Collection)
orwithCognitoIdentityProviders(java.util.Collection)
if you want to override the existing values.- Parameters:
cognitoIdentityProviders
- A list representing a Cognito User Identity Pool and its client ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withCognitoIdentityProviders
public DescribeIdentityPoolResult withCognitoIdentityProviders(Collection<CognitoIdentityProvider> cognitoIdentityProviders)
A list representing a Cognito User Identity Pool and its client ID.
- Parameters:
cognitoIdentityProviders
- A list representing a Cognito User Identity Pool and its client ID.- 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeIdentityPoolResult clone()
-
-