UpdateManagedLoginBrandingRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the UpdateManagedLoginBranding operation. Configures the branding settings for a user pool style. This operation is the programmatic option for the configuration of a style in the branding editor.

Provides values for UI customization in a Settings JSON object and image files in an Assets array.

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

In this article ▶

Inheritance Hierarchy

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

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

Syntax

public class UpdateManagedLoginBrandingRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The UpdateManagedLoginBrandingRequest type exposes the following members

Constructors

	Name	Description
	UpdateManagedLoginBrandingRequest()

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 roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
ManagedLoginBrandingId	System.String	Gets and sets the property ManagedLoginBrandingId. The ID of the managed login branding style that you want to update.
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.Nullable<System.Boolean>	Gets and sets the property 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.
UserPoolId	System.String	Gets and sets the property UserPoolId. The ID of the user pool that contains the managed login branding style that you want to update.

Version Information

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

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer