AWS::Cognito::ManagedLoginBranding AssetType - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Cognito::ManagedLoginBranding AssetType

An image file from a managed login branding style in a user pool.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Bytes" : String,
  "Category" : String,
  "ColorMode" : String,
  "Extension" : String,
  "ResourceId" : String
}

YAML

  Bytes: String
  Category: String
  ColorMode: String
  Extension: String
  ResourceId: String

Properties

Bytes

The image file, in Base64-encoded binary.

Required: No

Type: String

Maximum: 1000000

Update requires: No interruption

Category

The category that the image corresponds to in your managed login configuration. Managed login has asset categories for different types of logos, backgrounds, and icons.

Required: Yes

Type: String

Allowed values: FAVICON_ICO | FAVICON_SVG | EMAIL_GRAPHIC | SMS_GRAPHIC | AUTH_APP_GRAPHIC | PASSWORD_GRAPHIC | PASSKEY_GRAPHIC | PAGE_HEADER_LOGO | PAGE_HEADER_BACKGROUND | PAGE_FOOTER_LOGO | PAGE_FOOTER_BACKGROUND | PAGE_BACKGROUND | FORM_BACKGROUND | FORM_LOGO | IDP_BUTTON_ICON

Update requires: No interruption

ColorMode

The display-mode target of the asset: light, dark, or browser-adaptive. For example, Amazon Cognito displays a dark-mode image only when the browser or application is in dark mode, but displays a browser-adaptive file in all contexts.

Required: Yes

Type: String

Allowed values: LIGHT | DARK | DYNAMIC

Update requires: No interruption

Extension

The file type of the image file.

Required: Yes

Type: String

Allowed values: ICO | JPEG | PNG | SVG | WEBP

Update requires: No interruption

ResourceId

The ID of the asset.

Required: No

Type: String

Pattern: ^[\w\- ]+$

Minimum: 1

Maximum: 40

Update requires: No interruption