Class CfnUserPoolUICustomizationAttachment

A CloudFormation AWS::Cognito::UserPoolUICustomizationAttachment.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnUserPoolUICustomizationAttachment

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.AWS.Cognito.dll

Syntax (csharp)

public class CfnUserPoolUICustomizationAttachment : CfnResource, IConstruct, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnUserPoolUICustomizationAttachment
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable

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

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

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;

CfnUserPoolUICustomizationAttachment cfnUserPoolUICustomizationAttachment = new CfnUserPoolUICustomizationAttachment(this, "MyCfnUserPoolUICustomizationAttachment", new CfnUserPoolUICustomizationAttachmentProps {
    ClientId = "clientId",
    UserPoolId = "userPoolId",

    // the properties below are optional
    Css = "css"
});

Synopsis

Constructors

CfnUserPoolUICustomizationAttachment(Construct, String, ICfnUserPoolUICustomizationAttachmentProps)	Create a new `AWS::Cognito::UserPoolUICustomizationAttachment`.
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

Properties

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(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 System.String

scoped id of the resource.

props ICfnUserPoolUICustomizationAttachmentProps

resource properties.

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

Properties

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

CfnResource.CfnProperties

ClientId

The client ID for the client app.

public virtual string ClientId { get; set; }

Property Value

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

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

System.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 System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable