Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. HashiCorp Vault Provider
  3. API Docs
  4. config
  5. UiCustomMessage
HashiCorp Vault v6.7.1 published on Friday, May 2, 2025 by Pulumi
pulumi/pulumi-vault

vault.config.UiCustomMessage

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.7.1 published on Friday, May 2, 2025 by Pulumi
pulumi/pulumi-vault

    Create UiCustomMessage Resource

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

    Constructor syntax

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

@overload
def UiCustomMessage(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    message_base64: Optional[str] = None,
                    start_time: Optional[str] = None,
                    title: Optional[str] = None,
                    authenticated: Optional[bool] = None,
                    end_time: Optional[str] = None,
                    link: Optional[UiCustomMessageLinkArgs] = None,
                    namespace: Optional[str] = None,
                    options: Optional[Mapping[str, str]] = None,
                    type: Optional[str] = None)
    func NewUiCustomMessage(ctx *Context, name string, args UiCustomMessageArgs, opts ...ResourceOption) (*UiCustomMessage, error)
    public UiCustomMessage(string name, UiCustomMessageArgs args, CustomResourceOptions? opts = null)
    public UiCustomMessage(String name, UiCustomMessageArgs args)
public UiCustomMessage(String name, UiCustomMessageArgs args, CustomResourceOptions options)

    type: vault:config:UiCustomMessage
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 UiCustomMessageArgs
    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 UiCustomMessageArgs
    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 UiCustomMessageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UiCustomMessageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UiCustomMessageArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var uiCustomMessageResource = new Vault.Config.UiCustomMessage("uiCustomMessageResource", new()
{
    MessageBase64 = "string",
    StartTime = "string",
    Title = "string",
    Authenticated = false,
    EndTime = "string",
    Link = new Vault.Config.Inputs.UiCustomMessageLinkArgs
    {
        Href = "string",
        Title = "string",
    },
    Namespace = "string",
    Options = 
    {
        { "string", "string" },
    },
    Type = "string",
});

    example, err := config.NewUiCustomMessage(ctx, "uiCustomMessageResource", &config.UiCustomMessageArgs{
	MessageBase64: pulumi.String("string"),
	StartTime:     pulumi.String("string"),
	Title:         pulumi.String("string"),
	Authenticated: pulumi.Bool(false),
	EndTime:       pulumi.String("string"),
	Link: &config.UiCustomMessageLinkArgs{
		Href:  pulumi.String("string"),
		Title: pulumi.String("string"),
	},
	Namespace: pulumi.String("string"),
	Options: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Type: pulumi.String("string"),
})

    var uiCustomMessageResource = new UiCustomMessage("uiCustomMessageResource", UiCustomMessageArgs.builder()
    .messageBase64("string")
    .startTime("string")
    .title("string")
    .authenticated(false)
    .endTime("string")
    .link(UiCustomMessageLinkArgs.builder()
        .href("string")
        .title("string")
        .build())
    .namespace("string")
    .options(Map.of("string", "string"))
    .type("string")
    .build());

    ui_custom_message_resource = vault.config.UiCustomMessage("uiCustomMessageResource",
    message_base64="string",
    start_time="string",
    title="string",
    authenticated=False,
    end_time="string",
    link={
        "href": "string",
        "title": "string",
    },
    namespace="string",
    options={
        "string": "string",
    },
    type="string")

    const uiCustomMessageResource = new vault.config.UiCustomMessage("uiCustomMessageResource", {
    messageBase64: "string",
    startTime: "string",
    title: "string",
    authenticated: false,
    endTime: "string",
    link: {
        href: "string",
        title: "string",
    },
    namespace: "string",
    options: {
        string: "string",
    },
    type: "string",
});

    type: vault:config:UiCustomMessage
