Class CfnUserPoolUICustomizationAttachment
The AWS::Cognito::UserPoolUICustomizationAttachment
resource sets the UI customization information for a user pool's built-in app UI.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnUserPoolUICustomizationAttachment : CfnResource, IInspectable
Syntax (vb)
Public Class CfnUserPoolUICustomizationAttachment
Inherits CfnResource
Implements IInspectable
Remarks
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.
CloudformationResource: AWS::Cognito::UserPoolUICustomizationAttachment
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
var cfnUserPoolUICustomizationAttachment = new CfnUserPoolUICustomizationAttachment(this, "MyCfnUserPoolUICustomizationAttachment", new CfnUserPoolUICustomizationAttachmentProps {
ClientId = "clientId",
UserPoolId = "userPoolId",
// the properties below are optional
Css = "css"
});
Synopsis
Constructors
CfnUserPoolUICustomizationAttachment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnUserPoolUICustomizationAttachment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnUserPoolUICustomizationAttachment(Construct, String, ICfnUserPoolUICustomizationAttachmentProps) |
Properties
AttrId | The resource ID. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClientId | The client ID for the client app. |
Css | The CSS values in the UI customization. |
UserPoolId | The user pool ID for the user pool. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnUserPoolUICustomizationAttachment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnUserPoolUICustomizationAttachment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnUserPoolUICustomizationAttachment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnUserPoolUICustomizationAttachment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnUserPoolUICustomizationAttachment(Construct, String, ICfnUserPoolUICustomizationAttachmentProps)
public CfnUserPoolUICustomizationAttachment(Construct scope, string id, ICfnUserPoolUICustomizationAttachmentProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnUserPoolUICustomizationAttachmentProps
Resource properties.
Properties
AttrId
The resource ID.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ClientId
The client ID for the client app.
public virtual string ClientId { get; set; }
Property Value
System.String
Css
The CSS values in the UI customization.
public virtual string Css { get; set; }
Property Value
System.String
UserPoolId
The user pool ID for the user pool.
public virtual string UserPoolId { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>