pulumi-gitlab-kotlin/com.pulumi.gitlab.kotlin/ProjectHookArgs

ProjectHookArgs

data class ProjectHookArgs(val confidentialIssuesEvents: Output<Boolean>? = null, val confidentialNoteEvents: Output<Boolean>? = null, val customHeaders: Output<List<ProjectHookCustomHeaderArgs>>? = null, val customWebhookTemplate: Output<String>? = null, val deploymentEvents: Output<Boolean>? = null, val description: Output<String>? = null, val enableSslVerification: Output<Boolean>? = null, val issuesEvents: Output<Boolean>? = null, val jobEvents: Output<Boolean>? = null, val mergeRequestsEvents: Output<Boolean>? = null, val name: Output<String>? = null, val noteEvents: Output<Boolean>? = null, val pipelineEvents: Output<Boolean>? = null, val project: Output<String>? = null, val pushEvents: Output<Boolean>? = null, val pushEventsBranchFilter: Output<String>? = null, val releasesEvents: Output<Boolean>? = null, val resourceAccessTokenEvents: Output<Boolean>? = null, val tagPushEvents: Output<Boolean>? = null, val token: Output<String>? = null, val url: Output<String>? = null, val wikiPageEvents: Output<Boolean>? = null) : ConvertibleToJava<ProjectHookArgs>

The gitlab.ProjectHook resource allows to manage the lifecycle of a project hook. Upstream API: GitLab REST API docs

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
const example = new gitlab.ProjectHook("example", {
    project: "example/hooked",
    url: "https://example.com/hook/example",
    name: "example",
    description: "Example hook",
    mergeRequestsEvents: true,
});
// Using Custom Headers
// Values of headers can't be imported
const customHeaders = new gitlab.ProjectHook("custom_headers", {
    project: "example/hooked",
    url: "https://example.com/hook/example",
    mergeRequestsEvents: true,
    customHeaders: [
        {
            key: "X-Custom-Header",
            value: "example",
        },
        {
            key: "X-Custom-Header-Second",
            value: "example-second",
        },
    ],
});
Content copied to clipboard
import pulumi
import pulumi_gitlab as gitlab
example = gitlab.ProjectHook("example",
    project="example/hooked",
    url="https://example.com/hook/example",
    name="example",
    description="Example hook",
    merge_requests_events=True)
