Package software.amazon.awscdk.cfnpropertymixins.services.cognito

Class CfnManagedLoginBrandingPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnManagedLoginBrandingPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-14T18:32:10.269Z") @Stability(Stable) public class CfnManagedLoginBrandingPropsMixin extends Mixin implements software.constructs.IMixin
Creates a new set of branding settings for a user pool style and associates it with an app client.

This operation is the programmatic option for the creation of a new style in the branding designer.

Provides values for UI customization in a Settings JSON object and image files in an Assets array. To send the JSON object Document type parameter in Settings , you might need to update to the most recent version of your AWS SDK.

This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit.

As a best practice, modify the output of DescribeManagedLoginBrandingByClient into the request parameters for this operation. To get all settings, set ReturnMergedResources to true . For more information, see API and SDK operations for managed login branding

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cognito.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 Object settings;
 CfnManagedLoginBrandingPropsMixin cfnManagedLoginBrandingPropsMixin = CfnManagedLoginBrandingPropsMixin.Builder.create(CfnManagedLoginBrandingMixinProps.builder()
         .assets(List.of(AssetTypeProperty.builder()
                 .bytes("bytes")
                 .category("category")
                 .colorMode("colorMode")
                 .extension("extension")
                 .resourceId("resourceId")
                 .build()))
         .clientId("clientId")
         .returnMergedResources(false)
         .settings(settings)
         .useCognitoProvidedValues(false)
         .userPoolId("userPoolId")
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnManagedLoginBrandingPropsMixin

      protected CfnManagedLoginBrandingPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnManagedLoginBrandingPropsMixin

      protected CfnManagedLoginBrandingPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnManagedLoginBrandingPropsMixin

      @Stability(Stable) public CfnManagedLoginBrandingPropsMixin(@NotNull CfnManagedLoginBrandingMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::Cognito::ManagedLoginBranding.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnManagedLoginBrandingPropsMixin

      @Stability(Stable) public CfnManagedLoginBrandingPropsMixin(@NotNull CfnManagedLoginBrandingMixinProps props)
      Create a mixin to apply properties to AWS::Cognito::ManagedLoginBranding.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnManagedLoginBrandingMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()