Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. ApplicationAppearance
GitLab v9.2.0 published on Friday, Jul 18, 2025 by Pulumi
pulumi/pulumi-gitlab

gitlab.ApplicationAppearance

Explore with Pulumi AI

gitlab logo
GitLab v9.2.0 published on Friday, Jul 18, 2025 by Pulumi
pulumi/pulumi-gitlab

    Example Usage

    Create ApplicationAppearance Resource

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

    Constructor syntax

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

@overload
def ApplicationAppearance(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          description: Optional[str] = None,
                          email_header_and_footer_enabled: Optional[bool] = None,
                          footer_message: Optional[str] = None,
                          header_message: Optional[str] = None,
                          keep_settings_on_destroy: Optional[bool] = None,
                          member_guidelines: Optional[str] = None,
                          message_background_color: Optional[str] = None,
                          message_font_color: Optional[str] = None,
                          new_project_guidelines: Optional[str] = None,
                          profile_image_guidelines: Optional[str] = None,
                          pwa_description: Optional[str] = None,
                          pwa_name: Optional[str] = None,
                          pwa_short_name: Optional[str] = None,
                          title: Optional[str] = None)
    func NewApplicationAppearance(ctx *Context, name string, args *ApplicationAppearanceArgs, opts ...ResourceOption) (*ApplicationAppearance, error)
    public ApplicationAppearance(string name, ApplicationAppearanceArgs? args = null, CustomResourceOptions? opts = null)
    public ApplicationAppearance(String name, ApplicationAppearanceArgs args)
public ApplicationAppearance(String name, ApplicationAppearanceArgs args, CustomResourceOptions options)

    type: gitlab:ApplicationAppearance
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 ApplicationAppearanceArgs
    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 ApplicationAppearanceArgs
    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 ApplicationAppearanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplicationAppearanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplicationAppearanceArgs
    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 applicationAppearanceResource = new GitLab.ApplicationAppearance("applicationAppearanceResource", new()
{
    Description = "string",
    EmailHeaderAndFooterEnabled = false,
    FooterMessage = "string",
    HeaderMessage = "string",
    KeepSettingsOnDestroy = false,
    MemberGuidelines = "string",
    MessageBackgroundColor = "string",
    MessageFontColor = "string",
    NewProjectGuidelines = "string",
    ProfileImageGuidelines = "string",
    PwaDescription = "string",
    PwaName = "string",
    PwaShortName = "string",
    Title = "string",
});

    example, err := gitlab.NewApplicationAppearance(ctx, "applicationAppearanceResource", &gitlab.ApplicationAppearanceArgs{
	Description:                 pulumi.String("string"),
	EmailHeaderAndFooterEnabled: pulumi.Bool(false),
	FooterMessage:               pulumi.String("string"),
	HeaderMessage:               pulumi.String("string"),
	KeepSettingsOnDestroy:       pulumi.Bool(false),
	MemberGuidelines:            pulumi.String("string"),
	MessageBackgroundColor:      pulumi.String("string"),
	MessageFontColor:            pulumi.String("string"),
	NewProjectGuidelines:        pulumi.String("string"),
	ProfileImageGuidelines:      pulumi.String("string"),
	PwaDescription:              pulumi.String("string"),
	PwaName:                     pulumi.String("string"),
	PwaShortName:                pulumi.String("string"),
	Title:                       pulumi.String("string"),
})

    var applicationAppearanceResource = new ApplicationAppearance("applicationAppearanceResource", ApplicationAppearanceArgs.builder()
    .description("string")
    .emailHeaderAndFooterEnabled(false)
    .footerMessage("string")
    .headerMessage("string")
    .keepSettingsOnDestroy(false)
    .memberGuidelines("string")
    .messageBackgroundColor("string")
    .messageFontColor("string")
    .newProjectGuidelines("string")
    .profileImageGuidelines("string")
    .pwaDescription("string")
    .pwaName("string")
    .pwaShortName("string")
    .title("string")
    .build());

    application_appearance_resource = gitlab.ApplicationAppearance("applicationAppearanceResource",
    description="string",
    email_header_and_footer_enabled=False,
    footer_message="string",
    header_message="string",
    keep_settings_on_destroy=False,
    member_guidelines="string",
    message_background_color="string",
    message_font_color="string",
    new_project_guidelines="string",
    profile_image_guidelines="string",
    pwa_description="string",
    pwa_name="string",
    pwa_short_name="string",
    title="string")

    const applicationAppearanceResource = new gitlab.ApplicationAppearance("applicationAppearanceResource", {
    description: "string",
    emailHeaderAndFooterEnabled: false,
    footerMessage: "string",
    headerMessage: "string",
    keepSettingsOnDestroy: false,
    memberGuidelines: "string",
    messageBackgroundColor: "string",
    messageFontColor: "string",
    newProjectGuidelines: "string",
    profileImageGuidelines: "string",
    pwaDescription: "string",
    pwaName: "string",
    pwaShortName: "string",
    title: "string",
});

    type: gitlab:ApplicationAppearance