# Using Custom Headers
# Values of headers can't be imported
custom_headers = gitlab.ProjectHook("custom_headers",
    project="example/hooked",
    url="https://example.com/hook/example",
    merge_requests_events=True,
    custom_headers=[
        {
            "key": "X-Custom-Header",
            "value": "example",
        },
        {
            "key": "X-Custom-Header-Second",
            "value": "example-second",
        },
    ])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() =>
{
    var example = new GitLab.ProjectHook("example", new()
    {
        Project = "example/hooked",
        Url = "https://example.com/hook/example",
        Name = "example",
        Description = "Example hook",
        MergeRequestsEvents = true,
    });
    // Using Custom Headers
    // Values of headers can't be imported
    var customHeaders = new GitLab.ProjectHook("custom_headers", new()
    {
        Project = "example/hooked",
        Url = "https://example.com/hook/example",
        MergeRequestsEvents = true,
        CustomHeaders = new[]
        {
            new GitLab.Inputs.ProjectHookCustomHeaderArgs
            {
                Key = "X-Custom-Header",
                Value = "example",
            },
            new GitLab.Inputs.ProjectHookCustomHeaderArgs
            {
                Key = "X-Custom-Header-Second",
                Value = "example-second",
            },
        },
    });
});
Content copied to clipboard
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 {
		_, err := gitlab.NewProjectHook(ctx, "example", &gitlab.ProjectHookArgs{
			Project:             pulumi.String("example/hooked"),
			Url:                 pulumi.String("https://example.com/hook/example"),
			Name:                pulumi.String("example"),
			Description:         pulumi.String("Example hook"),
			MergeRequestsEvents: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		// Using Custom Headers
		// Values of headers can't be imported
		_, err = gitlab.NewProjectHook(ctx, "custom_headers", &gitlab.ProjectHookArgs{
			Project:             pulumi.String("example/hooked"),
			Url:                 pulumi.String("https://example.com/hook/example"),
			MergeRequestsEvents: pulumi.Bool(true),
			CustomHeaders: gitlab.ProjectHookCustomHeaderArray{
				&gitlab.ProjectHookCustomHeaderArgs{
					Key:   pulumi.String("X-Custom-Header"),
					Value: pulumi.String("example"),
				},
				&gitlab.ProjectHookCustomHeaderArgs{
					Key:   pulumi.String("X-Custom-Header-Second"),
					Value: pulumi.String("example-second"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.ProjectHook;
import com.pulumi.gitlab.ProjectHookArgs;
import com.pulumi.gitlab.inputs.ProjectHookCustomHeaderArgs;
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 example = new ProjectHook("example", ProjectHookArgs.builder()
            .project("example/hooked")
            .url("https://example.com/hook/example")
            .name("example")
            .description("Example hook")
            .mergeRequestsEvents(true)
            .build());
        // Using Custom Headers
        // Values of headers can't be imported
        var customHeaders = new ProjectHook("customHeaders", ProjectHookArgs.builder()
            .project("example/hooked")
            .url("https://example.com/hook/example")
            .mergeRequestsEvents(true)
            .customHeaders(
                ProjectHookCustomHeaderArgs.builder()
                    .key("X-Custom-Header")
                    .value("example")
                    .build(),
                ProjectHookCustomHeaderArgs.builder()
                    .key("X-Custom-Header-Second")
                    .value("example-second")
                    .build())
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: gitlab:ProjectHook
    properties:
      project: example/hooked
      url: https://example.com/hook/example
      name: example
      description: Example hook
      mergeRequestsEvents: true
  # Using Custom Headers
  # Values of headers can't be imported
  customHeaders:
    type: gitlab:ProjectHook
    name: custom_headers
    properties:
      project: example/hooked
      url: https://example.com/hook/example
      mergeRequestsEvents: true
      customHeaders:
        - key: X-Custom-Header
          value: example
        - key: X-Custom-Header-Second
          value: example-second
Content copied to clipboard

Import

Starting in Terraform v1.5.0 you can use an import block to import gitlab_project_hook. For example: terraform import { to = gitlab_project_hook.example id = "see CLI command below for ID" } Import using the CLI is supported using the following syntax: A GitLab Project Hook can be imported using a key composed of <project-id>:<hook-id>, e.g.

$ pulumi import gitlab:index/projectHook:ProjectHook example "12345:1"
Content copied to clipboard

NOTE: the token resource attribute is not available for imported resources as this information cannot be read from the GitLab API.

Constructors

Link copied to clipboard
constructor(confidentialIssuesEvents: Output<Boolean>? = null, confidentialNoteEvents: Output<Boolean>? = null, customHeaders: Output<List<ProjectHookCustomHeaderArgs>>? = null, customWebhookTemplate: Output<String>? = null, deploymentEvents: Output<Boolean>? = null, description: Output<String>? = null, enableSslVerification: Output<Boolean>? = null, issuesEvents: Output<Boolean>? = null, jobEvents: Output<Boolean>? = null, mergeRequestsEvents: Output<Boolean>? = null, name: Output<String>? = null, noteEvents: Output<Boolean>? = null, pipelineEvents: Output<Boolean>? = null, project: Output<String>? = null, pushEvents: Output<Boolean>? = null, pushEventsBranchFilter: Output<String>? = null, releasesEvents: Output<Boolean>? = null, resourceAccessTokenEvents: Output<Boolean>? = null, tagPushEvents: Output<Boolean>? = null, token: Output<String>? = null, url: Output<String>? = null, wikiPageEvents: Output<Boolean>? = null)

Properties

Link copied to clipboard
val confidentialIssuesEvents: Output<Boolean>? = null

Invoke the hook for confidential issues events.

Link copied to clipboard
val confidentialNoteEvents: Output<Boolean>? = null

Invoke the hook for confidential note events.

Link copied to clipboard
val customHeaders: Output<List<ProjectHookCustomHeaderArgs>>? = null

Custom headers for the project webhook.

Link copied to clipboard
val customWebhookTemplate: Output<String>? = null

Custom webhook template.

Link copied to clipboard
val deploymentEvents: Output<Boolean>? = null

Invoke the hook for deployment events.

Link copied to clipboard
val description: Output<String>? = null

Description of the webhook.

Link copied to clipboard
val enableSslVerification: Output<Boolean>? = null

Enable SSL verification when invoking the hook.

Link copied to clipboard
val issuesEvents: Output<Boolean>? = null

Invoke the hook for issues events.

Link copied to clipboard
val jobEvents: Output<Boolean>? = null

Invoke the hook for job events.

Link copied to clipboard
val mergeRequestsEvents: Output<Boolean>? = null

Invoke the hook for merge requests events.

Link copied to clipboard
val name: Output<String>? = null

Name of the project webhook.

Link copied to clipboard
val noteEvents: Output<Boolean>? = null

Invoke the hook for note events.

Link copied to clipboard
val pipelineEvents: Output<Boolean>? = null

Invoke the hook for pipeline events.

Link copied to clipboard
val project: Output<String>? = null

The name or id of the project to add the hook to.

Link copied to clipboard
val pushEvents: Output<Boolean>? = null

Invoke the hook for push events.

Link copied to clipboard
val pushEventsBranchFilter: Output<String>? = null

Invoke the hook for push events on matching branches only.

Link copied to clipboard
val releasesEvents: Output<Boolean>? = null

Invoke the hook for release events.

Link copied to clipboard
val resourceAccessTokenEvents: Output<Boolean>? = null

Invoke the hook for project access token expiry events.

Link copied to clipboard
val tagPushEvents: Output<Boolean>? = null

Invoke the hook for tag push events.

Link copied to clipboard
val token: Output<String>? = null

A token to present when invoking the hook. The token is not available for imported resources.

Link copied to clipboard
val url: Output<String>? = null

The url of the hook to invoke. Forces re-creation to preserve token.

Link copied to clipboard
val wikiPageEvents: Output<Boolean>? = null

Invoke the hook for wiki page events.

Functions

Link copied to clipboard
open override fun toJava(): ProjectHookArgs