Interface CreateManagedLoginBrandingRequest.Builder

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

  • Method Details

    • userPoolId

      CreateManagedLoginBrandingRequest.Builder userPoolId(String userPoolId)

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

      Parameters:
      userPoolId - The ID of the user pool where you want to create a new branding style.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientId

      CreateManagedLoginBrandingRequest.Builder clientId(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.

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

    • useCognitoProvidedValues

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

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

    • settings

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

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

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

    • assets

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

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

    • assets

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

      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:

    • overrideConfiguration

      CreateManagedLoginBrandingRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateManagedLoginBrandingRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.