@Generated(value="software.amazon.awssdk:codegen") public final class CreateIdentityPoolRequest extends CognitoIdentityRequest implements ToCopyableBuilder<CreateIdentityPoolRequest.Builder,CreateIdentityPoolRequest>
Input to the CreateIdentityPool action.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateIdentityPoolRequest.Builder |
Modifier and Type | Method and Description |
---|---|
Boolean |
allowUnauthenticatedIdentities()
TRUE if the identity pool supports unauthenticated logins.
|
static CreateIdentityPoolRequest.Builder |
builder() |
List<CognitoIdentityProvider> |
cognitoIdentityProviders()
An array of Amazon Cognito Identity user pools and their client IDs.
|
String |
developerProviderName()
The "domain" by which Cognito will refer to your users.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
identityPoolName()
A string that you provide.
|
List<String> |
openIdConnectProviderARNs()
A list of OpendID Connect provider ARNs.
|
List<String> |
samlProviderARNs()
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
|
static Class<? extends CreateIdentityPoolRequest.Builder> |
serializableBuilderClass() |
Map<String,String> |
supportedLoginProviders()
Optional key:value pairs mapping provider names to provider app IDs.
|
CreateIdentityPoolRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String identityPoolName()
A string that you provide.
public Boolean allowUnauthenticatedIdentities()
TRUE if the identity pool supports unauthenticated logins.
public Map<String,String> supportedLoginProviders()
Optional key:value pairs mapping provider names to provider app IDs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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
, 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 List<String> openIdConnectProviderARNs()
A list of OpendID Connect provider ARNs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<CognitoIdentityProvider> cognitoIdentityProviders()
An array of Amazon Cognito Identity user pools and their client IDs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> samlProviderARNs()
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public CreateIdentityPoolRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateIdentityPoolRequest.Builder,CreateIdentityPoolRequest>
toBuilder
in class CognitoIdentityRequest
public static CreateIdentityPoolRequest.Builder builder()
public static Class<? extends CreateIdentityPoolRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.