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:
IInspectable
,software.amazon.jsii.JsiiSerializable
,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.
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnUserPoolUICustomizationAttachment
.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
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
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 TypeMethodDescriptionThe resource ID.The client ID for the client app.getCss()
The CSS values in the UI customization.The user pool ID for the user pool.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setClientId
(String value) The client ID for the client app.void
The CSS values in the UI customization.void
setUserPoolId
(String value) The user pool ID for the user pool.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, 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.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
The resource ID. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getClientId
The client ID for the client app. -
setClientId
The client ID for the client app. -
getUserPoolId
The user pool ID for the user pool. -
setUserPoolId
The user pool ID for the user pool. -
getCss
The CSS values in the UI customization. -
setCss
The CSS values in the UI customization.
-