Package software.amazon.awscdk.services.cognito

Class CfnUserPoolUICustomizationAttachment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cognito.CfnUserPoolUICustomizationAttachment
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.995Z") @Stability(Stable) public class CfnUserPoolUICustomizationAttachment extends CfnResource implements IInspectable
A CloudFormation AWS::Cognito::UserPoolUICustomizationAttachment.

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.

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.*;
 CfnUserPoolUICustomizationAttachment cfnUserPoolUICustomizationAttachment = CfnUserPoolUICustomizationAttachment.Builder.create(this, "MyCfnUserPoolUICustomizationAttachment")
         .clientId("clientId")
         .userPoolId("userPoolId")
         // the properties below are optional
         .css("css")
         .build();

  • 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

    • CfnUserPoolUICustomizationAttachment

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

    • CfnUserPoolUICustomizationAttachment

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

    • CfnUserPoolUICustomizationAttachment

      @Stability(Stable) public CfnUserPoolUICustomizationAttachment(@NotNull Construct scope, @NotNull String id, @NotNull CfnUserPoolUICustomizationAttachmentProps props)
      Create a new AWS::Cognito::UserPoolUICustomizationAttachment.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

    • getCfnProperties

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

    • getClientId

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

      You can specify the UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL ).

    • setClientId

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

      You can specify the UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL ).

    • 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.