Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cognito
  5. ManagedLoginBranding

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cognito.ManagedLoginBranding

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Cognito::ManagedLoginBranding

    Create ManagedLoginBranding Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ManagedLoginBranding(name: string, args: ManagedLoginBrandingArgs, opts?: CustomResourceOptions);
    @overload
def ManagedLoginBranding(resource_name: str,
                         args: ManagedLoginBrandingArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def ManagedLoginBranding(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         user_pool_id: Optional[str] = None,
                         assets: Optional[Sequence[ManagedLoginBrandingAssetTypeArgs]] = None,
                         client_id: Optional[str] = None,
                         return_merged_resources: Optional[bool] = None,
                         settings: Optional[Any] = None,
                         use_cognito_provided_values: Optional[bool] = None)
    func NewManagedLoginBranding(ctx *Context, name string, args ManagedLoginBrandingArgs, opts ...ResourceOption) (*ManagedLoginBranding, error)
    public ManagedLoginBranding(string name, ManagedLoginBrandingArgs args, CustomResourceOptions? opts = null)
    public ManagedLoginBranding(String name, ManagedLoginBrandingArgs args)
public ManagedLoginBranding(String name, ManagedLoginBrandingArgs args, CustomResourceOptions options)

    type: aws-native:cognito:ManagedLoginBranding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ManagedLoginBrandingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ManagedLoginBrandingArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ManagedLoginBrandingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagedLoginBrandingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagedLoginBrandingArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ManagedLoginBranding Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ManagedLoginBranding resource accepts the following input properties:

    UserPoolId string
    The user pool where the branding style is assigned.
    Assets List<Pulumi.AwsNative.Cognito.Inputs.ManagedLoginBrandingAssetType>
    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.
    ClientId string
    The app client that's assigned to the branding style that you want more information about.
    ReturnMergedResources bool
    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 object

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

    Search the CloudFormation User Guide for AWS::Cognito::ManagedLoginBranding for more information about the expected schema for this property.

    UseCognitoProvidedValues bool

    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.

    UserPoolId string
    The user pool where the branding style is assigned.
    Assets []ManagedLoginBrandingAssetTypeArgs
    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.
    ClientId string
    The app client that's assigned to the branding style that you want more information about.
    ReturnMergedResources bool
    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 interface{}

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

    Search the CloudFormation User Guide for AWS::Cognito::ManagedLoginBranding for more information about the expected schema for this property.

    UseCognitoProvidedValues bool

    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.

    userPoolId String
    The user pool where the branding style is assigned.
    assets List<ManagedLoginBrandingAssetType>
    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.
    clientId String
    The app client that's assigned to the branding style that you want more information about.
    returnMergedResources Boolean
    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 Object

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

    Search the CloudFormation User Guide for AWS::Cognito::ManagedLoginBranding for more information about the expected schema for this property.

    useCognitoProvidedValues Boolean

    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.

    userPoolId string
    The user pool where the branding style is assigned.
    assets ManagedLoginBrandingAssetType[]
    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.
    clientId string
    The app client that's assigned to the branding style that you want more information about.
    returnMergedResources boolean
    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.

    Search the CloudFormation User Guide for AWS::Cognito::ManagedLoginBranding for more information about the expected schema for this property.

    useCognitoProvidedValues boolean

    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.

    user_pool_id str
    The user pool where the branding style is assigned.
    assets Sequence[ManagedLoginBrandingAssetTypeArgs]
    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 str
    The app client that's assigned to the branding style that you want more information about.
    return_merged_resources bool
    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.

    Search the CloudFormation User Guide for AWS::Cognito::ManagedLoginBranding for more information about the expected schema for this property.

    use_cognito_provided_values bool

    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.

    userPoolId String
    The user pool where the branding style is assigned.
    assets List<Property Map>
    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.
    clientId String
    The app client that's assigned to the branding style that you want more information about.
    returnMergedResources Boolean
    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.

    Search the CloudFormation User Guide for AWS::Cognito::ManagedLoginBranding for more information about the expected schema for this property.

    useCognitoProvidedValues Boolean

    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ManagedLoginBranding resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ManagedLoginBrandingId string
    The ID of the managed login branding style.
    Id string
    The provider-assigned unique ID for this managed resource.
    ManagedLoginBrandingId string
    The ID of the managed login branding style.
    id String
    The provider-assigned unique ID for this managed resource.
    managedLoginBrandingId String
    The ID of the managed login branding style.
    id string
    The provider-assigned unique ID for this managed resource.
    managedLoginBrandingId string
    The ID of the managed login branding style.
    id str
    The provider-assigned unique ID for this managed resource.
    managed_login_branding_id str
    The ID of the managed login branding style.
    id String
    The provider-assigned unique ID for this managed resource.
    managedLoginBrandingId String
    The ID of the managed login branding style.

    Supporting Types

    ManagedLoginBrandingAssetType, ManagedLoginBrandingAssetTypeArgs

    ManagedLoginBrandingCategoryType, ManagedLoginBrandingCategoryTypeArgs

    FaviconIco
    FAVICON_ICO
    FaviconSvg
    FAVICON_SVG
    EmailGraphic
    EMAIL_GRAPHIC
    SmsGraphic
    SMS_GRAPHIC
    AuthAppGraphic
    AUTH_APP_GRAPHIC
    PasswordGraphic
    PASSWORD_GRAPHIC
    PasskeyGraphic
    PASSKEY_GRAPHIC
    PageHeaderLogo
    PAGE_HEADER_LOGO
    PageHeaderBackground
    PAGE_HEADER_BACKGROUND
    PageFooterLogo
    PAGE_FOOTER_LOGO
    PageFooterBackground
    PAGE_FOOTER_BACKGROUND
    PageBackground
    PAGE_BACKGROUND
    FormBackground
    FORM_BACKGROUND
    FormLogo
    FORM_LOGO
    IdpButtonIcon
    IDP_BUTTON_ICON
    ManagedLoginBrandingCategoryTypeFaviconIco
    FAVICON_ICO
    ManagedLoginBrandingCategoryTypeFaviconSvg
    FAVICON_SVG
    ManagedLoginBrandingCategoryTypeEmailGraphic
    EMAIL_GRAPHIC
    ManagedLoginBrandingCategoryTypeSmsGraphic
    SMS_GRAPHIC
    ManagedLoginBrandingCategoryTypeAuthAppGraphic
    AUTH_APP_GRAPHIC
    ManagedLoginBrandingCategoryTypePasswordGraphic
    PASSWORD_GRAPHIC
    ManagedLoginBrandingCategoryTypePasskeyGraphic
    PASSKEY_GRAPHIC
    ManagedLoginBrandingCategoryTypePageHeaderLogo
    PAGE_HEADER_LOGO
    ManagedLoginBrandingCategoryTypePageHeaderBackground
    PAGE_HEADER_BACKGROUND
    ManagedLoginBrandingCategoryTypePageFooterLogo
    PAGE_FOOTER_LOGO
    ManagedLoginBrandingCategoryTypePageFooterBackground
    PAGE_FOOTER_BACKGROUND
    ManagedLoginBrandingCategoryTypePageBackground
    PAGE_BACKGROUND
    ManagedLoginBrandingCategoryTypeFormBackground
    FORM_BACKGROUND
    ManagedLoginBrandingCategoryTypeFormLogo
    FORM_LOGO
    ManagedLoginBrandingCategoryTypeIdpButtonIcon
    IDP_BUTTON_ICON
    FaviconIco
    FAVICON_ICO
    FaviconSvg
    FAVICON_SVG
    EmailGraphic
    EMAIL_GRAPHIC
    SmsGraphic
    SMS_GRAPHIC
    AuthAppGraphic
    AUTH_APP_GRAPHIC
    PasswordGraphic
    PASSWORD_GRAPHIC
    PasskeyGraphic
    PASSKEY_GRAPHIC
    PageHeaderLogo
    PAGE_HEADER_LOGO
    PageHeaderBackground
    PAGE_HEADER_BACKGROUND
    PageFooterLogo
    PAGE_FOOTER_LOGO
    PageFooterBackground
    PAGE_FOOTER_BACKGROUND
    PageBackground
    PAGE_BACKGROUND
    FormBackground
    FORM_BACKGROUND
    FormLogo
    FORM_LOGO
    IdpButtonIcon
    IDP_BUTTON_ICON
    FaviconIco
    FAVICON_ICO
    FaviconSvg
    FAVICON_SVG
    EmailGraphic
    EMAIL_GRAPHIC
    SmsGraphic
    SMS_GRAPHIC
    AuthAppGraphic
    AUTH_APP_GRAPHIC
    PasswordGraphic
    PASSWORD_GRAPHIC
    PasskeyGraphic
    PASSKEY_GRAPHIC
    PageHeaderLogo
    PAGE_HEADER_LOGO
    PageHeaderBackground
    PAGE_HEADER_BACKGROUND
    PageFooterLogo
    PAGE_FOOTER_LOGO
    PageFooterBackground
    PAGE_FOOTER_BACKGROUND
    PageBackground
    PAGE_BACKGROUND
    FormBackground
    FORM_BACKGROUND
    FormLogo
    FORM_LOGO
    IdpButtonIcon
    IDP_BUTTON_ICON
    FAVICON_ICO
    FAVICON_ICO
    FAVICON_SVG
    FAVICON_SVG
    EMAIL_GRAPHIC
    EMAIL_GRAPHIC
    SMS_GRAPHIC
    SMS_GRAPHIC
    AUTH_APP_GRAPHIC
    AUTH_APP_GRAPHIC
    PASSWORD_GRAPHIC
    PASSWORD_GRAPHIC
    PASSKEY_GRAPHIC
    PASSKEY_GRAPHIC
    PAGE_HEADER_LOGO
    PAGE_HEADER_LOGO
    PAGE_HEADER_BACKGROUND
    PAGE_HEADER_BACKGROUND
    PAGE_FOOTER_LOGO
    PAGE_FOOTER_LOGO
    PAGE_FOOTER_BACKGROUND
    PAGE_FOOTER_BACKGROUND
    PAGE_BACKGROUND
    PAGE_BACKGROUND
    FORM_BACKGROUND
    FORM_BACKGROUND
    FORM_LOGO
    FORM_LOGO
    IDP_BUTTON_ICON
    IDP_BUTTON_ICON
    "FAVICON_ICO"
    FAVICON_ICO
    "FAVICON_SVG"
    FAVICON_SVG
    "EMAIL_GRAPHIC"
    EMAIL_GRAPHIC
    "SMS_GRAPHIC"
    SMS_GRAPHIC
    "AUTH_APP_GRAPHIC"
    AUTH_APP_GRAPHIC
    "PASSWORD_GRAPHIC"
    PASSWORD_GRAPHIC
    "PASSKEY_GRAPHIC"
    PASSKEY_GRAPHIC
    "PAGE_HEADER_LOGO"
    PAGE_HEADER_LOGO
    "PAGE_HEADER_BACKGROUND"
    PAGE_HEADER_BACKGROUND
    "PAGE_FOOTER_LOGO"
    PAGE_FOOTER_LOGO
    "PAGE_FOOTER_BACKGROUND"
    PAGE_FOOTER_BACKGROUND
    "PAGE_BACKGROUND"
    PAGE_BACKGROUND
    "FORM_BACKGROUND"
    FORM_BACKGROUND
    "FORM_LOGO"
    FORM_LOGO
    "IDP_BUTTON_ICON"
    IDP_BUTTON_ICON

    ManagedLoginBrandingColorModeType, ManagedLoginBrandingColorModeTypeArgs

    Light
    LIGHT
    Dark
    DARK
    Dynamic
    DYNAMIC
    ManagedLoginBrandingColorModeTypeLight
    LIGHT
    ManagedLoginBrandingColorModeTypeDark
    DARK
    ManagedLoginBrandingColorModeTypeDynamic
    DYNAMIC
    Light
    LIGHT
    Dark
    DARK
    Dynamic
    DYNAMIC
    Light
    LIGHT
    Dark
    DARK
    Dynamic
    DYNAMIC
    LIGHT
    LIGHT
    DARK
    DARK
    DYNAMIC
    DYNAMIC
    "LIGHT"
    LIGHT
    "DARK"
    DARK
    "DYNAMIC"
    DYNAMIC

    ManagedLoginBrandingExtensionType, ManagedLoginBrandingExtensionTypeArgs

    Ico
    ICO
    Jpeg
    JPEG
    Png
    PNG
    Svg
    SVG
    Webp
    WEBP
    ManagedLoginBrandingExtensionTypeIco
    ICO
    ManagedLoginBrandingExtensionTypeJpeg
    JPEG
    ManagedLoginBrandingExtensionTypePng
    PNG
    ManagedLoginBrandingExtensionTypeSvg
    SVG
    ManagedLoginBrandingExtensionTypeWebp
    WEBP
    Ico
    ICO
    Jpeg
    JPEG
    Png
    PNG
    Svg
    SVG
    Webp
    WEBP
    Ico
    ICO
    Jpeg
    JPEG
    Png
    PNG
    Svg
    SVG
    Webp
    WEBP
    ICO
    ICO
    JPEG
    JPEG
    PNG
    PNG
    SVG
    SVG
    WEBP
    WEBP
    "ICO"
    ICO
    "JPEG"
    JPEG
    "PNG"
    PNG
    "SVG"
    SVG
    "WEBP"
    WEBP

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native