public class CreateIdentityPoolRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Input to the CreateIdentityPool action.
Modifier and Type | Field and Description |
---|---|
private java.lang.Boolean |
allowUnauthenticatedIdentities
TRUE if the identity pool supports unauthenticated logins.
|
private java.util.List<CognitoIdentityProvider> |
cognitoIdentityProviders
A list representing a Cognito User Identity Pool and its client ID.
|
private java.lang.String |
developerProviderName
The "domain" by which Cognito will refer to your users.
|
private java.lang.String |
identityPoolName
A string that you provide.
|
private java.util.List<java.lang.String> |
openIdConnectProviderARNs
A list of OpendID Connect provider ARNs.
|
private java.util.Map<java.lang.String,java.lang.String> |
supportedLoginProviders
Optional key:value pairs mapping provider names to provider app IDs.
|
NOOP
Constructor and Description |
---|
CreateIdentityPoolRequest() |
Modifier and Type | Method and Description |
---|---|
CreateIdentityPoolRequest |
addSupportedLoginProvidersEntry(java.lang.String key,
java.lang.String value) |
CreateIdentityPoolRequest |
clearSupportedLoginProvidersEntries()
Removes all the entries added into SupportedLoginProviders.
|
CreateIdentityPoolRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.Boolean |
getAllowUnauthenticatedIdentities()
TRUE if the identity pool supports unauthenticated logins.
|
java.util.List<CognitoIdentityProvider> |
getCognitoIdentityProviders()
A list representing a Cognito User Identity Pool and its client ID.
|
java.lang.String |
getDeveloperProviderName()
The "domain" by which Cognito will refer to your users.
|
java.lang.String |
getIdentityPoolName()
A string that you provide.
|
java.util.List<java.lang.String> |
getOpenIdConnectProviderARNs()
A list of OpendID Connect provider ARNs.
|
java.util.Map<java.lang.String,java.lang.String> |
getSupportedLoginProviders()
Optional key:value pairs mapping provider names to provider app IDs.
|
int |
hashCode() |
java.lang.Boolean |
isAllowUnauthenticatedIdentities()
TRUE if the identity pool supports unauthenticated logins.
|
void |
setAllowUnauthenticatedIdentities(java.lang.Boolean allowUnauthenticatedIdentities)
TRUE if the identity pool supports unauthenticated logins.
|
void |
setCognitoIdentityProviders(java.util.Collection<CognitoIdentityProvider> cognitoIdentityProviders)
A list representing a Cognito User Identity Pool and its client ID.
|
void |
setDeveloperProviderName(java.lang.String developerProviderName)
The "domain" by which Cognito will refer to your users.
|
void |
setIdentityPoolName(java.lang.String identityPoolName)
A string that you provide.
|
void |
setOpenIdConnectProviderARNs(java.util.Collection<java.lang.String> openIdConnectProviderARNs)
A list of OpendID Connect provider ARNs.
|
void |
setSupportedLoginProviders(java.util.Map<java.lang.String,java.lang.String> supportedLoginProviders)
Optional key:value pairs mapping provider names to provider app IDs.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateIdentityPoolRequest |
withAllowUnauthenticatedIdentities(java.lang.Boolean allowUnauthenticatedIdentities)
TRUE if the identity pool supports unauthenticated logins.
|
CreateIdentityPoolRequest |
withCognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders)
A list representing a Cognito User Identity Pool and its client ID.
|
CreateIdentityPoolRequest |
withCognitoIdentityProviders(java.util.Collection<CognitoIdentityProvider> cognitoIdentityProviders)
A list representing a Cognito User Identity Pool and its client ID.
|
CreateIdentityPoolRequest |
withDeveloperProviderName(java.lang.String developerProviderName)
The "domain" by which Cognito will refer to your users.
|
CreateIdentityPoolRequest |
withIdentityPoolName(java.lang.String identityPoolName)
A string that you provide.
|
CreateIdentityPoolRequest |
withOpenIdConnectProviderARNs(java.util.Collection<java.lang.String> openIdConnectProviderARNs)
A list of OpendID Connect provider ARNs.
|
CreateIdentityPoolRequest |
withOpenIdConnectProviderARNs(java.lang.String... openIdConnectProviderARNs)
A list of OpendID Connect provider ARNs.
|
CreateIdentityPoolRequest |
withSupportedLoginProviders(java.util.Map<java.lang.String,java.lang.String> supportedLoginProviders)
Optional key:value pairs mapping provider names to provider app IDs.
|
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
private java.lang.String identityPoolName
A string that you provide.
private java.lang.Boolean allowUnauthenticatedIdentities
TRUE if the identity pool supports unauthenticated logins.
private java.util.Map<java.lang.String,java.lang.String> supportedLoginProviders
Optional key:value pairs mapping provider names to provider app IDs.
private java.lang.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.
private java.util.List<java.lang.String> openIdConnectProviderARNs
A list of OpendID Connect provider ARNs.
private java.util.List<CognitoIdentityProvider> cognitoIdentityProviders
A list representing a Cognito User Identity Pool and its client ID.
public void setIdentityPoolName(java.lang.String identityPoolName)
A string that you provide.
identityPoolName
- A string that you provide.public java.lang.String getIdentityPoolName()
A string that you provide.
public CreateIdentityPoolRequest withIdentityPoolName(java.lang.String identityPoolName)
A string that you provide.
identityPoolName
- A string that you provide.public void setAllowUnauthenticatedIdentities(java.lang.Boolean allowUnauthenticatedIdentities)
TRUE if the identity pool supports unauthenticated logins.
allowUnauthenticatedIdentities
- TRUE if the identity pool supports unauthenticated logins.public java.lang.Boolean getAllowUnauthenticatedIdentities()
TRUE if the identity pool supports unauthenticated logins.
public CreateIdentityPoolRequest withAllowUnauthenticatedIdentities(java.lang.Boolean allowUnauthenticatedIdentities)
TRUE if the identity pool supports unauthenticated logins.
allowUnauthenticatedIdentities
- TRUE if the identity pool supports unauthenticated logins.public java.lang.Boolean isAllowUnauthenticatedIdentities()
TRUE if the identity pool supports unauthenticated logins.
public java.util.Map<java.lang.String,java.lang.String> getSupportedLoginProviders()
Optional key:value pairs mapping provider names to provider app IDs.
public void setSupportedLoginProviders(java.util.Map<java.lang.String,java.lang.String> supportedLoginProviders)
Optional key:value pairs mapping provider names to provider app IDs.
supportedLoginProviders
- Optional key:value pairs mapping provider names to provider app
IDs.public CreateIdentityPoolRequest withSupportedLoginProviders(java.util.Map<java.lang.String,java.lang.String> supportedLoginProviders)
Optional key:value pairs mapping provider names to provider app IDs.
supportedLoginProviders
- Optional key:value pairs mapping provider names to provider app
IDs.public CreateIdentityPoolRequest addSupportedLoginProvidersEntry(java.lang.String key, java.lang.String value)
public CreateIdentityPoolRequest clearSupportedLoginProvidersEntries()
public void setDeveloperProviderName(java.lang.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.
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.
public java.lang.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.
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.
public CreateIdentityPoolRequest withDeveloperProviderName(java.lang.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.
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.
public java.util.List<java.lang.String> getOpenIdConnectProviderARNs()
A list of OpendID Connect provider ARNs.
public void setOpenIdConnectProviderARNs(java.util.Collection<java.lang.String> openIdConnectProviderARNs)
A list of OpendID Connect provider ARNs.
openIdConnectProviderARNs
- A list of OpendID Connect provider ARNs.public CreateIdentityPoolRequest withOpenIdConnectProviderARNs(java.lang.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.
openIdConnectProviderARNs
- A list of OpendID Connect provider ARNs.public CreateIdentityPoolRequest withOpenIdConnectProviderARNs(java.util.Collection<java.lang.String> openIdConnectProviderARNs)
A list of OpendID Connect provider ARNs.
openIdConnectProviderARNs
- A list of OpendID Connect provider ARNs.public java.util.List<CognitoIdentityProvider> getCognitoIdentityProviders()
A list representing a Cognito User Identity Pool and its client ID.
public void setCognitoIdentityProviders(java.util.Collection<CognitoIdentityProvider> cognitoIdentityProviders)
A list representing a Cognito User Identity Pool and its client ID.
cognitoIdentityProviders
- A list representing a Cognito User Identity Pool and its client
ID.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.
cognitoIdentityProviders
- A list representing a Cognito User Identity Pool and its client
ID.public CreateIdentityPoolRequest withCognitoIdentityProviders(java.util.Collection<CognitoIdentityProvider> cognitoIdentityProviders)
A list representing a Cognito User Identity Pool and its client ID.
cognitoIdentityProviders
- A list representing a Cognito User Identity Pool and its client
ID.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public CreateIdentityPoolRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()