Interface CfnManagedLoginBrandingProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnManagedLoginBrandingProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-05-19T18:25:46.459Z")
@Stability(Stable)
public interface CfnManagedLoginBrandingProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnManagedLoginBranding.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 Object settings;
 CfnManagedLoginBrandingProps cfnManagedLoginBrandingProps = CfnManagedLoginBrandingProps.builder()
         .userPoolId("userPoolId")
         // the properties below are optional
         .assets(List.of(AssetTypeProperty.builder()
                 .category("category")
                 .colorMode("colorMode")
                 .extension("extension")
                 // the properties below are optional
                 .bytes("bytes")
                 .resourceId("resourceId")
                 .build()))
         .clientId("clientId")
         .returnMergedResources(false)
         .settings(settings)
         .useCognitoProvidedValues(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnManagedLoginBrandingProps.Builder	A builder for CfnManagedLoginBrandingProps
static final class	CfnManagedLoginBrandingProps.Jsii$Proxy	An implementation for CfnManagedLoginBrandingProps

Method Summary

Modifier and Type	Method	Description
static CfnManagedLoginBrandingProps.Builder	builder()
default Object	getAssets()	An array of image files that you want to apply to roles like backgrounds, logos, and icons.
default String	getClientId()	The app client that you want to assign the branding style to.
default Object	getReturnMergedResources()	When true , returns values for branding options that are unchanged from Amazon Cognito defaults.
default Object	getSettings()	A JSON file, encoded as a Document type, with the the settings that you want to apply to your style.
default Object	getUseCognitoProvidedValues()	When true, applies the default branding style options.
String	getUserPoolId()	The user pool where the branding style is assigned.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUserPoolId

@Stability(Stable)
@NotNull
String getUserPoolId()

The user pool where the branding style is assigned.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-userpoolid

getAssets

@Stability(Stable)
@Nullable
default Object getAssets()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-assets

getClientId

@Stability(Stable)
@Nullable
default String getClientId()

The app client that you want to assign the branding style to.

Each style is linked to an app client until you delete it.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-clientid

getReturnMergedResources

@Stability(Stable)
@Nullable
default Object getReturnMergedResources()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-returnmergedresources

getSettings

@Stability(Stable)
@Nullable
default Object getSettings()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-settings

getUseCognitoProvidedValues

@Stability(Stable)
@Nullable
default Object getUseCognitoProvidedValues()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-usecognitoprovidedvalues

builder

@Stability(Stable)
static CfnManagedLoginBrandingProps.Builder builder()

Returns:

a CfnManagedLoginBrandingProps.Builder of CfnManagedLoginBrandingProps