CfnManagedLoginBrandingProps Struct
Properties for defining a CfnManagedLoginBranding.
Example
ts
// 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';
declare const settings: any;
const cfnManagedLoginBrandingProps: cognito.CfnManagedLoginBrandingProps = {
userPoolId: 'userPoolId',
// the properties below are optional
assets: [{
category: 'category',
colorMode: 'colorMode',
extension: 'extension',
// the properties below are optional
bytes: 'bytes',
resourceId: 'resourceId',
}],
clientId: 'clientId',
returnMergedResources: false,
settings: settings,
useCognitoProvidedValues: false,
};
Properties
assetsoptionalIResolvable | IResolvable | CfnManagedLoginBranding.AssetTypeProperty[]assetsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AssetTypeProperty]]]assetsoptionalIResolvableAssetsoptionalIResolvableAssetsoptionalinterface{}#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.
clientIdoptionalstringclient_idoptionalstrclientIdoptionalStringClientIdoptionalstringClientIdoptional*string#The app client that you want to assign the branding style to.
Each style is linked to an app client until you delete it.
returnMergedResourcesoptionalboolean | IResolvablereturn_merged_resourcesoptionaltyping.Union[bool, IResolvable]returnMergedResourcesoptionalBooleanReturnMergedResourcesoptionalboolReturnMergedResourcesoptionalinterface{}#When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults.
When false or when you omit this parameter, returns only values that you customized in your branding style.
settingsoptionalanysettingsoptionalAnysettingsoptionalObjectSettingsoptionalobjectSettingsoptionalinterface{}#A JSON file, encoded as a `Document` type, with the the settings that you want to apply to your style.
notes
The following components are not currently implemented and reserved for future use:
signUpinstructionssessionTimerDisplaylanguageSelector(for localization, see Managed login localization)
useCognitoProvidedValuesoptionalboolean | IResolvableuse_cognito_provided_valuesoptionaltyping.Union[bool, IResolvable]useCognitoProvidedValuesoptionalBooleanUseCognitoProvidedValuesoptionalboolUseCognitoProvidedValuesoptionalinterface{}#When true, applies the default branding style options.
notes
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.
The user pool where the branding style is assigned.