@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 |
allowClassicFlow()
Enables or disables the Basic (Classic) authentication flow.
|
Boolean |
allowUnauthenticatedIdentities()
TRUE if the identity pool supports unauthenticated logins.
|
static CreateIdentityPoolRequest.Builder |
builder() |
List<CognitoIdentityProvider> |
cognitoIdentityProviders()
An array of Amazon Cognito user pools and their client IDs.
|
String |
developerProviderName()
The "domain" by which Cognito will refer to your users.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasCognitoIdentityProviders()
For responses, this returns true if the service returned a value for the CognitoIdentityProviders property.
|
int |
hashCode() |
boolean |
hasIdentityPoolTags()
For responses, this returns true if the service returned a value for the IdentityPoolTags property.
|
boolean |
hasOpenIdConnectProviderARNs()
For responses, this returns true if the service returned a value for the OpenIdConnectProviderARNs property.
|
boolean |
hasSamlProviderARNs()
For responses, this returns true if the service returned a value for the SamlProviderARNs property.
|
boolean |
hasSupportedLoginProviders()
For responses, this returns true if the service returned a value for the SupportedLoginProviders property.
|
String |
identityPoolName()
A string that you provide.
|
Map<String,String> |
identityPoolTags()
Tags to assign to the identity pool.
|
List<String> |
openIdConnectProviderARNs()
The Amazon Resource Names (ARN) of the OpenID Connect providers.
|
List<String> |
samlProviderARNs()
An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateIdentityPoolRequest.Builder> |
serializableBuilderClass() |
Map<String,String> |
supportedLoginProviders()
Optional key:value pairs mapping provider names to provider app IDs.
|
CreateIdentityPoolRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String identityPoolName()
A string that you provide.
public final Boolean allowUnauthenticatedIdentities()
TRUE if the identity pool supports unauthenticated logins.
public final Boolean allowClassicFlow()
Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
public final boolean hasSupportedLoginProviders()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasSupportedLoginProviders() method.
public final 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 final boolean hasOpenIdConnectProviderARNs()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<String> openIdConnectProviderARNs()
The Amazon Resource Names (ARN) of the OpenID Connect providers.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasOpenIdConnectProviderARNs() method.
public final boolean hasCognitoIdentityProviders()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<CognitoIdentityProvider> cognitoIdentityProviders()
An array of Amazon Cognito user pools and their client IDs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasCognitoIdentityProviders() method.
public final boolean hasSamlProviderARNs()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasSamlProviderARNs() method.
public final boolean hasIdentityPoolTags()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final Map<String,String> identityPoolTags()
Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasIdentityPoolTags() method.
public CreateIdentityPoolRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateIdentityPoolRequest.Builder,CreateIdentityPoolRequest>toBuilder in class CognitoIdentityRequestpublic static CreateIdentityPoolRequest.Builder builder()
public static Class<? extends CreateIdentityPoolRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.