Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface ManagedLoginBrandingType.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ManagedLoginBrandingType.Builder,ManagedLoginBrandingType>, SdkBuilder<ManagedLoginBrandingType.Builder,ManagedLoginBrandingType>, SdkPojo
Enclosing class:
ManagedLoginBrandingType
@Mutable @NotThreadSafe public static interface ManagedLoginBrandingType.Builder extends SdkPojo, CopyableBuilder<ManagedLoginBrandingType.Builder,ManagedLoginBrandingType>

  • Method Details

    • managedLoginBrandingId

      ManagedLoginBrandingType.Builder managedLoginBrandingId(String managedLoginBrandingId)

      The ID of the managed login branding style.

      Parameters:
      managedLoginBrandingId - The ID of the managed login branding style.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userPoolId

      ManagedLoginBrandingType.Builder userPoolId(String userPoolId)

      The user pool where the branding style is assigned.

      Parameters:
      userPoolId - The user pool where the branding style is assigned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • useCognitoProvidedValues

      ManagedLoginBrandingType.Builder useCognitoProvidedValues(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 editor.

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

      Parameters:
      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 editor.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • settings

      ManagedLoginBrandingType.Builder settings(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:

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • assets

      ManagedLoginBrandingType.Builder assets(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assets

      ManagedLoginBrandingType.Builder assets(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assets

      ManagedLoginBrandingType.Builder assets(Consumer<AssetType.Builder>... 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.

      This is a convenience method that creates an instance of the AssetType.Builder avoiding the need to create one manually via AssetType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to assets(List<AssetType>).

      Parameters:
      assets - a consumer that will call methods on AssetType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creationDate

      ManagedLoginBrandingType.Builder creationDate(Instant creationDate)

      The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

      Parameters:
      creationDate - The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedDate

      ManagedLoginBrandingType.Builder lastModifiedDate(Instant lastModifiedDate)

      The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

      Parameters:
      lastModifiedDate - The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.