Package software.amazon.awscdk.services.cognito

Class CfnManagedLoginBranding

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cognito.CfnManagedLoginBranding
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2025-01-10T21:56:48.824Z") @Stability(Stable) public class CfnManagedLoginBranding extends CfnResource implements IInspectable
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.services.cognito.*;
 Object settings;
 CfnManagedLoginBranding cfnManagedLoginBranding = CfnManagedLoginBranding.Builder.create(this, "MyCfnManagedLoginBranding")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnManagedLoginBranding

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

    • CfnManagedLoginBranding

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

    • CfnManagedLoginBranding

      @Stability(Stable) public CfnManagedLoginBranding(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnManagedLoginBrandingProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrManagedLoginBrandingId

      @Stability(Stable) @NotNull public String getAttrManagedLoginBrandingId()
      The ID of the managed login branding style.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getUserPoolId

      @Stability(Stable) @NotNull public String getUserPoolId()
      The user pool where the branding style is assigned.

    • setUserPoolId

      @Stability(Stable) public void setUserPoolId(@NotNull String value)
      The user pool where the branding style is assigned.

    • getAssets

      @Stability(Stable) @Nullable public Object getAssets()
      An array of image files that you want to apply to roles like backgrounds, logos, and icons.

    • setAssets

      @Stability(Stable) public void setAssets(@Nullable IResolvable value)
      An array of image files that you want to apply to roles like backgrounds, logos, and icons.

    • setAssets

      @Stability(Stable) public void setAssets(@Nullable List<Object> value)
      An array of image files that you want to apply to roles like backgrounds, logos, and icons.

    • getClientId

      @Stability(Stable) @Nullable public String getClientId()
      The app client that's assigned to the branding style that you want more information about.

    • setClientId

      @Stability(Stable) public void setClientId(@Nullable String value)
      The app client that's assigned to the branding style that you want more information about.

    • getReturnMergedResources

      @Stability(Stable) @Nullable public Object getReturnMergedResources()
      When true , returns values for branding options that are unchanged from Amazon Cognito defaults.

    • setReturnMergedResources

      @Stability(Stable) public void setReturnMergedResources(@Nullable Boolean value)
      When true , returns values for branding options that are unchanged from Amazon Cognito defaults.

    • setReturnMergedResources

      @Stability(Stable) public void setReturnMergedResources(@Nullable IResolvable value)
      When true , returns values for branding options that are unchanged from Amazon Cognito defaults.

    • getSettings

      @Stability(Stable) @Nullable public Object getSettings()
      A JSON file, encoded as a Document type, with the the settings that you want to apply to your style.

    • setSettings

      @Stability(Stable) public void setSettings(@Nullable Object value)
      A JSON file, encoded as a Document type, with the the settings that you want to apply to your style.

    • getUseCognitoProvidedValues

      @Stability(Stable) @Nullable public Object getUseCognitoProvidedValues()
      When true, applies the default branding style options.

    • setUseCognitoProvidedValues

      @Stability(Stable) public void setUseCognitoProvidedValues(@Nullable Boolean value)
      When true, applies the default branding style options.

    • setUseCognitoProvidedValues

      @Stability(Stable) public void setUseCognitoProvidedValues(@Nullable IResolvable value)
      When true, applies the default branding style options.