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

Interface CreateManagedLoginBrandingRequest.Builder

    • Method Detail

      • 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 permanently linked to an app client. To change the style for an app client, delete the existing style with DeleteManagedLoginBranding and create a new one.

        Parameters:
        clientId - The app client that you want to create the branding style for. Each style is permanently linked to an app client. To change the style for an app client, delete the existing style with DeleteManagedLoginBranding and create a new one.
        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 designer.

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

        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.

        Parameters:
        settings - A JSON file, encoded as a Document type, with the the settings that you want to apply to your style.
        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 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

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

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

        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:
        #assets(java.util.Collection)