Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. IntegrationExternalWiki
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

gitlab.IntegrationExternalWiki

Explore with Pulumi AI

GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

The gitlab.IntegrationExternalWiki resource allows to manage the lifecycle of a project integration with External Wiki Service.

Upstream API: GitLab REST API docs

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const awesomeProject = new gitlab.Project("awesome_project", {
    name: "awesome_project",
    description: "My awesome project.",
    visibilityLevel: "public",
});
const wiki = new gitlab.IntegrationExternalWiki("wiki", {
    project: awesomeProject.id,
    externalWikiUrl: "https://MyAwesomeExternalWikiURL.com",
});
Copy
import pulumi
import pulumi_gitlab as gitlab

awesome_project = gitlab.Project("awesome_project",
    name="awesome_project",
    description="My awesome project.",
    visibility_level="public")
wiki = gitlab.IntegrationExternalWiki("wiki",
    project=awesome_project.id,
    external_wiki_url="https://MyAwesomeExternalWikiURL.com")
Copy
package main

import (
	"github.com/pulumi/pulumi-gitlab/sdk/v8/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		awesomeProject, err := gitlab.NewProject(ctx, "awesome_project", &gitlab.ProjectArgs{
			Name:            pulumi.String("awesome_project"),
			Description:     pulumi.String("My awesome project."),
			VisibilityLevel: pulumi.String("public"),
		})
		if err != nil {
			return err
		}
		_, err = gitlab.NewIntegrationExternalWiki(ctx, "wiki", &gitlab.IntegrationExternalWikiArgs{
			Project:         awesomeProject.ID(),
			ExternalWikiUrl: pulumi.String("https://MyAwesomeExternalWikiURL.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;

return await Deployment.RunAsync(() => 
{
    var awesomeProject = new GitLab.Project("awesome_project", new()
    {
        Name = "awesome_project",
        Description = "My awesome project.",
        VisibilityLevel = "public",
    });

    var wiki = new GitLab.IntegrationExternalWiki("wiki", new()
    {
        Project = awesomeProject.Id,
        ExternalWikiUrl = "https://MyAwesomeExternalWikiURL.com",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.Project;
import com.pulumi.gitlab.ProjectArgs;
import com.pulumi.gitlab.IntegrationExternalWiki;
import com.pulumi.gitlab.IntegrationExternalWikiArgs;
import java.util.List;
import java.util.ArrayList;
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 awesomeProject = new Project("awesomeProject", ProjectArgs.builder()
            .name("awesome_project")
            .description("My awesome project.")
            .visibilityLevel("public")
            .build());

        var wiki = new IntegrationExternalWiki("wiki", IntegrationExternalWikiArgs.builder()
            .project(awesomeProject.id())
            .externalWikiUrl("https://MyAwesomeExternalWikiURL.com")
            .build());

    }
}
Copy
resources:
  awesomeProject:
    type: gitlab:Project
    name: awesome_project
    properties:
      name: awesome_project
      description: My awesome project.
      visibilityLevel: public
  wiki:
    type: gitlab:IntegrationExternalWiki
    properties:
      project: ${awesomeProject.id}
      externalWikiUrl: https://MyAwesomeExternalWikiURL.com
Copy

Create IntegrationExternalWiki Resource

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

Constructor syntax

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

@overload
def IntegrationExternalWiki(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            external_wiki_url: Optional[str] = None,
                            project: Optional[str] = None)
func NewIntegrationExternalWiki(ctx *Context, name string, args IntegrationExternalWikiArgs, opts ...ResourceOption) (*IntegrationExternalWiki, error)
public IntegrationExternalWiki(string name, IntegrationExternalWikiArgs args, CustomResourceOptions? opts = null)
public IntegrationExternalWiki(String name, IntegrationExternalWikiArgs args)
public IntegrationExternalWiki(String name, IntegrationExternalWikiArgs args, CustomResourceOptions options)

type: gitlab:IntegrationExternalWiki
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IntegrationExternalWikiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IntegrationExternalWikiArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IntegrationExternalWikiArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IntegrationExternalWikiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IntegrationExternalWikiArgs
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 integrationExternalWikiResource = new GitLab.IntegrationExternalWiki("integrationExternalWikiResource", new()
{
    ExternalWikiUrl = "string",
    Project = "string",
});
Copy
example, err := gitlab.NewIntegrationExternalWiki(ctx, "integrationExternalWikiResource", &gitlab.IntegrationExternalWikiArgs{
	ExternalWikiUrl: pulumi.String("string"),
	Project:         pulumi.String("string"),
})
Copy
var integrationExternalWikiResource = new IntegrationExternalWiki("integrationExternalWikiResource", IntegrationExternalWikiArgs.builder()
    .externalWikiUrl("string")
    .project("string")
    .build());
Copy
integration_external_wiki_resource = gitlab.IntegrationExternalWiki("integrationExternalWikiResource",
    external_wiki_url="string",
    project="string")
Copy
const integrationExternalWikiResource = new gitlab.IntegrationExternalWiki("integrationExternalWikiResource", {
    externalWikiUrl: "string",
    project: "string",
});
Copy
type: gitlab:IntegrationExternalWiki
properties:
    externalWikiUrl: string
    project: string
Copy

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

ExternalWikiUrl This property is required. string
The URL of the external wiki.
Project
This property is required.
Changes to this property will trigger replacement.
string
ID of the project you want to activate integration on.
ExternalWikiUrl This property is required. string
The URL of the external wiki.
Project
This property is required.
Changes to this property will trigger replacement.
string
ID of the project you want to activate integration on.
externalWikiUrl This property is required. String
The URL of the external wiki.
project
This property is required.
Changes to this property will trigger replacement.
String
ID of the project you want to activate integration on.
externalWikiUrl This property is required. string
The URL of the external wiki.
project
This property is required.
Changes to this property will trigger replacement.
string
ID of the project you want to activate integration on.
external_wiki_url This property is required. str
The URL of the external wiki.
project
This property is required.
Changes to this property will trigger replacement.
str
ID of the project you want to activate integration on.
externalWikiUrl This property is required. String
The URL of the external wiki.
project
This property is required.
Changes to this property will trigger replacement.
String
ID of the project you want to activate integration on.

Outputs

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

Active bool
Whether the integration is active.
CreatedAt string
The ISO8601 date/time that this integration was activated at in UTC.
Id string
The provider-assigned unique ID for this managed resource.
Slug string
The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
Title string
Title of the integration.
UpdatedAt string
The ISO8601 date/time that this integration was last updated at in UTC.
Active bool
Whether the integration is active.
CreatedAt string
The ISO8601 date/time that this integration was activated at in UTC.
Id string
The provider-assigned unique ID for this managed resource.
Slug string
The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
Title string
Title of the integration.
UpdatedAt string
The ISO8601 date/time that this integration was last updated at in UTC.
active Boolean
Whether the integration is active.
createdAt String
The ISO8601 date/time that this integration was activated at in UTC.
id String
The provider-assigned unique ID for this managed resource.
slug String
The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
title String
Title of the integration.
updatedAt String
The ISO8601 date/time that this integration was last updated at in UTC.
active boolean
Whether the integration is active.
createdAt string
The ISO8601 date/time that this integration was activated at in UTC.
id string
The provider-assigned unique ID for this managed resource.
slug string
The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
title string
Title of the integration.
updatedAt string
The ISO8601 date/time that this integration was last updated at in UTC.
active bool
Whether the integration is active.
created_at str
The ISO8601 date/time that this integration was activated at in UTC.
id str
The provider-assigned unique ID for this managed resource.
slug str
The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
title str
Title of the integration.
updated_at str
The ISO8601 date/time that this integration was last updated at in UTC.
active Boolean
Whether the integration is active.
createdAt String
The ISO8601 date/time that this integration was activated at in UTC.
id String
The provider-assigned unique ID for this managed resource.
slug String
The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
title String
Title of the integration.
updatedAt String
The ISO8601 date/time that this integration was last updated at in UTC.

Look up Existing IntegrationExternalWiki Resource

Get an existing IntegrationExternalWiki 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?: IntegrationExternalWikiState, opts?: CustomResourceOptions): IntegrationExternalWiki
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        created_at: Optional[str] = None,
        external_wiki_url: Optional[str] = None,
        project: Optional[str] = None,
        slug: Optional[str] = None,
        title: Optional[str] = None,
        updated_at: Optional[str] = None) -> IntegrationExternalWiki
func GetIntegrationExternalWiki(ctx *Context, name string, id IDInput, state *IntegrationExternalWikiState, opts ...ResourceOption) (*IntegrationExternalWiki, error)
public static IntegrationExternalWiki Get(string name, Input<string> id, IntegrationExternalWikiState? state, CustomResourceOptions? opts = null)
public static IntegrationExternalWiki get(String name, Output<String> id, IntegrationExternalWikiState state, CustomResourceOptions options)
resources:  _:    type: gitlab:IntegrationExternalWiki    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Active bool
Whether the integration is active.
CreatedAt string
The ISO8601 date/time that this integration was activated at in UTC.
ExternalWikiUrl string
The URL of the external wiki.
Project Changes to this property will trigger replacement. string
ID of the project you want to activate integration on.
Slug string
The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
Title string
Title of the integration.
UpdatedAt string
The ISO8601 date/time that this integration was last updated at in UTC.
Active bool
Whether the integration is active.
CreatedAt string
The ISO8601 date/time that this integration was activated at in UTC.
ExternalWikiUrl string
The URL of the external wiki.
Project Changes to this property will trigger replacement. string
ID of the project you want to activate integration on.
Slug string
The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
Title string
Title of the integration.
UpdatedAt string
The ISO8601 date/time that this integration was last updated at in UTC.
active Boolean
Whether the integration is active.
createdAt String
The ISO8601 date/time that this integration was activated at in UTC.
externalWikiUrl String
The URL of the external wiki.
project Changes to this property will trigger replacement. String
ID of the project you want to activate integration on.
slug String
The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
title String
Title of the integration.
updatedAt String
The ISO8601 date/time that this integration was last updated at in UTC.
active boolean
Whether the integration is active.
createdAt string
The ISO8601 date/time that this integration was activated at in UTC.
externalWikiUrl string
The URL of the external wiki.
project Changes to this property will trigger replacement. string
ID of the project you want to activate integration on.
slug string
The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
title string
Title of the integration.
updatedAt string
The ISO8601 date/time that this integration was last updated at in UTC.
active bool
Whether the integration is active.
created_at str
The ISO8601 date/time that this integration was activated at in UTC.
external_wiki_url str
The URL of the external wiki.
project Changes to this property will trigger replacement. str
ID of the project you want to activate integration on.
slug str
The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
title str
Title of the integration.
updated_at str
The ISO8601 date/time that this integration was last updated at in UTC.
active Boolean
Whether the integration is active.
createdAt String
The ISO8601 date/time that this integration was activated at in UTC.
externalWikiUrl String
The URL of the external wiki.
project Changes to this property will trigger replacement. String
ID of the project you want to activate integration on.
slug String
The name of the integration in lowercase, shortened to 63 bytes, and with everything except 0-9 and a-z replaced with -. No leading / trailing -. Use in URLs, host names and domain names.
title String
Title of the integration.
updatedAt String
The ISO8601 date/time that this integration was last updated at in UTC.

Import

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

terraform

import {

to = gitlab_integration_external_wiki.example

id = “see CLI command below for ID”

}

Import using the CLI is supported using the following syntax:

You can import a gitlab_integration_external_wiki state using the project ID, e.g.

$ pulumi import gitlab:index/integrationExternalWiki:IntegrationExternalWiki wiki 1
Copy

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 v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab