java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cognitoidentity.model.CognitoIdentityRequest
    - - software.amazon.awssdk.services.cognitoidentity.model.CreateIdentityPoolRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateIdentityPoolRequest.Builder,CreateIdentityPoolRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateIdentityPoolRequest
extends CognitoIdentityRequest
implements ToCopyableBuilder<CreateIdentityPoolRequest.Builder,CreateIdentityPoolRequest>

Input to the CreateIdentityPool action.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateIdentityPoolRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - identityPoolName
```
public final String identityPoolName()
```
    A string that you provide.
    
    Returns:
    
    A string that you provide.
  - allowUnauthenticatedIdentities
```
public final Boolean allowUnauthenticatedIdentities()
```
    TRUE if the identity pool supports unauthenticated logins.
    
    Returns:
    
    TRUE if the identity pool supports unauthenticated logins.
  - allowClassicFlow
```
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.
    
    Returns:
    
    Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
  - hasSupportedLoginProviders
```
public final boolean hasSupportedLoginProviders()
```
    For responses, this returns true if the service returned a value for the SupportedLoginProviders property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - supportedLoginProviders
```
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.
    
    Returns:
    
    Optional key:value pairs mapping provider names to provider app IDs.
  - developerProviderName
```
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.
    
    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.
  - hasOpenIdConnectProviderARNs
```
public final boolean hasOpenIdConnectProviderARNs()
```
    For responses, this returns true if the service returned a value for the OpenIdConnectProviderARNs property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - openIdConnectProviderARNs
```
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.
    
    Returns:
    
    The Amazon Resource Names (ARN) of the OpenID Connect providers.
  - hasCognitoIdentityProviders
```
public final boolean hasCognitoIdentityProviders()
```
    For responses, this returns true if the service returned a value for the CognitoIdentityProviders property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - cognitoIdentityProviders
```
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.
    
    Returns:
    
    An array of Amazon Cognito user pools and their client IDs.
  - hasSamlProviderARNs
```
public final boolean hasSamlProviderARNs()
```
    For responses, this returns true if the service returned a value for the SamlProviderARNs property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - samlProviderARNs
```
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.
    
    Returns:
    
    An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
  - hasIdentityPoolTags
```
public final boolean hasIdentityPoolTags()
```
    For responses, this returns true if the service returned a value for the IdentityPoolTags property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - identityPoolTags
```
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.
    
    Returns:
    
    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.
  - toBuilder
```
public CreateIdentityPoolRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateIdentityPoolRequest.Builder,CreateIdentityPoolRequest>
    
    Specified by:
    
    toBuilder in class CognitoIdentityRequest
  - builder
```
public static CreateIdentityPoolRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateIdentityPoolRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateIdentityPoolRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

identityPoolName

allowUnauthenticatedIdentities

allowClassicFlow

hasSupportedLoginProviders

supportedLoginProviders

developerProviderName

hasOpenIdConnectProviderARNs

openIdConnectProviderARNs

hasCognitoIdentityProviders

cognitoIdentityProviders

hasSamlProviderARNs

samlProviderARNs

hasIdentityPoolTags

identityPoolTags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField