Class CreateIdentityPoolRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.cognitoidentity.model.CreateIdentityPoolRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class CreateIdentityPoolRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Input to the CreateIdentityPool action.

See Also:
  • Constructor Details

    • CreateIdentityPoolRequest

      public CreateIdentityPoolRequest()
  • Method Details

    • 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 CreateIdentityPoolRequest 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 CreateIdentityPoolRequest 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 CreateIdentityPoolRequest 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 CreateIdentityPoolRequest addSupportedLoginProvidersEntry(String key, String value)
    • clearSupportedLoginProvidersEntries

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

      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.

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

      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.

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

      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:
      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 CreateIdentityPoolRequest 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 CreateIdentityPoolRequest 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 CreateIdentityPoolRequest 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) or withCognitoIdentityProviders(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 CreateIdentityPoolRequest 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 class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public CreateIdentityPoolRequest 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: