interface AssetTypeProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Cognito.CfnManagedLoginBranding.AssetTypeProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnManagedLoginBranding_AssetTypeProperty |
![]() | software.amazon.awscdk.services.cognito.CfnManagedLoginBranding.AssetTypeProperty |
![]() | aws_cdk.aws_cognito.CfnManagedLoginBranding.AssetTypeProperty |
![]() | aws-cdk-lib » aws_cognito » CfnManagedLoginBranding » AssetTypeProperty |
An image file from a managed login branding style in a user pool.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const assetTypeProperty: cognito.CfnManagedLoginBranding.AssetTypeProperty = {
category: 'category',
colorMode: 'colorMode',
extension: 'extension',
// the properties below are optional
bytes: 'bytes',
resourceId: 'resourceId',
};
Properties
Name | Type | Description |
---|---|---|
category | string | The category that the image corresponds to in your managed login configuration. |
color | string | The display-mode target of the asset: light, dark, or browser-adaptive. |
extension | string | The file type of the image file. |
bytes? | string | The image file, in Base64-encoded binary. |
resource | string | The ID of the asset. |
category
Type:
string
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.
colorMode
Type:
string
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.
extension
Type:
string
The file type of the image file.
bytes?
Type:
string
(optional)
The image file, in Base64-encoded binary.
resourceId?
Type:
string
(optional)
The ID of the asset.