CfnUserPoolUICustomizationAttachmentProps

class aws_cdk.aws_cognito.CfnUserPoolUICustomizationAttachmentProps(*, client_id, user_pool_id, css=None)

Bases: object

Properties for defining a CfnUserPoolUICustomizationAttachment.

Parameters:
  • client_id (str) – The app client ID for your UI customization. When this value isn’t present, the customization applies to all user pool app clients that don’t have client-level settings..

  • user_pool_id (str) – The ID of the user pool where you want to apply branding to the classic hosted UI.

  • css (Optional[str]) – A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to your user pool App clients tab, select Login pages , edit Hosted UI (classic) style , and select the link to CSS template.css .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito

cfn_user_pool_uICustomization_attachment_props = cognito.CfnUserPoolUICustomizationAttachmentProps(
    client_id="clientId",
    user_pool_id="userPoolId",

    # the properties below are optional
    css="css"
)

Attributes

client_id

The app client ID for your UI customization.

When this value isn’t present, the customization applies to all user pool app clients that don’t have client-level settings..

See:

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

css

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

To download a template, go to the Amazon Cognito console. Navigate to your user pool App clients tab, select Login pages , edit Hosted UI (classic) style , and select the link to CSS template.css .

See:

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

user_pool_id

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

See:

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