Class CreateIdentityPoolRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Input to the CreateIdentityPool action.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddSupportedLoginProvidersEntry
(String key, String value) Removes all the entries added into SupportedLoginProviders.clone()
Creates a shallow clone of this request.boolean
TRUE if the identity pool supports unauthenticated logins.A list representing a Cognito User Identity Pool and its client ID.The "domain" by which Cognito will refer to your users.A string that you provide.A list of OpendID Connect provider ARNs.Optional key:value pairs mapping provider names to provider app IDs.int
hashCode()
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
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.toString()
Returns a string representation of this object; useful for testing and debugging.withAllowUnauthenticatedIdentities
(Boolean allowUnauthenticatedIdentities) TRUE if the identity pool supports unauthenticated logins.withCognitoIdentityProviders
(CognitoIdentityProvider... cognitoIdentityProviders) A list representing a Cognito User Identity Pool and its client ID.withCognitoIdentityProviders
(Collection<CognitoIdentityProvider> cognitoIdentityProviders) A list representing a Cognito User Identity Pool and its client ID.withDeveloperProviderName
(String developerProviderName) The "domain" by which Cognito will refer to your users.withIdentityPoolName
(String identityPoolName) A string that you provide.withOpenIdConnectProviderARNs
(String... openIdConnectProviderARNs) A list of OpendID Connect provider ARNs.withOpenIdConnectProviderARNs
(Collection<String> openIdConnectProviderARNs) A list of OpendID Connect provider ARNs.withSupportedLoginProviders
(Map<String, String> supportedLoginProviders) Optional key:value pairs mapping provider names to provider app IDs.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
CreateIdentityPoolRequest
public CreateIdentityPoolRequest()
-
-
Method Details
-
setIdentityPoolName
A string that you provide.
- Parameters:
identityPoolName
- A string that you provide.
-
getIdentityPoolName
A string that you provide.
- Returns:
- A string that you provide.
-
withIdentityPoolName
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
TRUE if the identity pool supports unauthenticated logins.
- Parameters:
allowUnauthenticatedIdentities
- TRUE if the identity pool supports unauthenticated logins.
-
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
TRUE if the identity pool supports unauthenticated logins.
- Returns:
- TRUE if the identity pool supports unauthenticated logins.
-
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
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
-
clearSupportedLoginProvidersEntries
Removes all the entries added into SupportedLoginProviders. <p> Returns a reference to this object so that method calls can be chained together. -
setDeveloperProviderName
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 theDeveloperProviderName
, 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
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
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 theDeveloperProviderName
, 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
A list of OpendID Connect provider ARNs.
- Returns:
- A list of OpendID Connect provider ARNs.
-
setOpenIdConnectProviderARNs
A list of OpendID Connect provider ARNs.
- Parameters:
openIdConnectProviderARNs
- A list of OpendID Connect provider ARNs.
-
withOpenIdConnectProviderARNs
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 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
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)
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 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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-