Class CfnUserPoolUICustomizationAttachment

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

A CloudFormation AWS::Cognito::UserPoolUICustomizationAttachment.

public class CfnUserPoolUICustomizationAttachment : CfnResource, IInspectable

Inheritance

object

CfnUserPoolUICustomizationAttachment

Implements

IInspectable

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"
             });

Remarks

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 <code>AWS::Cognito::UserPoolDomain</code> 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

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

ExampleMetadata: fixture=_generated

Constructors

CfnUserPoolUICustomizationAttachment(Construct, string, ICfnUserPoolUICustomizationAttachmentProps)

Create a new AWS::Cognito::UserPoolUICustomizationAttachment.

public CfnUserPoolUICustomizationAttachment(Construct scope, string id, ICfnUserPoolUICustomizationAttachmentProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnUserPoolUICustomizationAttachmentProps

• resource properties.

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

ClientId

The client ID for the client app.

public virtual string ClientId { get; set; }

Property Value

string

Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html#cfn-cognito-userpooluicustomizationattachment-clientid

Css

The CSS values in the UI customization.

public virtual string? Css { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html#cfn-cognito-userpooluicustomizationattachment-css

UserPoolId

The user pool ID for the user pool.

public virtual string UserPoolId { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpooluicustomizationattachment.html#cfn-cognito-userpooluicustomizationattachment-userpoolid

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 IDictionary<string, object>

Returns

IDictionary<string, object>