cognitoidentityprovider_create_managed_login_branding: Creates a new set of branding settings for a user pool style...

View source: R/cognitoidentityprovider_operations.R

cognitoidentityprovider_create_managed_login_brandingR Documentation

Creates a new set of branding settings for a user pool style and associates it with an app client

Description

Creates a new set of branding settings for a user pool style and associates it with an app client. This operation is the programmatic option for the creation of a new style in the branding designer.

See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_create_managed_login_branding/ for full documentation.

Usage

cognitoidentityprovider_create_managed_login_branding(
  UserPoolId,
  ClientId,
  UseCognitoProvidedValues = NULL,
  Settings = NULL,
  Assets = NULL
)

Arguments

UserPoolId

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

ClientId

[required] 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 delete_managed_login_branding and create a new one.

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.

Settings

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

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.


paws.security.identity documentation built on April 3, 2025, 10:59 p.m.