Class UpdateManagedLoginBrandingRequest

    • Method Detail

      • userPoolId

        public final String userPoolId()

        The ID of the user pool that contains the managed login branding style that you want to update.

        Returns:
        The ID of the user pool that contains the managed login branding style that you want to update.
      • managedLoginBrandingId

        public final String managedLoginBrandingId()

        The ID of the managed login branding style that you want to update.

        Returns:
        The ID of the managed login branding style that you want to update.
      • useCognitoProvidedValues

        public final Boolean useCognitoProvidedValues()

        When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer.

        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. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer.

        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.

        Returns:
        A JSON file, encoded as a Document type, with the the settings that you want to apply to your style.
      • 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 roles 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 roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
      • 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