CreateManagedLoginBrandingRequest Class

Container for the parameters to the CreateManagedLoginBranding operation. 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 editor.

Provides values for UI customization in a Settings JSON object and image files in an Assets array. To send the JSON object Document type parameter in Settings, you might need to update to the most recent version of your Amazon Web Services SDK. To create a new style with default settings, set UseCognitoProvidedValues to true and don't provide values for any other options.

This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.CreateManagedLoginBrandingRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

public class CreateManagedLoginBrandingRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The CreateManagedLoginBrandingRequest type exposes the following members

Constructors

	Name	Description
	CreateManagedLoginBrandingRequest()

Properties

Name	Type	Description
Assets	System.Collections.Generic.List<Amazon.CognitoIdentityProvider.Model.AssetType>	Gets and sets the property 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.
ClientId	System.String	Gets and sets the property 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.
Settings	Amazon.Runtime.Documents.Document	Gets and sets the property 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: `signUp` `instructions` `sessionTimerDisplay` `languageSelector` (for localization, see Managed login localization)
UseCognitoProvidedValues	System.Boolean	Gets and sets the property 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.
UserPoolId	System.String	Gets and sets the property UserPoolId. The ID of the user pool where you want to create a new branding style.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5