Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. ServiceExternalWiki
GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi
pulumi/pulumi-gitlab

gitlab.ServiceExternalWiki

Explore with Pulumi AI

gitlab logo
GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi
pulumi/pulumi-gitlab

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

    This resource is deprecated. use gitlab.IntegrationExternalWikiinstead!

    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.ServiceExternalWiki("wiki", {
    project: awesomeProject.id,
    externalWikiUrl: "https://MyAwesomeExternalWikiURL.com",
});

    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.ServiceExternalWiki("wiki",
    project=awesome_project.id,
    external_wiki_url="https://MyAwesomeExternalWikiURL.com")

    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.NewServiceExternalWiki(ctx, "wiki", &gitlab.ServiceExternalWikiArgs{
			Project:         awesomeProject.ID(),
			ExternalWikiUrl: pulumi.String("https://MyAwesomeExternalWikiURL.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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.ServiceExternalWiki("wiki", new()
    {
        Project = awesomeProject.Id,
        ExternalWikiUrl = "https://MyAwesomeExternalWikiURL.com",
    });

});

    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.ServiceExternalWiki;
import com.pulumi.gitlab.ServiceExternalWikiArgs;
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 ServiceExternalWiki("wiki", ServiceExternalWikiArgs.builder()
            .project(awesomeProject.id())
            .externalWikiUrl("https://MyAwesomeExternalWikiURL.com")
            .build());

    }
}

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

    Create ServiceExternalWiki Resource

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

    Constructor syntax

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

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

    type: gitlab:ServiceExternalWiki
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 ServiceExternalWikiArgs
    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 ServiceExternalWikiArgs
    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 ServiceExternalWikiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceExternalWikiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceExternalWikiArgs
    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 serviceExternalWikiResource = new GitLab.ServiceExternalWiki("serviceExternalWikiResource", new()
{
    ExternalWikiUrl = "string",
    Project = "string",
});

    example, err := gitlab.NewServiceExternalWiki(ctx, "serviceExternalWikiResource", &gitlab.ServiceExternalWikiArgs{
	ExternalWikiUrl: pulumi.String("string"),
	Project:         pulumi.String("string"),
})

    var serviceExternalWikiResource = new ServiceExternalWiki("serviceExternalWikiResource", ServiceExternalWikiArgs.builder()
    .externalWikiUrl("string")
    .project("string")
    .build());

    service_external_wiki_resource = gitlab.ServiceExternalWiki("serviceExternalWikiResource",
    external_wiki_url="string",
    project="string")

    const serviceExternalWikiResource = new gitlab.ServiceExternalWiki("serviceExternalWikiResource", {
    externalWikiUrl: "string",
    project: "string",
});

    type: gitlab:ServiceExternalWiki
properties:
    externalWikiUrl: string
    project: string

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

    ExternalWikiUrl string
    The URL of the external wiki.
    Project string
    ID of the project you want to activate integration on.
    ExternalWikiUrl string
    The URL of the external wiki.
    Project string
    ID of the project you want to activate integration on.
    externalWikiUrl String
    The URL of the external wiki.
    project String
    ID of the project you want to activate integration on.
    externalWikiUrl string
    The URL of the external wiki.
    project string
    ID of the project you want to activate integration on.
    external_wiki_url str
    The URL of the external wiki.
    project str
    ID of the project you want to activate integration on.
    externalWikiUrl String
    The URL of the external wiki.
    project String
    ID of the project you want to activate integration on.

    Outputs

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

    Get an existing ServiceExternalWiki 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?: ServiceExternalWikiState, opts?: CustomResourceOptions): ServiceExternalWiki
    @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) -> ServiceExternalWiki
    func GetServiceExternalWiki(ctx *Context, name string, id IDInput, state *ServiceExternalWikiState, opts ...ResourceOption) (*ServiceExternalWiki, error)
    public static ServiceExternalWiki Get(string name, Input<string> id, ServiceExternalWikiState? state, CustomResourceOptions? opts = null)
    public static ServiceExternalWiki get(String name, Output<String> id, ServiceExternalWikiState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    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 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 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 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 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 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 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

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

    $ pulumi import gitlab:index/serviceExternalWiki:ServiceExternalWiki wiki 1

    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 v8.5.0 published on Friday, Oct 18, 2024 by Pulumi
    pulumi/pulumi-gitlab