Package com.pulumi.aws.cognito

Class ManagedLoginBranding

  • public class ManagedLoginBranding
extends com.pulumi.resources.CustomResource
    Manages branding settings for a user pool style and associates it with an app client. ## Example Usage ### Default Branding Style 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cognito.ManagedLoginBranding;
 import com.pulumi.aws.cognito.ManagedLoginBrandingArgs;
 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 client = new ManagedLoginBranding("client", ManagedLoginBrandingArgs.builder()
             .clientId(example.id())
             .userPoolId(exampleAwsCognitoUserPool.id())
             .useCognitoProvidedValues(true)
             .build());
 
     }
 }
    ### Custom Branding Style 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cognito.ManagedLoginBranding;
 import com.pulumi.aws.cognito.ManagedLoginBrandingArgs;
 import com.pulumi.aws.cognito.inputs.ManagedLoginBrandingAssetArgs;
 import com.pulumi.std.StdFunctions;
 import com.pulumi.std.inputs.Filebase64Args;
 import static com.pulumi.codegen.internal.Serialization.*;
 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 client = new ManagedLoginBranding("client", ManagedLoginBrandingArgs.builder()
             .assets(ManagedLoginBrandingAssetArgs.builder()
                 .bytes(StdFunctions.filebase64(Filebase64Args.builder()
                     .input("login_branding_asset.svg")
                     .build()).result())
                 .category("PAGE_HEADER_BACKGROUND")
                 .colorMode("DARK")
                 .extension("SVG")
                 .build())
             .clientId(example.id())
             .userPoolId(exampleAwsCognitoUserPool.id())
             .settings(serializeJson(
                 jsonObject(
 
                 )))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Cognito branding settings using `userPoolId` and `managedLoginBrandingId` separated by `,`. For example: ```sh $ pulumi import aws:cognito/managedLoginBranding:ManagedLoginBranding example us-west-2_rSss9Zltr,06c6ae7b-1e66-46d2-87a9-1203ea3307bd ```

    • 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.util.List<ManagedLoginBrandingAsset>>> assets()  
      com.pulumi.core.Output<java.lang.String> clientId()  
      static ManagedLoginBranding get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ManagedLoginBrandingState 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.lang.String> managedLoginBrandingId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> settings()  
      com.pulumi.core.Output<java.lang.String> settingsAll()  
      com.pulumi.core.Output<java.lang.Boolean> useCognitoProvidedValues()  
      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

      • ManagedLoginBranding

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

      • ManagedLoginBranding

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

      • ManagedLoginBranding

        public ManagedLoginBranding​(java.lang.String name,
                            ManagedLoginBrandingArgs 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

      • assets

        public com.pulumi.core.Output<java.util.Optional<java.util.List<ManagedLoginBrandingAsset>>> assets()
        Returns:
        Image files to apply to roles like backgrounds, logos, and icons. See details below.

      • clientId

        public com.pulumi.core.Output<java.lang.String> clientId()
        Returns:
        App client that the branding style is for.

      • managedLoginBrandingId

        public com.pulumi.core.Output<java.lang.String> managedLoginBrandingId()
        Returns:
        ID of the managed login branding style.

      • 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.

      • settings

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> settings()
        Returns:
        JSON document with the the settings to apply to the style.

      • settingsAll

        public com.pulumi.core.Output<java.lang.String> settingsAll()
        Returns:
        Settings including Amazon Cognito defaults.

      • useCognitoProvidedValues

        public com.pulumi.core.Output<java.lang.Boolean> useCognitoProvidedValues()
        Returns:
        When `true`, applies the default branding style options.

      • userPoolId

        public com.pulumi.core.Output<java.lang.String> userPoolId()
        Returns:
        User pool the client belongs to. The following arguments are optional:

      • get

        public static ManagedLoginBranding get​(java.lang.String name,
                                       com.pulumi.core.Output<java.lang.String> id,
                                       @Nullable
                                       ManagedLoginBrandingState 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.