Package software.amazon.awscdk.services.cognito

Class CfnUserPoolUICustomizationAttachment

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

All Implemented Interfaces:

IEnvironmentAware, IInspectable, IUserPoolUICustomizationAttachmentRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-10T13:40:01.228Z")
@Stability(Stable)
public class CfnUserPoolUICustomizationAttachment
extends CfnResource
implements IInspectable, IUserPoolUICustomizationAttachmentRef

A container for the UI customization information for the hosted UI in a user pool.

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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnUserPoolUICustomizationAttachment.Builder	A fluent builder for CfnUserPoolUICustomizationAttachment.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.IUserPoolUICustomizationAttachmentRef

IUserPoolUICustomizationAttachmentRef.Jsii$Default, IUserPoolUICustomizationAttachmentRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnUserPoolUICustomizationAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserPoolUICustomizationAttachment(software.amazon.jsii.JsiiObjectRef objRef)
	CfnUserPoolUICustomizationAttachment(software.constructs.Construct scope, String id, CfnUserPoolUICustomizationAttachmentProps props)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
String	getClientId()	The app client ID for your UI customization.
String	getCss()	A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client.
String	getUserPoolId()	The ID of the user pool where you want to apply branding to the classic hosted UI.
UserPoolUICustomizationAttachmentReference	getUserPoolUiCustomizationAttachmentRef()	A reference to a UserPoolUICustomizationAttachment resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setClientId(String value)	The app client ID for your UI customization.
void	setCss(String value)	A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client.
void	setUserPoolId(String value)	The ID of the user pool where you want to apply branding to the classic hosted UI.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnUserPoolUICustomizationAttachmentProps 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.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getUserPoolUiCustomizationAttachmentRef

@Stability(Stable)
@NotNull
public UserPoolUICustomizationAttachmentReference getUserPoolUiCustomizationAttachmentRef()

A reference to a UserPoolUICustomizationAttachment resource.

Specified by:

getUserPoolUiCustomizationAttachmentRef in interface IUserPoolUICustomizationAttachmentRef

getClientId

@Stability(Stable)
@NotNull
public String getClientId()

The app client ID for your UI customization.

setClientId

@Stability(Stable)
public void setClientId(@NotNull
 String value)

The app client ID for your UI customization.

getUserPoolId

@Stability(Stable)
@NotNull
public String getUserPoolId()

The ID of the user pool where you want to apply branding to the classic hosted UI.

setUserPoolId

@Stability(Stable)
public void setUserPoolId(@NotNull
 String value)

The ID of the user pool where you want to apply branding to the classic hosted UI.

getCss

@Stability(Stable)
@Nullable
public String getCss()

A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client.

setCss

@Stability(Stable)
public void setCss(@Nullable
 String value)

A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client.