Class CfnUserPoolUICustomizationAttachment

All Implemented Interfaces:
IInspectable,, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:33:59.485Z") @Stability(Stable) public class CfnUserPoolUICustomizationAttachment extends CfnResource implements IInspectable
The AWS::Cognito::UserPoolUICustomizationAttachment resource sets the UI customization information for a user pool's built-in app UI.

You can specify app UI customization settings for a single client (with a specific clientId ) or for all clients (by setting the clientId to ALL ). If you specify ALL , the default configuration is used for every client that has had no UI customization set previously. If you specify UI customization settings for a particular client, it no longer falls back to the ALL configuration.

Before you create this resource, your user pool must have a domain associated with it. You can create an AWS::Cognito::UserPoolDomain resource first in this user pool.

Setting a logo image isn't supported from AWS CloudFormation . Use the Amazon Cognito SetUICustomization API operation to set the image.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnUserPoolUICustomizationAttachment cfnUserPoolUICustomizationAttachment = CfnUserPoolUICustomizationAttachment.Builder.create(this, "MyCfnUserPoolUICustomizationAttachment")
         // the properties below are optional

See Also:
  • Field Details


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

    • CfnUserPoolUICustomizationAttachment

      protected CfnUserPoolUICustomizationAttachment( objRef)
    • CfnUserPoolUICustomizationAttachment

      protected CfnUserPoolUICustomizationAttachment( initializationMode)
    • CfnUserPoolUICustomizationAttachment

      @Stability(Stable) public CfnUserPoolUICustomizationAttachment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUserPoolUICustomizationAttachmentProps props)
      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
      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)
      renderProperties in class CfnResource
      props - This parameter is required.
    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The resource ID.
    • getCfnProperties

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

      @Stability(Stable) @NotNull public String getClientId()
      The client ID for the client app.
    • setClientId

      @Stability(Stable) public void setClientId(@NotNull String value)
      The client ID for the client app.
    • getUserPoolId

      @Stability(Stable) @NotNull public String getUserPoolId()
      The user pool ID for the user pool.
    • setUserPoolId

      @Stability(Stable) public void setUserPoolId(@NotNull String value)
      The user pool ID for the user pool.
    • getCss

      @Stability(Stable) @Nullable public String getCss()
      The CSS values in the UI customization.
    • setCss

      @Stability(Stable) public void setCss(@Nullable String value)
      The CSS values in the UI customization.