@pulumi/vault/config/uiCustomMessage.d.ts

A Pulumi package for creating and managing HashiCorp Vault cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
export declare class UiCustomMessage extends pulumi.CustomResource {
    /**
     * Get an existing UiCustomMessage resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UiCustomMessageState, opts?: pulumi.CustomResourceOptions): UiCustomMessage;
    /**
     * Returns true if the given object is an instance of UiCustomMessage.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is UiCustomMessage;
    /**
     * A flag indicating whether the custom message is displayed pre-login (false) or post-login (true)
     */
    readonly authenticated: pulumi.Output<boolean | undefined>;
    /**
     * The ending time of the active period of the custom message. Can be omitted for non-expiring message
     */
    readonly endTime: pulumi.Output<string | undefined>;
    /**
     * A block containing a hyperlink associated with the custom message
     */
    readonly link: pulumi.Output<outputs.config.UiCustomMessageLink | undefined>;
    /**
     * The base64-encoded content of the custom message
     */
    readonly messageBase64: pulumi.Output<string>;
    /**
     * Target namespace. (requires Enterprise)
     */
    readonly namespace: pulumi.Output<string | undefined>;
    /**
     * A map containing additional options for the custom message
     */
    readonly options: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * The starting time of the active period of the custom message
     */
    readonly startTime: pulumi.Output<string>;
    /**
     * The title of the custom message
     */
    readonly title: pulumi.Output<string>;
    /**
     * The display type of custom message. Allowed values are banner and modal
     */
    readonly type: pulumi.Output<string | undefined>;
    /**
     * Create a UiCustomMessage resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: UiCustomMessageArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering UiCustomMessage resources.
 */
export interface UiCustomMessageState {
    /**
     * A flag indicating whether the custom message is displayed pre-login (false) or post-login (true)
     */
    authenticated?: pulumi.Input<boolean>;
    /**
     * The ending time of the active period of the custom message. Can be omitted for non-expiring message
     */
    endTime?: pulumi.Input<string>;
    /**
     * A block containing a hyperlink associated with the custom message
     */
    link?: pulumi.Input<inputs.config.UiCustomMessageLink>;
    /**
     * The base64-encoded content of the custom message
     */
    messageBase64?: pulumi.Input<string>;
    /**
     * Target namespace. (requires Enterprise)
     */
    namespace?: pulumi.Input<string>;
    /**
     * A map containing additional options for the custom message
     */
    options?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The starting time of the active period of the custom message
     */
    startTime?: pulumi.Input<string>;
    /**
     * The title of the custom message
     */
    title?: pulumi.Input<string>;
    /**
     * The display type of custom message. Allowed values are banner and modal
     */
    type?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a UiCustomMessage resource.
 */
export interface UiCustomMessageArgs {
    /**
     * A flag indicating whether the custom message is displayed pre-login (false) or post-login (true)
     */
    authenticated?: pulumi.Input<boolean>;
    /**
     * The ending time of the active period of the custom message. Can be omitted for non-expiring message
     */
    endTime?: pulumi.Input<string>;
    /**
     * A block containing a hyperlink associated with the custom message
     */
    link?: pulumi.Input<inputs.config.UiCustomMessageLink>;
    /**
     * The base64-encoded content of the custom message
     */
    messageBase64: pulumi.Input<string>;
    /**
     * Target namespace. (requires Enterprise)
     */
    namespace?: pulumi.Input<string>;
    /**
     * A map containing additional options for the custom message
     */
    options?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The starting time of the active period of the custom message
     */
    startTime: pulumi.Input<string>;
    /**
     * The title of the custom message
     */
    title: pulumi.Input<string>;
    /**
     * The display type of custom message. Allowed values are banner and modal
     */
    type?: pulumi.Input<string>;
}