properties:
    description: string
    emailHeaderAndFooterEnabled: false
    footerMessage: string
    headerMessage: string
    keepSettingsOnDestroy: false
    memberGuidelines: string
    messageBackgroundColor: string
    messageFontColor: string
    newProjectGuidelines: string
    profileImageGuidelines: string
    pwaDescription: string
    pwaName: string
    pwaShortName: string
    title: string

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

    Description string
    Markdown text shown on the sign-in and sign-up page.
    EmailHeaderAndFooterEnabled bool
    Add header and footer to all outgoing emails if enabled.
    FooterMessage string
    Message in the system footer bar.
    HeaderMessage string
    Message in the system header bar.
    KeepSettingsOnDestroy bool
    MemberGuidelines string
    Markdown text shown on the group or project member page for users with permission to change members.
    MessageBackgroundColor string
    Background color for the system header or footer bar, in CSS hex notation.
    MessageFontColor string
    Font color for the system header or footer bar, in CSS hex notation.
    NewProjectGuidelines string
    Markdown text shown on the new project page.
    ProfileImageGuidelines string
    Markdown text shown on the profile page below the Public Avatar.
    PwaDescription string
    An explanation of what the Progressive Web App does. Used for the attribute description in manifest.json.
    PwaName string
    Full name of the Progressive Web App. Used for the attribute name in manifest.json.
    PwaShortName string
    Short name for Progressive Web App.
    Title string
    Application title on the sign-in and sign-up page.
    Description string
    Markdown text shown on the sign-in and sign-up page.
    EmailHeaderAndFooterEnabled bool
    Add header and footer to all outgoing emails if enabled.
    FooterMessage string
    Message in the system footer bar.
    HeaderMessage string
    Message in the system header bar.
    KeepSettingsOnDestroy bool
    MemberGuidelines string
    Markdown text shown on the group or project member page for users with permission to change members.
    MessageBackgroundColor string
    Background color for the system header or footer bar, in CSS hex notation.
    MessageFontColor string
    Font color for the system header or footer bar, in CSS hex notation.
    NewProjectGuidelines string
    Markdown text shown on the new project page.
    ProfileImageGuidelines string
    Markdown text shown on the profile page below the Public Avatar.
    PwaDescription string
    An explanation of what the Progressive Web App does. Used for the attribute description in manifest.json.
    PwaName string
    Full name of the Progressive Web App. Used for the attribute name in manifest.json.
    PwaShortName string
    Short name for Progressive Web App.
    Title string
    Application title on the sign-in and sign-up page.
    description String
    Markdown text shown on the sign-in and sign-up page.
    emailHeaderAndFooterEnabled Boolean
    Add header and footer to all outgoing emails if enabled.
    footerMessage String
    Message in the system footer bar.
    headerMessage String
    Message in the system header bar.
    keepSettingsOnDestroy Boolean
    memberGuidelines String
    Markdown text shown on the group or project member page for users with permission to change members.
    messageBackgroundColor String
    Background color for the system header or footer bar, in CSS hex notation.
    messageFontColor String
    Font color for the system header or footer bar, in CSS hex notation.
    newProjectGuidelines String
    Markdown text shown on the new project page.
    profileImageGuidelines String
    Markdown text shown on the profile page below the Public Avatar.
    pwaDescription String
    An explanation of what the Progressive Web App does. Used for the attribute description in manifest.json.
    pwaName String
    Full name of the Progressive Web App. Used for the attribute name in manifest.json.
    pwaShortName String
    Short name for Progressive Web App.
    title String
    Application title on the sign-in and sign-up page.
    description string
    Markdown text shown on the sign-in and sign-up page.
    emailHeaderAndFooterEnabled boolean
    Add header and footer to all outgoing emails if enabled.
    footerMessage string
    Message in the system footer bar.
    headerMessage string
    Message in the system header bar.
    keepSettingsOnDestroy boolean
    memberGuidelines string
    Markdown text shown on the group or project member page for users with permission to change members.
    messageBackgroundColor string
    Background color for the system header or footer bar, in CSS hex notation.
    messageFontColor string
    Font color for the system header or footer bar, in CSS hex notation.
    newProjectGuidelines string
    Markdown text shown on the new project page.
    profileImageGuidelines string
    Markdown text shown on the profile page below the Public Avatar.
    pwaDescription string
    An explanation of what the Progressive Web App does. Used for the attribute description in manifest.json.
    pwaName string
    Full name of the Progressive Web App. Used for the attribute name in manifest.json.
    pwaShortName string
    Short name for Progressive Web App.
    title string
    Application title on the sign-in and sign-up page.
    description str
    Markdown text shown on the sign-in and sign-up page.
    email_header_and_footer_enabled bool
    Add header and footer to all outgoing emails if enabled.
    footer_message str
    Message in the system footer bar.
    header_message str
    Message in the system header bar.
    keep_settings_on_destroy bool
    member_guidelines str
    Markdown text shown on the group or project member page for users with permission to change members.
    message_background_color str
    Background color for the system header or footer bar, in CSS hex notation.
    message_font_color str
    Font color for the system header or footer bar, in CSS hex notation.
    new_project_guidelines str
    Markdown text shown on the new project page.
    profile_image_guidelines str
    Markdown text shown on the profile page below the Public Avatar.
    pwa_description str
    An explanation of what the Progressive Web App does. Used for the attribute description in manifest.json.
    pwa_name str
    Full name of the Progressive Web App. Used for the attribute name in manifest.json.
    pwa_short_name str
    Short name for Progressive Web App.
    title str
    Application title on the sign-in and sign-up page.
    description String
    Markdown text shown on the sign-in and sign-up page.
    emailHeaderAndFooterEnabled Boolean
    Add header and footer to all outgoing emails if enabled.
    footerMessage String
    Message in the system footer bar.
    headerMessage String
    Message in the system header bar.
    keepSettingsOnDestroy Boolean
    memberGuidelines String
    Markdown text shown on the group or project member page for users with permission to change members.
    messageBackgroundColor String
    Background color for the system header or footer bar, in CSS hex notation.
    messageFontColor String
    Font color for the system header or footer bar, in CSS hex notation.
    newProjectGuidelines String
    Markdown text shown on the new project page.
    profileImageGuidelines String
    Markdown text shown on the profile page below the Public Avatar.
    pwaDescription String
    An explanation of what the Progressive Web App does. Used for the attribute description in manifest.json.
    pwaName String
    Full name of the Progressive Web App. Used for the attribute name in manifest.json.
    pwaShortName String
    Short name for Progressive Web App.
    title String
    Application title on the sign-in and sign-up page.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApplicationAppearance 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 ApplicationAppearance Resource

    Get an existing ApplicationAppearance 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?: ApplicationAppearanceState, opts?: CustomResourceOptions): ApplicationAppearance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        email_header_and_footer_enabled: Optional[bool] = None,
        footer_message: Optional[str] = None,
        header_message: Optional[str] = None,
        keep_settings_on_destroy: Optional[bool] = None,
        member_guidelines: Optional[str] = None,
        message_background_color: Optional[str] = None,
        message_font_color: Optional[str] = None,
        new_project_guidelines: Optional[str] = None,
        profile_image_guidelines: Optional[str] = None,
        pwa_description: Optional[str] = None,
        pwa_name: Optional[str] = None,
        pwa_short_name: Optional[str] = None,
        title: Optional[str] = None) -> ApplicationAppearance
    func GetApplicationAppearance(ctx *Context, name string, id IDInput, state *ApplicationAppearanceState, opts ...ResourceOption) (*ApplicationAppearance, error)
    public static ApplicationAppearance Get(string name, Input<string> id, ApplicationAppearanceState? state, CustomResourceOptions? opts = null)
    public static ApplicationAppearance get(String name, Output<String> id, ApplicationAppearanceState state, CustomResourceOptions options)
    resources:  _:    type: gitlab:ApplicationAppearance    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:
    Description string
    Markdown text shown on the sign-in and sign-up page.
    EmailHeaderAndFooterEnabled bool
    Add header and footer to all outgoing emails if enabled.
    FooterMessage string
    Message in the system footer bar.
    HeaderMessage string
    Message in the system header bar.
    KeepSettingsOnDestroy bool
    MemberGuidelines string
    Markdown text shown on the group or project member page for users with permission to change members.
    MessageBackgroundColor string
    Background color for the system header or footer bar, in CSS hex notation.
    MessageFontColor string
    Font color for the system header or footer bar, in CSS hex notation.
    NewProjectGuidelines string
    Markdown text shown on the new project page.
    ProfileImageGuidelines string
    Markdown text shown on the profile page below the Public Avatar.
    PwaDescription string
    An explanation of what the Progressive Web App does. Used for the attribute description in manifest.json.
    PwaName string
    Full name of the Progressive Web App. Used for the attribute name in manifest.json.
    PwaShortName string
    Short name for Progressive Web App.
    Title string
    Application title on the sign-in and sign-up page.
    Description string
    Markdown text shown on the sign-in and sign-up page.
    EmailHeaderAndFooterEnabled bool
    Add header and footer to all outgoing emails if enabled.
    FooterMessage string
    Message in the system footer bar.
    HeaderMessage string
    Message in the system header bar.
    KeepSettingsOnDestroy bool
    MemberGuidelines string
    Markdown text shown on the group or project member page for users with permission to change members.
    MessageBackgroundColor string
    Background color for the system header or footer bar, in CSS hex notation.
    MessageFontColor string
    Font color for the system header or footer bar, in CSS hex notation.
    NewProjectGuidelines string
    Markdown text shown on the new project page.
    ProfileImageGuidelines string
    Markdown text shown on the profile page below the Public Avatar.
    PwaDescription string
    An explanation of what the Progressive Web App does. Used for the attribute description in manifest.json.
    PwaName string
    Full name of the Progressive Web App. Used for the attribute name in manifest.json.
    PwaShortName string
    Short name for Progressive Web App.
    Title string
    Application title on the sign-in and sign-up page.
    description String
    Markdown text shown on the sign-in and sign-up page.
    emailHeaderAndFooterEnabled Boolean
    Add header and footer to all outgoing emails if enabled.
    footerMessage String
    Message in the system footer bar.
    headerMessage String
    Message in the system header bar.
    keepSettingsOnDestroy Boolean
    memberGuidelines String
    Markdown text shown on the group or project member page for users with permission to change members.
    messageBackgroundColor String
    Background color for the system header or footer bar, in CSS hex notation.
    messageFontColor String
    Font color for the system header or footer bar, in CSS hex notation.
    newProjectGuidelines String
    Markdown text shown on the new project page.
    profileImageGuidelines String
    Markdown text shown on the profile page below the Public Avatar.
    pwaDescription String
    An explanation of what the Progressive Web App does. Used for the attribute description in manifest.json.
    pwaName String
    Full name of the Progressive Web App. Used for the attribute name in manifest.json.
    pwaShortName String
    Short name for Progressive Web App.
    title String
    Application title on the sign-in and sign-up page.
    description string
    Markdown text shown on the sign-in and sign-up page.
    emailHeaderAndFooterEnabled boolean
    Add header and footer to all outgoing emails if enabled.
    footerMessage string
    Message in the system footer bar.
    headerMessage string
    Message in the system header bar.
    keepSettingsOnDestroy boolean
    memberGuidelines string
    Markdown text shown on the group or project member page for users with permission to change members.
    messageBackgroundColor string
    Background color for the system header or footer bar, in CSS hex notation.
    messageFontColor string
    Font color for the system header or footer bar, in CSS hex notation.
    newProjectGuidelines string
    Markdown text shown on the new project page.
    profileImageGuidelines string
    Markdown text shown on the profile page below the Public Avatar.
    pwaDescription string
    An explanation of what the Progressive Web App does. Used for the attribute description in manifest.json.
    pwaName string
    Full name of the Progressive Web App. Used for the attribute name in manifest.json.
    pwaShortName string
    Short name for Progressive Web App.
    title string
    Application title on the sign-in and sign-up page.
    description str
    Markdown text shown on the sign-in and sign-up page.
    email_header_and_footer_enabled bool
    Add header and footer to all outgoing emails if enabled.
    footer_message str
    Message in the system footer bar.
    header_message str
    Message in the system header bar.
    keep_settings_on_destroy bool
    member_guidelines str
    Markdown text shown on the group or project member page for users with permission to change members.
    message_background_color str
    Background color for the system header or footer bar, in CSS hex notation.
    message_font_color str
    Font color for the system header or footer bar, in CSS hex notation.
    new_project_guidelines str
    Markdown text shown on the new project page.
    profile_image_guidelines str
    Markdown text shown on the profile page below the Public Avatar.
    pwa_description str
    An explanation of what the Progressive Web App does. Used for the attribute description in manifest.json.
    pwa_name str
    Full name of the Progressive Web App. Used for the attribute name in manifest.json.
    pwa_short_name str
    Short name for Progressive Web App.
    title str
    Application title on the sign-in and sign-up page.
    description String
    Markdown text shown on the sign-in and sign-up page.
    emailHeaderAndFooterEnabled Boolean
    Add header and footer to all outgoing emails if enabled.
    footerMessage String
    Message in the system footer bar.
    headerMessage String
    Message in the system header bar.
    keepSettingsOnDestroy Boolean
    memberGuidelines String
    Markdown text shown on the group or project member page for users with permission to change members.
    messageBackgroundColor String
    Background color for the system header or footer bar, in CSS hex notation.
    messageFontColor String
    Font color for the system header or footer bar, in CSS hex notation.
    newProjectGuidelines String
    Markdown text shown on the new project page.
    profileImageGuidelines String
    Markdown text shown on the profile page below the Public Avatar.
    pwaDescription String
    An explanation of what the Progressive Web App does. Used for the attribute description in manifest.json.
    pwaName String
    Full name of the Progressive Web App. Used for the attribute name in manifest.json.
    pwaShortName String
    Short name for Progressive Web App.
    title String
    Application title on the sign-in and sign-up page.

    Import

    Starting in Terraform v1.5.0, you can use an import block to import gitlab_application_appearance. For example:

    terraform

    import {

    to = gitlab_application_appearance.example

    id = “see CLI command below for ID”

    }

    Importing using the CLI is supported with the following syntax:

    Gitlab application appearance can be imported with the hard-coded key gitlab, for example:

    $ pulumi import gitlab:index/applicationAppearance:ApplicationAppearance example "gitlab"

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

    Package Details

    Repository
    GitLab pulumi/pulumi-gitlab
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the gitlab Terraform Provider.
    gitlab logo
    GitLab v9.2.0 published on Friday, Jul 18, 2025 by Pulumi
    pulumi/pulumi-gitlab