Class 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.

  • Method Details

    • 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

      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateIdentityPoolRequest.Builder,CreateIdentityPoolRequest>
      Specified by:
      toBuilder in class CognitoIdentityRequest
      Returns:
      a builder for type T
    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.