Package com.pulumi.aws.cognito

Class UserPoolUICustomization

  • public class UserPoolUICustomization
extends com.pulumi.resources.CustomResource
    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](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-ui-customization.html). ## Example Usage ### UI customization settings for a single client 
     
 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 com.pulumi.std.StdFunctions;
 import com.pulumi.std.inputs.Filebase64Args;
 import java.util.ArrayList;
 import java.util.Arrays;
 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());
 
     }
 }
    ### UI customization settings for all clients 
     
 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 com.pulumi.std.StdFunctions;
 import com.pulumi.std.inputs.Filebase64Args;
 import java.util.ArrayList;
 import java.util.Arrays;
 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());
 
     }
 }
    ## Import Using `pulumi import`, import Cognito User Pool UI Customizations using the `userPoolId` and `clientId` separated by `,`. For example: ```sh $ pulumi import aws:cognito/userPoolUICustomization:UserPoolUICustomization example us-west-2_ZCTarbt5C,12bu4fuk3mlgqa2rtrujgp6egq ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> clientId()  
      com.pulumi.core.Output<java.lang.String> creationDate()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> css()  
      com.pulumi.core.Output<java.lang.String> cssVersion()  
      static UserPoolUICustomization get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, UserPoolUICustomizationState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> imageFile()  
      com.pulumi.core.Output<java.lang.String> imageUrl()  
      com.pulumi.core.Output<java.lang.String> lastModifiedDate()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> userPoolId()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • UserPoolUICustomization

        public UserPoolUICustomization​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • UserPoolUICustomization

        public UserPoolUICustomization​(java.lang.String name,
                               UserPoolUICustomizationArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • UserPoolUICustomization

        public UserPoolUICustomization​(java.lang.String name,
                               UserPoolUICustomizationArgs args,
                               @Nullable
                               com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • clientId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> clientId()
        Returns:
        The client ID for the client app. Defaults to `ALL`. If `ALL` is specified, the `css` and/or `imageFile` settings will be used for every client that has no UI customization set previously.

      • creationDate

        public com.pulumi.core.Output<java.lang.String> creationDate()
        Returns:
        The creation date in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) for the UI customization.

      • css

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> css()
        Returns:
        The CSS values in the UI customization, provided as a String. At least one of `css` or `imageFile` is required.

      • cssVersion

        public com.pulumi.core.Output<java.lang.String> cssVersion()
        Returns:
        The CSS version number.

      • imageFile

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> imageFile()
        Returns:
        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 `imageFile` is required.

      • imageUrl

        public com.pulumi.core.Output<java.lang.String> imageUrl()
        Returns:
        The logo image URL for the UI customization.

      • lastModifiedDate

        public com.pulumi.core.Output<java.lang.String> lastModifiedDate()
        Returns:
        The last-modified date in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) for the UI customization.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • userPoolId

        public com.pulumi.core.Output<java.lang.String> userPoolId()
        Returns:
        The user pool ID for the user pool.

      • get

        public static UserPoolUICustomization get​(java.lang.String name,
                                          com.pulumi.core.Output<java.lang.String> id,
                                          @Nullable
                                          UserPoolUICustomizationState state,
                                          @Nullable
                                          com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.