CfnManagedLoginBrandingProps

class aws_cdk.aws_cognito.CfnManagedLoginBrandingProps(*, user_pool_id, assets=None, client_id=None, return_merged_resources=None, settings=None, use_cognito_provided_values=None)

Bases: object

Properties for defining a CfnManagedLoginBranding.

Parameters:

  • user_pool_id (str) – The user pool where the branding style is assigned.

  • assets (Union[IResolvable, Sequence[Union[IResolvable, AssetTypeProperty, Dict[str, Any]]], None]) – An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.

  • client_id (Optional[str]) – The app client that’s assigned to the branding style that you want more information about.

  • return_merged_resources (Union[bool, IResolvable, None]) – When true , returns values for branding options that are unchanged from Amazon Cognito defaults. When false or when you omit this parameter, returns only values that you customized in your branding style.

  • settings (Any) – A JSON file, encoded as a Document type, with the the settings that you want to apply to your style.

  • use_cognito_provided_values (Union[bool, IResolvable, None]) – When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer. When you specify true for this option, you must also omit values for Settings and Assets in the request.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.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

# settings: Any

cfn_managed_login_branding_props = cognito.CfnManagedLoginBrandingProps(
    user_pool_id="userPoolId",

    # the properties below are optional
    assets=[cognito.CfnManagedLoginBranding.AssetTypeProperty(
        category="category",
        color_mode="colorMode",
        extension="extension",

        # the properties below are optional
        bytes="bytes",
        resource_id="resourceId"
    )],
    client_id="clientId",
    return_merged_resources=False,
    settings=settings,
    use_cognito_provided_values=False
)

Attributes

assets

An array of image files that you want to apply to roles like backgrounds, logos, and icons.

Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.

See:

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

client_id

The app client that’s assigned to the branding style that you want more information about.

See:

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

return_merged_resources

When true , returns values for branding options that are unchanged from Amazon Cognito defaults.

When false or when you omit this parameter, returns only values that you customized in your branding style.

See:

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

settings

A JSON file, encoded as a Document type, with the the settings that you want to apply to your style.

See:

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

use_cognito_provided_values

When true, applies the default branding style options.

This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding designer.

When you specify true for this option, you must also omit values for Settings and Assets in the request.

See:

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

user_pool_id

The user pool where the branding style is assigned.

See:

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