ManagedLoginBrandingType - Amazon Cognito User Pools

ManagedLoginBrandingType

A managed login branding style that's assigned to a user pool app client.

This data type is a response parameter of CreateManagedLoginBranding, UpdateManagedLoginBranding, DescribeManagedLoginBranding, and DescribeManagedLoginBrandingByClient.

Contents

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.

Type: Array of AssetType objects

Array Members: Minimum number of 0 items. Maximum number of 40 items.

Required: No

CreationDate

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Type: Timestamp

Required: No

LastModifiedDate

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Type: Timestamp

Required: No

ManagedLoginBrandingId

The ID of the managed login branding style.

Type: String

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Required: No

Settings

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

Type: JSON value

Required: No

UseCognitoProvidedValues

When true, applies the default branding style options. This option reverts to a "blank" style that you can modify later in the branding designer.

Type: Boolean

Required: No

UserPoolId

The user pool where the branding style is assigned.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+_[0-9a-zA-Z]+

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: