1. Packages
  2. AWS Classic
  3. API Docs
  4. cognito
  5. UserPoolUICustomization

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.0 published on Monday, Apr 15, 2024 by Pulumi

aws.cognito.UserPoolUICustomization

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.0 published on Monday, Apr 15, 2024 by Pulumi

    Provides a Cognito User Pool UI Customization resource.

    Note: To use this resource, the user pool must have a domain associated with it. For more information, see the Amazon Cognito Developer Guide on Customizing the Built-in Sign-In and Sign-up Webpages.

    Example Usage

    UI customization settings for a single client

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    import * as std from "@pulumi/std";
    
    const example = new aws.cognito.UserPool("example", {name: "example"});
    const exampleUserPoolDomain = new aws.cognito.UserPoolDomain("example", {
        domain: "example",
        userPoolId: example.id,
    });
    const exampleUserPoolClient = new aws.cognito.UserPoolClient("example", {
        name: "example",
        userPoolId: example.id,
    });
    const exampleUserPoolUICustomization = new aws.cognito.UserPoolUICustomization("example", {
        clientId: exampleUserPoolClient.id,
        css: ".label-customizable {font-weight: 400;}",
        imageFile: std.filebase64({
            input: "logo.png",
        }).then(invoke => invoke.result),
        userPoolId: exampleUserPoolDomain.userPoolId,
    });
    
    import pulumi
    import pulumi_aws as aws
    import pulumi_std as std
    
    example = aws.cognito.UserPool("example", name="example")
    example_user_pool_domain = aws.cognito.UserPoolDomain("example",
        domain="example",
        user_pool_id=example.id)
    example_user_pool_client = aws.cognito.UserPoolClient("example",
        name="example",
        user_pool_id=example.id)
    example_user_pool_ui_customization = aws.cognito.UserPoolUICustomization("example",
        client_id=example_user_pool_client.id,
        css=".label-customizable {font-weight: 400;}",
        image_file=std.filebase64(input="logo.png").result,
        user_pool_id=example_user_pool_domain.user_pool_id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cognito"
    	"github.com/pulumi/pulumi-std/sdk/go/std"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := cognito.NewUserPool(ctx, "example", &cognito.UserPoolArgs{
    			Name: pulumi.String("example"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleUserPoolDomain, err := cognito.NewUserPoolDomain(ctx, "example", &cognito.UserPoolDomainArgs{
    			Domain:     pulumi.String("example"),
    			UserPoolId: example.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		exampleUserPoolClient, err := cognito.NewUserPoolClient(ctx, "example", &cognito.UserPoolClientArgs{
    			Name:       pulumi.String("example"),
    			UserPoolId: example.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		invokeFilebase64, err := std.Filebase64(ctx, &std.Filebase64Args{
    			Input: "logo.png",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = cognito.NewUserPoolUICustomization(ctx, "example", &cognito.UserPoolUICustomizationArgs{
    			ClientId:   exampleUserPoolClient.ID(),
    			Css:        pulumi.String(".label-customizable {font-weight: 400;}"),
    			ImageFile:  invokeFilebase64.Result,
    			UserPoolId: exampleUserPoolDomain.UserPoolId,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    using Std = Pulumi.Std;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Cognito.UserPool("example", new()
        {
            Name = "example",
        });
    
        var exampleUserPoolDomain = new Aws.Cognito.UserPoolDomain("example", new()
        {
            Domain = "example",
            UserPoolId = example.Id,
        });
    
        var exampleUserPoolClient = new Aws.Cognito.UserPoolClient("example", new()
        {
            Name = "example",
            UserPoolId = example.Id,
        });
    
        var exampleUserPoolUICustomization = new Aws.Cognito.UserPoolUICustomization("example", new()
        {
            ClientId = exampleUserPoolClient.Id,
            Css = ".label-customizable {font-weight: 400;}",
            ImageFile = Std.Filebase64.Invoke(new()
            {
                Input = "logo.png",
            }).Apply(invoke => invoke.Result),
            UserPoolId = exampleUserPoolDomain.UserPoolId,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.cognito.UserPool;
    import com.pulumi.aws.cognito.UserPoolArgs;
    import com.pulumi.aws.cognito.UserPoolDomain;
    import com.pulumi.aws.cognito.UserPoolDomainArgs;
    import com.pulumi.aws.cognito.UserPoolClient;
    import com.pulumi.aws.cognito.UserPoolClientArgs;
    import com.pulumi.aws.cognito.UserPoolUICustomization;
    import com.pulumi.aws.cognito.UserPoolUICustomizationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new UserPool("example", UserPoolArgs.builder()        
                .name("example")
                .build());
    
            var exampleUserPoolDomain = new UserPoolDomain("exampleUserPoolDomain", UserPoolDomainArgs.builder()        
                .domain("example")
                .userPoolId(example.id())
                .build());
    
            var exampleUserPoolClient = new UserPoolClient("exampleUserPoolClient", UserPoolClientArgs.builder()        
                .name("example")
                .userPoolId(example.id())
                .build());
    
            var exampleUserPoolUICustomization = new UserPoolUICustomization("exampleUserPoolUICustomization", UserPoolUICustomizationArgs.builder()        
                .clientId(exampleUserPoolClient.id())
                .css(".label-customizable {font-weight: 400;}")
                .imageFile(StdFunctions.filebase64(Filebase64Args.builder()
                    .input("logo.png")
                    .build()).result())
                .userPoolId(exampleUserPoolDomain.userPoolId())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:cognito:UserPool
        properties:
          name: example
      exampleUserPoolDomain:
        type: aws:cognito:UserPoolDomain
        name: example
        properties:
          domain: example
          userPoolId: ${example.id}
      exampleUserPoolClient:
        type: aws:cognito:UserPoolClient
        name: example
        properties:
          name: example
          userPoolId: ${example.id}
      exampleUserPoolUICustomization:
        type: aws:cognito:UserPoolUICustomization
        name: example
        properties:
          clientId: ${exampleUserPoolClient.id}
          css: '.label-customizable {font-weight: 400;}'
          imageFile:
            fn::invoke:
              Function: std:filebase64
              Arguments:
                input: logo.png
              Return: result
          userPoolId: ${exampleUserPoolDomain.userPoolId}
    

    UI customization settings for all clients

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    import * as std from "@pulumi/std";
    
    const example = new aws.cognito.UserPool("example", {name: "example"});
    const exampleUserPoolDomain = new aws.cognito.UserPoolDomain("example", {
        domain: "example",
        userPoolId: example.id,
    });
    const exampleUserPoolUICustomization = new aws.cognito.UserPoolUICustomization("example", {
        css: ".label-customizable {font-weight: 400;}",
        imageFile: std.filebase64({
            input: "logo.png",
        }).then(invoke => invoke.result),
        userPoolId: exampleUserPoolDomain.userPoolId,
    });
    
    import pulumi
    import pulumi_aws as aws
    import pulumi_std as std
    
    example = aws.cognito.UserPool("example", name="example")
    example_user_pool_domain = aws.cognito.UserPoolDomain("example",
        domain="example",
        user_pool_id=example.id)
    example_user_pool_ui_customization = aws.cognito.UserPoolUICustomization("example",
        css=".label-customizable {font-weight: 400;}",
        image_file=std.filebase64(input="logo.png").result,
        user_pool_id=example_user_pool_domain.user_pool_id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cognito"
    	"github.com/pulumi/pulumi-std/sdk/go/std"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := cognito.NewUserPool(ctx, "example", &cognito.UserPoolArgs{
    			Name: pulumi.String("example"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleUserPoolDomain, err := cognito.NewUserPoolDomain(ctx, "example", &cognito.UserPoolDomainArgs{
    			Domain:     pulumi.String("example"),
    			UserPoolId: example.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		invokeFilebase64, err := std.Filebase64(ctx, &std.Filebase64Args{
    			Input: "logo.png",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = cognito.NewUserPoolUICustomization(ctx, "example", &cognito.UserPoolUICustomizationArgs{
    			Css:        pulumi.String(".label-customizable {font-weight: 400;}"),
    			ImageFile:  invokeFilebase64.Result,
    			UserPoolId: exampleUserPoolDomain.UserPoolId,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    using Std = Pulumi.Std;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Cognito.UserPool("example", new()
        {
            Name = "example",
        });
    
        var exampleUserPoolDomain = new Aws.Cognito.UserPoolDomain("example", new()
        {
            Domain = "example",
            UserPoolId = example.Id,
        });
    
        var exampleUserPoolUICustomization = new Aws.Cognito.UserPoolUICustomization("example", new()
        {
            Css = ".label-customizable {font-weight: 400;}",
            ImageFile = Std.Filebase64.Invoke(new()
            {
                Input = "logo.png",
            }).Apply(invoke => invoke.Result),
            UserPoolId = exampleUserPoolDomain.UserPoolId,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.cognito.UserPool;
    import com.pulumi.aws.cognito.UserPoolArgs;
    import com.pulumi.aws.cognito.UserPoolDomain;
    import com.pulumi.aws.cognito.UserPoolDomainArgs;
    import com.pulumi.aws.cognito.UserPoolUICustomization;
    import com.pulumi.aws.cognito.UserPoolUICustomizationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new UserPool("example", UserPoolArgs.builder()        
                .name("example")
                .build());
    
            var exampleUserPoolDomain = new UserPoolDomain("exampleUserPoolDomain", UserPoolDomainArgs.builder()        
                .domain("example")
                .userPoolId(example.id())
                .build());
    
            var exampleUserPoolUICustomization = new UserPoolUICustomization("exampleUserPoolUICustomization", UserPoolUICustomizationArgs.builder()        
                .css(".label-customizable {font-weight: 400;}")
                .imageFile(StdFunctions.filebase64(Filebase64Args.builder()
                    .input("logo.png")
                    .build()).result())
                .userPoolId(exampleUserPoolDomain.userPoolId())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:cognito:UserPool
        properties:
          name: example
      exampleUserPoolDomain:
        type: aws:cognito:UserPoolDomain
        name: example
        properties:
          domain: example
          userPoolId: ${example.id}
      exampleUserPoolUICustomization:
        type: aws:cognito:UserPoolUICustomization
        name: example
        properties:
          css: '.label-customizable {font-weight: 400;}'
          imageFile:
            fn::invoke:
              Function: std:filebase64
              Arguments:
                input: logo.png
              Return: result
          userPoolId: ${exampleUserPoolDomain.userPoolId}
    

    Create UserPoolUICustomization Resource

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

    Constructor syntax

    new UserPoolUICustomization(name: string, args: UserPoolUICustomizationArgs, opts?: CustomResourceOptions);
    @overload
    def UserPoolUICustomization(resource_name: str,
                                args: UserPoolUICustomizationArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def UserPoolUICustomization(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                user_pool_id: Optional[str] = None,
                                client_id: Optional[str] = None,
                                css: Optional[str] = None,
                                image_file: Optional[str] = None)
    func NewUserPoolUICustomization(ctx *Context, name string, args UserPoolUICustomizationArgs, opts ...ResourceOption) (*UserPoolUICustomization, error)
    public UserPoolUICustomization(string name, UserPoolUICustomizationArgs args, CustomResourceOptions? opts = null)
    public UserPoolUICustomization(String name, UserPoolUICustomizationArgs args)
    public UserPoolUICustomization(String name, UserPoolUICustomizationArgs args, CustomResourceOptions options)
    
    type: aws:cognito:UserPoolUICustomization
    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 UserPoolUICustomizationArgs
    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 UserPoolUICustomizationArgs
    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 UserPoolUICustomizationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserPoolUICustomizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserPoolUICustomizationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var userPoolUICustomizationResource = new Aws.Cognito.UserPoolUICustomization("userPoolUICustomizationResource", new()
    {
        UserPoolId = "string",
        ClientId = "string",
        Css = "string",
        ImageFile = "string",
    });
    
    example, err := cognito.NewUserPoolUICustomization(ctx, "userPoolUICustomizationResource", &cognito.UserPoolUICustomizationArgs{
    	UserPoolId: pulumi.String("string"),
    	ClientId:   pulumi.String("string"),
    	Css:        pulumi.String("string"),
    	ImageFile:  pulumi.String("string"),
    })
    
    var userPoolUICustomizationResource = new UserPoolUICustomization("userPoolUICustomizationResource", UserPoolUICustomizationArgs.builder()        
        .userPoolId("string")
        .clientId("string")
        .css("string")
        .imageFile("string")
        .build());
    
    user_pool_ui_customization_resource = aws.cognito.UserPoolUICustomization("userPoolUICustomizationResource",
        user_pool_id="string",
        client_id="string",
        css="string",
        image_file="string")
    
    const userPoolUICustomizationResource = new aws.cognito.UserPoolUICustomization("userPoolUICustomizationResource", {
        userPoolId: "string",
        clientId: "string",
        css: "string",
        imageFile: "string",
    });
    
    type: aws:cognito:UserPoolUICustomization
    properties:
        clientId: string
        css: string
        imageFile: string
        userPoolId: string
    

    UserPoolUICustomization Resource Properties

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

    Inputs

    The UserPoolUICustomization resource accepts the following input properties:

    UserPoolId string
    The user pool ID for the user pool.
    ClientId string
    The client ID for the client app. Defaults to ALL. If ALL is specified, the css and/or image_file settings will be used for every client that has no UI customization set previously.
    Css string
    The CSS values in the UI customization, provided as a String. At least one of css or image_file is required.
    ImageFile string
    The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of css or image_file is required.
    UserPoolId string
    The user pool ID for the user pool.
    ClientId string
    The client ID for the client app. Defaults to ALL. If ALL is specified, the css and/or image_file settings will be used for every client that has no UI customization set previously.
    Css string
    The CSS values in the UI customization, provided as a String. At least one of css or image_file is required.
    ImageFile string
    The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of css or image_file is required.
    userPoolId String
    The user pool ID for the user pool.
    clientId String
    The client ID for the client app. Defaults to ALL. If ALL is specified, the css and/or image_file settings will be used for every client that has no UI customization set previously.
    css String
    The CSS values in the UI customization, provided as a String. At least one of css or image_file is required.
    imageFile String
    The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of css or image_file is required.
    userPoolId string
    The user pool ID for the user pool.
    clientId string
    The client ID for the client app. Defaults to ALL. If ALL is specified, the css and/or image_file settings will be used for every client that has no UI customization set previously.
    css string
    The CSS values in the UI customization, provided as a String. At least one of css or image_file is required.
    imageFile string
    The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of css or image_file is required.
    user_pool_id str
    The user pool ID for the user pool.
    client_id str
    The client ID for the client app. Defaults to ALL. If ALL is specified, the css and/or image_file settings will be used for every client that has no UI customization set previously.
    css str
    The CSS values in the UI customization, provided as a String. At least one of css or image_file is required.
    image_file str
    The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of css or image_file is required.
    userPoolId String
    The user pool ID for the user pool.
    clientId String
    The client ID for the client app. Defaults to ALL. If ALL is specified, the css and/or image_file settings will be used for every client that has no UI customization set previously.
    css String
    The CSS values in the UI customization, provided as a String. At least one of css or image_file is required.
    imageFile String
    The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of css or image_file is required.

    Outputs

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

    CreationDate string
    The creation date in RFC3339 format for the UI customization.
    CssVersion string
    The CSS version number.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageUrl string
    The logo image URL for the UI customization.
    LastModifiedDate string
    The last-modified date in RFC3339 format for the UI customization.
    CreationDate string
    The creation date in RFC3339 format for the UI customization.
    CssVersion string
    The CSS version number.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageUrl string
    The logo image URL for the UI customization.
    LastModifiedDate string
    The last-modified date in RFC3339 format for the UI customization.
    creationDate String
    The creation date in RFC3339 format for the UI customization.
    cssVersion String
    The CSS version number.
    id String
    The provider-assigned unique ID for this managed resource.
    imageUrl String
    The logo image URL for the UI customization.
    lastModifiedDate String
    The last-modified date in RFC3339 format for the UI customization.
    creationDate string
    The creation date in RFC3339 format for the UI customization.
    cssVersion string
    The CSS version number.
    id string
    The provider-assigned unique ID for this managed resource.
    imageUrl string
    The logo image URL for the UI customization.
    lastModifiedDate string
    The last-modified date in RFC3339 format for the UI customization.
    creation_date str
    The creation date in RFC3339 format for the UI customization.
    css_version str
    The CSS version number.
    id str
    The provider-assigned unique ID for this managed resource.
    image_url str
    The logo image URL for the UI customization.
    last_modified_date str
    The last-modified date in RFC3339 format for the UI customization.
    creationDate String
    The creation date in RFC3339 format for the UI customization.
    cssVersion String
    The CSS version number.
    id String
    The provider-assigned unique ID for this managed resource.
    imageUrl String
    The logo image URL for the UI customization.
    lastModifiedDate String
    The last-modified date in RFC3339 format for the UI customization.

    Look up Existing UserPoolUICustomization Resource

    Get an existing UserPoolUICustomization resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserPoolUICustomizationState, opts?: CustomResourceOptions): UserPoolUICustomization
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            client_id: Optional[str] = None,
            creation_date: Optional[str] = None,
            css: Optional[str] = None,
            css_version: Optional[str] = None,
            image_file: Optional[str] = None,
            image_url: Optional[str] = None,
            last_modified_date: Optional[str] = None,
            user_pool_id: Optional[str] = None) -> UserPoolUICustomization
    func GetUserPoolUICustomization(ctx *Context, name string, id IDInput, state *UserPoolUICustomizationState, opts ...ResourceOption) (*UserPoolUICustomization, error)
    public static UserPoolUICustomization Get(string name, Input<string> id, UserPoolUICustomizationState? state, CustomResourceOptions? opts = null)
    public static UserPoolUICustomization get(String name, Output<String> id, UserPoolUICustomizationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ClientId string
    The client ID for the client app. Defaults to ALL. If ALL is specified, the css and/or image_file settings will be used for every client that has no UI customization set previously.
    CreationDate string
    The creation date in RFC3339 format for the UI customization.
    Css string
    The CSS values in the UI customization, provided as a String. At least one of css or image_file is required.
    CssVersion string
    The CSS version number.
    ImageFile string
    The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of css or image_file is required.
    ImageUrl string
    The logo image URL for the UI customization.
    LastModifiedDate string
    The last-modified date in RFC3339 format for the UI customization.
    UserPoolId string
    The user pool ID for the user pool.
    ClientId string
    The client ID for the client app. Defaults to ALL. If ALL is specified, the css and/or image_file settings will be used for every client that has no UI customization set previously.
    CreationDate string
    The creation date in RFC3339 format for the UI customization.
    Css string
    The CSS values in the UI customization, provided as a String. At least one of css or image_file is required.
    CssVersion string
    The CSS version number.
    ImageFile string
    The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of css or image_file is required.
    ImageUrl string
    The logo image URL for the UI customization.
    LastModifiedDate string
    The last-modified date in RFC3339 format for the UI customization.
    UserPoolId string
    The user pool ID for the user pool.
    clientId String
    The client ID for the client app. Defaults to ALL. If ALL is specified, the css and/or image_file settings will be used for every client that has no UI customization set previously.
    creationDate String
    The creation date in RFC3339 format for the UI customization.
    css String
    The CSS values in the UI customization, provided as a String. At least one of css or image_file is required.
    cssVersion String
    The CSS version number.
    imageFile String
    The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of css or image_file is required.
    imageUrl String
    The logo image URL for the UI customization.
    lastModifiedDate String
    The last-modified date in RFC3339 format for the UI customization.
    userPoolId String
    The user pool ID for the user pool.
    clientId string
    The client ID for the client app. Defaults to ALL. If ALL is specified, the css and/or image_file settings will be used for every client that has no UI customization set previously.
    creationDate string
    The creation date in RFC3339 format for the UI customization.
    css string
    The CSS values in the UI customization, provided as a String. At least one of css or image_file is required.
    cssVersion string
    The CSS version number.
    imageFile string
    The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of css or image_file is required.
    imageUrl string
    The logo image URL for the UI customization.
    lastModifiedDate string
    The last-modified date in RFC3339 format for the UI customization.
    userPoolId string
    The user pool ID for the user pool.
    client_id str
    The client ID for the client app. Defaults to ALL. If ALL is specified, the css and/or image_file settings will be used for every client that has no UI customization set previously.
    creation_date str
    The creation date in RFC3339 format for the UI customization.
    css str
    The CSS values in the UI customization, provided as a String. At least one of css or image_file is required.
    css_version str
    The CSS version number.
    image_file str
    The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of css or image_file is required.
    image_url str
    The logo image URL for the UI customization.
    last_modified_date str
    The last-modified date in RFC3339 format for the UI customization.
    user_pool_id str
    The user pool ID for the user pool.
    clientId String
    The client ID for the client app. Defaults to ALL. If ALL is specified, the css and/or image_file settings will be used for every client that has no UI customization set previously.
    creationDate String
    The creation date in RFC3339 format for the UI customization.
    css String
    The CSS values in the UI customization, provided as a String. At least one of css or image_file is required.
    cssVersion String
    The CSS version number.
    imageFile String
    The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of css or image_file is required.
    imageUrl String
    The logo image URL for the UI customization.
    lastModifiedDate String
    The last-modified date in RFC3339 format for the UI customization.
    userPoolId String
    The user pool ID for the user pool.

    Import

    Using pulumi import, import Cognito User Pool UI Customizations using the user_pool_id and client_id separated by ,. For example:

    $ pulumi import aws:cognito/userPoolUICustomization:UserPoolUICustomization example us-west-2_ZCTarbt5C,12bu4fuk3mlgqa2rtrujgp6egq
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.31.0 published on Monday, Apr 15, 2024 by Pulumi