Class CreateManagedLoginBrandingRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
software.amazon.awssdk.services.cognitoidentityprovider.model.CreateManagedLoginBrandingRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateManagedLoginBrandingRequest.Builder,CreateManagedLoginBrandingRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateManagedLoginBrandingRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<CreateManagedLoginBrandingRequest.Builder,CreateManagedLoginBrandingRequest>

  • Method Details

    • userPoolId

      public final String userPoolId()

      The ID of the user pool where you want to create a new branding style.

      Returns:
      The ID of the user pool where you want to create a new branding style.

    • clientId

      public final String clientId()

      The app client that you want to create the branding style for. Each style is linked to an app client until you delete it.

      Returns:
      The app client that you want to create the branding style for. Each style is linked to an app client until you delete it.

    • useCognitoProvidedValues

      public final Boolean useCognitoProvidedValues()

      When true, applies the default branding style options. These default options are managed by Amazon Cognito. You can modify them later in the branding editor.

      When you specify true for this option, you must also omit values for Settings and Assets in the request.

      Returns:
      When true, applies the default branding style options. These default options are managed by Amazon Cognito. You can modify them later in the branding editor.

      When you specify true for this option, you must also omit values for Settings and Assets in the request.

    • settings

      public final Document settings()

      A JSON file, encoded as a Document type, with the the settings that you want to apply to your style.

      The following components are not currently implemented and reserved for future use:

      Returns:
      A JSON file, encoded as a Document type, with the the settings that you want to apply to your style.

      The following components are not currently implemented and reserved for future use:

    • hasAssets

      public final boolean hasAssets()
      For responses, this returns true if the service returned a value for the Assets 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.

    • assets

      public final List<AssetType> assets()

      An array of image files that you want to apply to functions like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.

      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 hasAssets() method.

      Returns:
      An array of image files that you want to apply to functions like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.

    • toBuilder

      public CreateManagedLoginBrandingRequest.Builder 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<CreateManagedLoginBrandingRequest.Builder,CreateManagedLoginBrandingRequest>
      Specified by:
      toBuilder in class CognitoIdentityProviderRequest
      Returns:
      a builder for type T

    • builder

      public static CreateManagedLoginBrandingRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateManagedLoginBrandingRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.