properties:
    authenticated: false
    endTime: string
    link:
        href: string
        title: string
    messageBase64: string
    namespace: string
    options:
        string: string
    startTime: string
    title: string
    type: string

    UiCustomMessage 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 UiCustomMessage resource accepts the following input properties:

    MessageBase64 string
    The base64-encoded content of the custom message
    StartTime string
    The starting time of the active period of the custom message
    Title string
    The title of the custom message
    Authenticated bool
    A flag indicating whether the custom message is displayed pre-login (false) or post-login (true)
    EndTime string
    The ending time of the active period of the custom message. Can be omitted for non-expiring message
    Link UiCustomMessageLink
    A block containing a hyperlink associated with the custom message
    Namespace string
    Target namespace. (requires Enterprise)
    Options Dictionary<string, string>
    A map containing additional options for the custom message
    Type string
    The display type of custom message. Allowed values are banner and modal
    MessageBase64 string
    The base64-encoded content of the custom message
    StartTime string
    The starting time of the active period of the custom message
    Title string
    The title of the custom message
    Authenticated bool
    A flag indicating whether the custom message is displayed pre-login (false) or post-login (true)
    EndTime string
    The ending time of the active period of the custom message. Can be omitted for non-expiring message
    Link UiCustomMessageLinkArgs
    A block containing a hyperlink associated with the custom message
    Namespace string
    Target namespace. (requires Enterprise)
    Options map[string]string
    A map containing additional options for the custom message
    Type string
    The display type of custom message. Allowed values are banner and modal
    messageBase64 String
    The base64-encoded content of the custom message
    startTime String
    The starting time of the active period of the custom message
    title String
    The title of the custom message
    authenticated Boolean
    A flag indicating whether the custom message is displayed pre-login (false) or post-login (true)
    endTime String
    The ending time of the active period of the custom message. Can be omitted for non-expiring message
    link UiCustomMessageLink
    A block containing a hyperlink associated with the custom message
    namespace String
    Target namespace. (requires Enterprise)
    options Map<String,String>
    A map containing additional options for the custom message
    type String
    The display type of custom message. Allowed values are banner and modal
    messageBase64 string
    The base64-encoded content of the custom message
    startTime string
    The starting time of the active period of the custom message
    title string
    The title of the custom message
    authenticated boolean
    A flag indicating whether the custom message is displayed pre-login (false) or post-login (true)
    endTime string
    The ending time of the active period of the custom message. Can be omitted for non-expiring message
    link UiCustomMessageLink
    A block containing a hyperlink associated with the custom message
    namespace string
    Target namespace. (requires Enterprise)
    options {[key: string]: string}
    A map containing additional options for the custom message
    type string
    The display type of custom message. Allowed values are banner and modal
    message_base64 str
    The base64-encoded content of the custom message
    start_time str
    The starting time of the active period of the custom message
    title str
    The title of the custom message
    authenticated bool
    A flag indicating whether the custom message is displayed pre-login (false) or post-login (true)
    end_time str
    The ending time of the active period of the custom message. Can be omitted for non-expiring message
    link UiCustomMessageLinkArgs
    A block containing a hyperlink associated with the custom message
    namespace str
    Target namespace. (requires Enterprise)
    options Mapping[str, str]
    A map containing additional options for the custom message
    type str
    The display type of custom message. Allowed values are banner and modal
    messageBase64 String
    The base64-encoded content of the custom message
    startTime String
    The starting time of the active period of the custom message
    title String
    The title of the custom message
    authenticated Boolean
    A flag indicating whether the custom message is displayed pre-login (false) or post-login (true)
    endTime String
    The ending time of the active period of the custom message. Can be omitted for non-expiring message
    link Property Map
    A block containing a hyperlink associated with the custom message
    namespace String
    Target namespace. (requires Enterprise)
    options Map<String>
    A map containing additional options for the custom message
    type String
    The display type of custom message. Allowed values are banner and modal

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing UiCustomMessage Resource

    Get an existing UiCustomMessage 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?: UiCustomMessageState, opts?: CustomResourceOptions): UiCustomMessage
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authenticated: Optional[bool] = None,
        end_time: Optional[str] = None,
        link: Optional[UiCustomMessageLinkArgs] = None,
        message_base64: Optional[str] = None,
        namespace: Optional[str] = None,
        options: Optional[Mapping[str, str]] = None,
        start_time: Optional[str] = None,
        title: Optional[str] = None,
        type: Optional[str] = None) -> UiCustomMessage
    func GetUiCustomMessage(ctx *Context, name string, id IDInput, state *UiCustomMessageState, opts ...ResourceOption) (*UiCustomMessage, error)
    public static UiCustomMessage Get(string name, Input<string> id, UiCustomMessageState? state, CustomResourceOptions? opts = null)
    public static UiCustomMessage get(String name, Output<String> id, UiCustomMessageState state, CustomResourceOptions options)
    resources:  _:    type: vault:config:UiCustomMessage    get:      id: ${id}
    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:
    Authenticated bool
    A flag indicating whether the custom message is displayed pre-login (false) or post-login (true)
    EndTime string
    The ending time of the active period of the custom message. Can be omitted for non-expiring message
    Link UiCustomMessageLink
    A block containing a hyperlink associated with the custom message
    MessageBase64 string
    The base64-encoded content of the custom message
    Namespace string
    Target namespace. (requires Enterprise)
    Options Dictionary<string, string>
    A map containing additional options for the custom message
    StartTime string
    The starting time of the active period of the custom message
    Title string
    The title of the custom message
    Type string
    The display type of custom message. Allowed values are banner and modal
    Authenticated bool
    A flag indicating whether the custom message is displayed pre-login (false) or post-login (true)
    EndTime string
    The ending time of the active period of the custom message. Can be omitted for non-expiring message
    Link UiCustomMessageLinkArgs
    A block containing a hyperlink associated with the custom message
    MessageBase64 string
    The base64-encoded content of the custom message
    Namespace string
    Target namespace. (requires Enterprise)
    Options map[string]string
    A map containing additional options for the custom message
    StartTime string
    The starting time of the active period of the custom message
    Title string
    The title of the custom message
    Type string
    The display type of custom message. Allowed values are banner and modal
    authenticated Boolean
    A flag indicating whether the custom message is displayed pre-login (false) or post-login (true)
    endTime String
    The ending time of the active period of the custom message. Can be omitted for non-expiring message
    link UiCustomMessageLink
    A block containing a hyperlink associated with the custom message
    messageBase64 String
    The base64-encoded content of the custom message
    namespace String
    Target namespace. (requires Enterprise)
    options Map<String,String>
    A map containing additional options for the custom message
    startTime String
    The starting time of the active period of the custom message
    title String
    The title of the custom message
    type String
    The display type of custom message. Allowed values are banner and modal
    authenticated boolean
    A flag indicating whether the custom message is displayed pre-login (false) or post-login (true)
    endTime string
    The ending time of the active period of the custom message. Can be omitted for non-expiring message
    link UiCustomMessageLink
    A block containing a hyperlink associated with the custom message
    messageBase64 string
    The base64-encoded content of the custom message
    namespace string
    Target namespace. (requires Enterprise)
    options {[key: string]: string}
    A map containing additional options for the custom message
    startTime string
    The starting time of the active period of the custom message
    title string
    The title of the custom message
    type string
    The display type of custom message. Allowed values are banner and modal
    authenticated bool
    A flag indicating whether the custom message is displayed pre-login (false) or post-login (true)
    end_time str
    The ending time of the active period of the custom message. Can be omitted for non-expiring message
    link UiCustomMessageLinkArgs
    A block containing a hyperlink associated with the custom message
    message_base64 str
    The base64-encoded content of the custom message
    namespace str
    Target namespace. (requires Enterprise)
    options Mapping[str, str]
    A map containing additional options for the custom message
    start_time str
    The starting time of the active period of the custom message
    title str
    The title of the custom message
    type str
    The display type of custom message. Allowed values are banner and modal
    authenticated Boolean
    A flag indicating whether the custom message is displayed pre-login (false) or post-login (true)
    endTime String
    The ending time of the active period of the custom message. Can be omitted for non-expiring message
    link Property Map
    A block containing a hyperlink associated with the custom message
    messageBase64 String
    The base64-encoded content of the custom message
    namespace String
    Target namespace. (requires Enterprise)
    options Map<String>
    A map containing additional options for the custom message
    startTime String
    The starting time of the active period of the custom message
    title String
    The title of the custom message
    type String
    The display type of custom message. Allowed values are banner and modal

    Supporting Types

    Href string
    The URL of the hyperlink
    Title string
    The title of the hyperlink
    Href string
    The URL of the hyperlink
    Title string
    The title of the hyperlink
    href String
    The URL of the hyperlink
    title String
    The title of the hyperlink
    href string
    The URL of the hyperlink
    title string
    The title of the hyperlink
    href str
    The URL of the hyperlink
    title str
    The title of the hyperlink
    href String
    The URL of the hyperlink
    title String
    The title of the hyperlink

    Package Details

    Repository
    Vault pulumi/pulumi-vault
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vault Terraform Provider.
    vault logo
    HashiCorp Vault v6.7.1 published on Friday, May 2, 2025 by Pulumi
    pulumi/pulumi-vault