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

gitlab.ProjectWikiPage

Explore with Pulumi AI

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

The gitlab.ProjectWikiPage resource allows managing the lifecycle of a project wiki page.

Upstream API: GitLab REST API docs

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  example:
    type: gitlab:ProjectWikiPage
    properties:
      project: ${projectID}
      slug: test-wiki-page
      title: Test Wiki Page
      content: |
        This is a test content for the wiki page.
        And this is a second line of content.
Copy

Create ProjectWikiPage Resource

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

Constructor syntax

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

@overload
def ProjectWikiPage(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    content: Optional[str] = None,
                    project: Optional[str] = None,
                    title: Optional[str] = None,
                    format: Optional[str] = None)
func NewProjectWikiPage(ctx *Context, name string, args ProjectWikiPageArgs, opts ...ResourceOption) (*ProjectWikiPage, error)
public ProjectWikiPage(string name, ProjectWikiPageArgs args, CustomResourceOptions? opts = null)
public ProjectWikiPage(String name, ProjectWikiPageArgs args)
public ProjectWikiPage(String name, ProjectWikiPageArgs args, CustomResourceOptions options)

type: gitlab:ProjectWikiPage
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. ProjectWikiPageArgs
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. ProjectWikiPageArgs
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. ProjectWikiPageArgs
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. ProjectWikiPageArgs
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. ProjectWikiPageArgs
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 projectWikiPageResource = new GitLab.ProjectWikiPage("projectWikiPageResource", new()
{
    Content = "string",
    Project = "string",
    Title = "string",
    Format = "string",
});
Copy
example, err := gitlab.NewProjectWikiPage(ctx, "projectWikiPageResource", &gitlab.ProjectWikiPageArgs{
	Content: pulumi.String("string"),
	Project: pulumi.String("string"),
	Title:   pulumi.String("string"),
	Format:  pulumi.String("string"),
})
Copy
var projectWikiPageResource = new ProjectWikiPage("projectWikiPageResource", ProjectWikiPageArgs.builder()
    .content("string")
    .project("string")
    .title("string")
    .format("string")
    .build());
Copy
project_wiki_page_resource = gitlab.ProjectWikiPage("projectWikiPageResource",
    content="string",
    project="string",
    title="string",
    format="string")
Copy
const projectWikiPageResource = new gitlab.ProjectWikiPage("projectWikiPageResource", {
    content: "string",
    project: "string",
    title: "string",
    format: "string",
});
Copy
type: gitlab:ProjectWikiPage
properties:
    content: string
    format: string
    project: string
    title: string
Copy

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

Content This property is required. string
Content of the wiki page. Must be at least 1 character long.
Project This property is required. string
The ID or URL-encoded path of the project.
Title This property is required. string
Title of the wiki page.
Format string
Format of the wiki page (auto-generated if not provided). Valid values are: markdown, rdoc, asciidoc, org.
Content This property is required. string
Content of the wiki page. Must be at least 1 character long.
Project This property is required. string
The ID or URL-encoded path of the project.
Title This property is required. string
Title of the wiki page.
Format string
Format of the wiki page (auto-generated if not provided). Valid values are: markdown, rdoc, asciidoc, org.
content This property is required. String
Content of the wiki page. Must be at least 1 character long.
project This property is required. String
The ID or URL-encoded path of the project.
title This property is required. String
Title of the wiki page.
format String
Format of the wiki page (auto-generated if not provided). Valid values are: markdown, rdoc, asciidoc, org.
content This property is required. string
Content of the wiki page. Must be at least 1 character long.
project This property is required. string
The ID or URL-encoded path of the project.
title This property is required. string
Title of the wiki page.
format string
Format of the wiki page (auto-generated if not provided). Valid values are: markdown, rdoc, asciidoc, org.
content This property is required. str
Content of the wiki page. Must be at least 1 character long.
project This property is required. str
The ID or URL-encoded path of the project.
title This property is required. str
Title of the wiki page.
format str
Format of the wiki page (auto-generated if not provided). Valid values are: markdown, rdoc, asciidoc, org.
content This property is required. String
Content of the wiki page. Must be at least 1 character long.
project This property is required. String
The ID or URL-encoded path of the project.
title This property is required. String
Title of the wiki page.
format String
Format of the wiki page (auto-generated if not provided). Valid values are: markdown, rdoc, asciidoc, org.

Outputs

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

Encoding string
The encoding used for the wiki page content.
Id string
The provider-assigned unique ID for this managed resource.
Slug string
Slug of the wiki page.
Encoding string
The encoding used for the wiki page content.
Id string
The provider-assigned unique ID for this managed resource.
Slug string
Slug of the wiki page.
encoding String
The encoding used for the wiki page content.
id String
The provider-assigned unique ID for this managed resource.
slug String
Slug of the wiki page.
encoding string
The encoding used for the wiki page content.
id string
The provider-assigned unique ID for this managed resource.
slug string
Slug of the wiki page.
encoding str
The encoding used for the wiki page content.
id str
The provider-assigned unique ID for this managed resource.
slug str
Slug of the wiki page.
encoding String
The encoding used for the wiki page content.
id String
The provider-assigned unique ID for this managed resource.
slug String
Slug of the wiki page.

Look up Existing ProjectWikiPage Resource

Get an existing ProjectWikiPage 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?: ProjectWikiPageState, opts?: CustomResourceOptions): ProjectWikiPage
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        content: Optional[str] = None,
        encoding: Optional[str] = None,
        format: Optional[str] = None,
        project: Optional[str] = None,
        slug: Optional[str] = None,
        title: Optional[str] = None) -> ProjectWikiPage
func GetProjectWikiPage(ctx *Context, name string, id IDInput, state *ProjectWikiPageState, opts ...ResourceOption) (*ProjectWikiPage, error)
public static ProjectWikiPage Get(string name, Input<string> id, ProjectWikiPageState? state, CustomResourceOptions? opts = null)
public static ProjectWikiPage get(String name, Output<String> id, ProjectWikiPageState state, CustomResourceOptions options)
resources:  _:    type: gitlab:ProjectWikiPage    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:
Content string
Content of the wiki page. Must be at least 1 character long.
Encoding string
The encoding used for the wiki page content.
Format string
Format of the wiki page (auto-generated if not provided). Valid values are: markdown, rdoc, asciidoc, org.
Project string
The ID or URL-encoded path of the project.
Slug string
Slug of the wiki page.
Title string
Title of the wiki page.
Content string
Content of the wiki page. Must be at least 1 character long.
Encoding string
The encoding used for the wiki page content.
Format string
Format of the wiki page (auto-generated if not provided). Valid values are: markdown, rdoc, asciidoc, org.
Project string
The ID or URL-encoded path of the project.
Slug string
Slug of the wiki page.
Title string
Title of the wiki page.
content String
Content of the wiki page. Must be at least 1 character long.
encoding String
The encoding used for the wiki page content.
format String
Format of the wiki page (auto-generated if not provided). Valid values are: markdown, rdoc, asciidoc, org.
project String
The ID or URL-encoded path of the project.
slug String
Slug of the wiki page.
title String
Title of the wiki page.
content string
Content of the wiki page. Must be at least 1 character long.
encoding string
The encoding used for the wiki page content.
format string
Format of the wiki page (auto-generated if not provided). Valid values are: markdown, rdoc, asciidoc, org.
project string
The ID or URL-encoded path of the project.
slug string
Slug of the wiki page.
title string
Title of the wiki page.
content str
Content of the wiki page. Must be at least 1 character long.
encoding str
The encoding used for the wiki page content.
format str
Format of the wiki page (auto-generated if not provided). Valid values are: markdown, rdoc, asciidoc, org.
project str
The ID or URL-encoded path of the project.
slug str
Slug of the wiki page.
title str
Title of the wiki page.
content String
Content of the wiki page. Must be at least 1 character long.
encoding String
The encoding used for the wiki page content.
format String
Format of the wiki page (auto-generated if not provided). Valid values are: markdown, rdoc, asciidoc, org.
project String
The ID or URL-encoded path of the project.
slug String
Slug of the wiki page.
title String
Title of the wiki page.

Import

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

terraform

import {

to = gitlab_project_wiki_page.example

id = “see CLI command below for ID”

}

Import using the CLI is supported using the following syntax:

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

$ pulumi import gitlab:index/projectWikiPage:ProjectWikiPage test 12345:my-wiki-page
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