The gitlab.GroupIntegrationMattermost resource manages the lifecycle of a group integration with Mattermost.
Upstream API: GitLab REST API docs
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
const example = new gitlab.Group("example", {
name: "example-group",
path: "example-group",
description: "An example group",
});
const mattermost = new gitlab.GroupIntegrationMattermost("mattermost", {
group: example.id,
webhook: "https://mattermost.example.com/hooks/...",
username: "my-username",
});
import pulumi
import pulumi_gitlab as gitlab
example = gitlab.Group("example",
name="example-group",
path="example-group",
description="An example group")
mattermost = gitlab.GroupIntegrationMattermost("mattermost",
group=example.id,
webhook="https://mattermost.example.com/hooks/...",
username="my-username")
package main
import (
"github.com/pulumi/pulumi-gitlab/sdk/v9/go/gitlab"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := gitlab.NewGroup(ctx, "example", &gitlab.GroupArgs{
Name: pulumi.String("example-group"),
Path: pulumi.String("example-group"),
Description: pulumi.String("An example group"),
})
if err != nil {
return err
}
_, err = gitlab.NewGroupIntegrationMattermost(ctx, "mattermost", &gitlab.GroupIntegrationMattermostArgs{
Group: example.ID(),
Webhook: pulumi.String("https://mattermost.example.com/hooks/..."),
Username: pulumi.String("my-username"),
})
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 example = new GitLab.Group("example", new()
{
Name = "example-group",
Path = "example-group",
Description = "An example group",
});
var mattermost = new GitLab.GroupIntegrationMattermost("mattermost", new()
{
Group = example.Id,
Webhook = "https://mattermost.example.com/hooks/...",
Username = "my-username",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.Group;
import com.pulumi.gitlab.GroupArgs;
import com.pulumi.gitlab.GroupIntegrationMattermost;
import com.pulumi.gitlab.GroupIntegrationMattermostArgs;
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 Group("example", GroupArgs.builder()
.name("example-group")
.path("example-group")
.description("An example group")
.build());
var mattermost = new GroupIntegrationMattermost("mattermost", GroupIntegrationMattermostArgs.builder()
.group(example.id())
.webhook("https://mattermost.example.com/hooks/...")
.username("my-username")
.build());
}
}
resources:
example:
type: gitlab:Group
properties:
name: example-group
path: example-group
description: An example group
mattermost:
type: gitlab:GroupIntegrationMattermost
properties:
group: ${example.id}
webhook: https://mattermost.example.com/hooks/...
username: my-username
Create GroupIntegrationMattermost Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GroupIntegrationMattermost(name: string, args: GroupIntegrationMattermostArgs, opts?: CustomResourceOptions);@overload
def GroupIntegrationMattermost(resource_name: str,
args: GroupIntegrationMattermostArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GroupIntegrationMattermost(resource_name: str,
opts: Optional[ResourceOptions] = None,
group: Optional[str] = None,
webhook: Optional[str] = None,
merge_requests_events: Optional[bool] = None,
username: Optional[str] = None,
confidential_note_channel: Optional[str] = None,
confidential_note_events: Optional[bool] = None,
confidential_issue_channel: Optional[str] = None,
issue_channel: Optional[str] = None,
issues_events: Optional[bool] = None,
labels_to_be_notified: Optional[str] = None,
labels_to_be_notified_behavior: Optional[str] = None,
merge_request_channel: Optional[str] = None,
branches_to_be_notified: Optional[str] = None,
note_channel: Optional[str] = None,
confidential_issues_events: Optional[bool] = None,
pipeline_channel: Optional[str] = None,
note_events: Optional[bool] = None,
pipeline_events: Optional[bool] = None,
push_channel: Optional[str] = None,
push_events: Optional[bool] = None,
tag_push_channel: Optional[str] = None,
tag_push_events: Optional[bool] = None,
use_inherited_settings: Optional[bool] = None,
notify_only_broken_pipelines: Optional[bool] = None,
channel: Optional[str] = None,
wiki_page_channel: Optional[str] = None,
wiki_page_events: Optional[bool] = None)func NewGroupIntegrationMattermost(ctx *Context, name string, args GroupIntegrationMattermostArgs, opts ...ResourceOption) (*GroupIntegrationMattermost, error)public GroupIntegrationMattermost(string name, GroupIntegrationMattermostArgs args, CustomResourceOptions? opts = null)
public GroupIntegrationMattermost(String name, GroupIntegrationMattermostArgs args)
public GroupIntegrationMattermost(String name, GroupIntegrationMattermostArgs args, CustomResourceOptions options)
type: gitlab:GroupIntegrationMattermost
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 GroupIntegrationMattermostArgs
- 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 GroupIntegrationMattermostArgs
- 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 GroupIntegrationMattermostArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GroupIntegrationMattermostArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GroupIntegrationMattermostArgs
- 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 groupIntegrationMattermostResource = new GitLab.GroupIntegrationMattermost("groupIntegrationMattermostResource", new()
{
Group = "string",
Webhook = "string",
MergeRequestsEvents = false,
Username = "string",
ConfidentialNoteChannel = "string",
ConfidentialNoteEvents = false,
ConfidentialIssueChannel = "string",
IssueChannel = "string",
IssuesEvents = false,
LabelsToBeNotified = "string",
LabelsToBeNotifiedBehavior = "string",
MergeRequestChannel = "string",
BranchesToBeNotified = "string",
NoteChannel = "string",
ConfidentialIssuesEvents = false,
PipelineChannel = "string",
NoteEvents = false,
PipelineEvents = false,
PushChannel = "string",
PushEvents = false,
TagPushChannel = "string",
TagPushEvents = false,
UseInheritedSettings = false,
NotifyOnlyBrokenPipelines = false,
Channel = "string",
WikiPageChannel = "string",
WikiPageEvents = false,
});
example, err := gitlab.NewGroupIntegrationMattermost(ctx, "groupIntegrationMattermostResource", &gitlab.GroupIntegrationMattermostArgs{
Group: pulumi.String("string"),
Webhook: pulumi.String("string"),
MergeRequestsEvents: pulumi.Bool(false),
Username: pulumi.String("string"),
ConfidentialNoteChannel: pulumi.String("string"),
ConfidentialNoteEvents: pulumi.Bool(false),
ConfidentialIssueChannel: pulumi.String("string"),
IssueChannel: pulumi.String("string"),
IssuesEvents: pulumi.Bool(false),
LabelsToBeNotified: pulumi.String("string"),
LabelsToBeNotifiedBehavior: pulumi.String("string"),
MergeRequestChannel: pulumi.String("string"),
BranchesToBeNotified: pulumi.String("string"),
NoteChannel: pulumi.String("string"),
ConfidentialIssuesEvents: pulumi.Bool(false),
PipelineChannel: pulumi.String("string"),
NoteEvents: pulumi.Bool(false),
PipelineEvents: pulumi.Bool(false),
PushChannel: pulumi.String("string"),
PushEvents: pulumi.Bool(false),
TagPushChannel: pulumi.String("string"),
TagPushEvents: pulumi.Bool(false),
UseInheritedSettings: pulumi.Bool(false),
NotifyOnlyBrokenPipelines: pulumi.Bool(false),
Channel: pulumi.String("string"),
WikiPageChannel: pulumi.String("string"),
WikiPageEvents: pulumi.Bool(false),
})
var groupIntegrationMattermostResource = new GroupIntegrationMattermost("groupIntegrationMattermostResource", GroupIntegrationMattermostArgs.builder()
.group("string")
.webhook("string")
.mergeRequestsEvents(false)
.username("string")
.confidentialNoteChannel("string")
.confidentialNoteEvents(false)
.confidentialIssueChannel("string")
.issueChannel("string")
.issuesEvents(false)
.labelsToBeNotified("string")
.labelsToBeNotifiedBehavior("string")
.mergeRequestChannel("string")
.branchesToBeNotified("string")
.noteChannel("string")
.confidentialIssuesEvents(false)
.pipelineChannel("string")
.noteEvents(false)
.pipelineEvents(false)
.pushChannel("string")
.pushEvents(false)
.tagPushChannel("string")
.tagPushEvents(false)
.useInheritedSettings(false)
.notifyOnlyBrokenPipelines(false)
.channel("string")
.wikiPageChannel("string")
.wikiPageEvents(false)
.build());
group_integration_mattermost_resource = gitlab.GroupIntegrationMattermost("groupIntegrationMattermostResource",
group="string",
webhook="string",
merge_requests_events=False,
username="string",
confidential_note_channel="string",
confidential_note_events=False,
confidential_issue_channel="string",
issue_channel="string",
issues_events=False,
labels_to_be_notified="string",
labels_to_be_notified_behavior="string",
merge_request_channel="string",
branches_to_be_notified="string",
note_channel="string",
confidential_issues_events=False,
pipeline_channel="string",
note_events=False,
pipeline_events=False,
push_channel="string",
push_events=False,
tag_push_channel="string",
tag_push_events=False,
use_inherited_settings=False,
notify_only_broken_pipelines=False,
channel="string",
wiki_page_channel="string",
wiki_page_events=False)
const groupIntegrationMattermostResource = new gitlab.GroupIntegrationMattermost("groupIntegrationMattermostResource", {
group: "string",
webhook: "string",
mergeRequestsEvents: false,
username: "string",
confidentialNoteChannel: "string",
confidentialNoteEvents: false,
confidentialIssueChannel: "string",
issueChannel: "string",
issuesEvents: false,
labelsToBeNotified: "string",
labelsToBeNotifiedBehavior: "string",
mergeRequestChannel: "string",
branchesToBeNotified: "string",
noteChannel: "string",
confidentialIssuesEvents: false,
pipelineChannel: "string",
noteEvents: false,
pipelineEvents: false,
pushChannel: "string",
pushEvents: false,
tagPushChannel: "string",
tagPushEvents: false,
useInheritedSettings: false,
notifyOnlyBrokenPipelines: false,
channel: "string",
wikiPageChannel: "string",
wikiPageEvents: false,
});
type: gitlab:GroupIntegrationMattermost
properties:
branchesToBeNotified: string
channel: string
confidentialIssueChannel: string
confidentialIssuesEvents: false
confidentialNoteChannel: string
confidentialNoteEvents: false
group: string
issueChannel: string
issuesEvents: false
labelsToBeNotified: string
labelsToBeNotifiedBehavior: string
mergeRequestChannel: string
mergeRequestsEvents: false
noteChannel: string
noteEvents: false
notifyOnlyBrokenPipelines: false
pipelineChannel: string
pipelineEvents: false
pushChannel: string
pushEvents: false
tagPushChannel: string
tagPushEvents: false
useInheritedSettings: false
username: string
webhook: string
wikiPageChannel: string
wikiPageEvents: false
GroupIntegrationMattermost 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 GroupIntegrationMattermost resource accepts the following input properties:
- Group string
- The ID or full path of the group to integrate with Mattermost.
- Webhook string
- Mattermost notifications webhook (for example, http://mattermost.example.com/hooks/...).
- Branches
To stringBe Notified - Branches to send notifications for. Valid values are
all,default,protected,default_and_protected. - Channel string
- Default channel to use if no other channel is configured.
- Confidential
Issue stringChannel - The name of the channel to receive confidential issue events notifications.
- Confidential
Issues boolEvents - Enable notifications for confidential issues events.
- Confidential
Note stringChannel - The name of the channel to receive confidential note events notifications.
- Confidential
Note boolEvents - Enable notifications for confidential note events.
- Issue
Channel string - The name of the channel to receive issue events notifications.
- Issues
Events bool - Enable notifications for issues events.
- Labels
To stringBe Notified - Labels to send notifications for. Leave blank to receive notifications for all events.
- Labels
To stringBe Notified Behavior - Labels to be notified for. Valid values are
match_any,match_all. - Merge
Request stringChannel - The name of the channel to receive merge request events notifications.
- Merge
Requests boolEvents - Enable notifications for merge requests events.
- Note
Channel string - The name of the channel to receive note events notifications.
- Note
Events bool - Enable notifications for note events.
- Notify
Only boolBroken Pipelines - Send notifications for broken pipelines.
- Pipeline
Channel string - The name of the channel to receive pipeline events notifications.
- Pipeline
Events bool - Enable notifications for pipeline events.
- Push
Channel string - The name of the channel to receive push events notifications.
- Push
Events bool - Enable notifications for push events.
- Tag
Push stringChannel - The name of the channel to receive tag push events notifications.
- Tag
Push boolEvents - Enable notifications for tag push events.
- Use
Inherited boolSettings - Inherit settings from parent group.
- Username string
- Mattermost notifications username.
- Wiki
Page stringChannel - The name of the channel to receive wiki page events notifications.
- Wiki
Page boolEvents - Enable notifications for wiki page events.
- Group string
- The ID or full path of the group to integrate with Mattermost.
- Webhook string
- Mattermost notifications webhook (for example, http://mattermost.example.com/hooks/...).
- Branches
To stringBe Notified - Branches to send notifications for. Valid values are
all,default,protected,default_and_protected. - Channel string
- Default channel to use if no other channel is configured.
- Confidential
Issue stringChannel - The name of the channel to receive confidential issue events notifications.
- Confidential
Issues boolEvents - Enable notifications for confidential issues events.
- Confidential
Note stringChannel - The name of the channel to receive confidential note events notifications.
- Confidential
Note boolEvents - Enable notifications for confidential note events.
- Issue
Channel string - The name of the channel to receive issue events notifications.
- Issues
Events bool - Enable notifications for issues events.
- Labels
To stringBe Notified - Labels to send notifications for. Leave blank to receive notifications for all events.
- Labels
To stringBe Notified Behavior - Labels to be notified for. Valid values are
match_any,match_all. - Merge
Request stringChannel - The name of the channel to receive merge request events notifications.
- Merge
Requests boolEvents - Enable notifications for merge requests events.
- Note
Channel string - The name of the channel to receive note events notifications.
- Note
Events bool - Enable notifications for note events.
- Notify
Only boolBroken Pipelines - Send notifications for broken pipelines.
- Pipeline
Channel string - The name of the channel to receive pipeline events notifications.
- Pipeline
Events bool - Enable notifications for pipeline events.
- Push
Channel string - The name of the channel to receive push events notifications.
- Push
Events bool - Enable notifications for push events.
- Tag
Push stringChannel - The name of the channel to receive tag push events notifications.
- Tag
Push boolEvents - Enable notifications for tag push events.
- Use
Inherited boolSettings - Inherit settings from parent group.
- Username string
- Mattermost notifications username.
- Wiki
Page stringChannel - The name of the channel to receive wiki page events notifications.
- Wiki
Page boolEvents - Enable notifications for wiki page events.
- group String
- The ID or full path of the group to integrate with Mattermost.
- webhook String
- Mattermost notifications webhook (for example, http://mattermost.example.com/hooks/...).
- branches
To StringBe Notified - Branches to send notifications for. Valid values are
all,default,protected,default_and_protected. - channel String
- Default channel to use if no other channel is configured.
- confidential
Issue StringChannel - The name of the channel to receive confidential issue events notifications.
- confidential
Issues BooleanEvents - Enable notifications for confidential issues events.
- confidential
Note StringChannel - The name of the channel to receive confidential note events notifications.
- confidential
Note BooleanEvents - Enable notifications for confidential note events.
- issue
Channel String - The name of the channel to receive issue events notifications.
- issues
Events Boolean - Enable notifications for issues events.
- labels
To StringBe Notified - Labels to send notifications for. Leave blank to receive notifications for all events.
- labels
To StringBe Notified Behavior - Labels to be notified for. Valid values are
match_any,match_all. - merge
Request StringChannel - The name of the channel to receive merge request events notifications.
- merge
Requests BooleanEvents - Enable notifications for merge requests events.
- note
Channel String - The name of the channel to receive note events notifications.
- note
Events Boolean - Enable notifications for note events.
- notify
Only BooleanBroken Pipelines - Send notifications for broken pipelines.
- pipeline
Channel String - The name of the channel to receive pipeline events notifications.
- pipeline
Events Boolean - Enable notifications for pipeline events.
- push
Channel String - The name of the channel to receive push events notifications.
- push
Events Boolean - Enable notifications for push events.
- tag
Push StringChannel - The name of the channel to receive tag push events notifications.
- tag
Push BooleanEvents - Enable notifications for tag push events.
- use
Inherited BooleanSettings - Inherit settings from parent group.
- username String
- Mattermost notifications username.
- wiki
Page StringChannel - The name of the channel to receive wiki page events notifications.
- wiki
Page BooleanEvents - Enable notifications for wiki page events.
- group string
- The ID or full path of the group to integrate with Mattermost.
- webhook string
- Mattermost notifications webhook (for example, http://mattermost.example.com/hooks/...).
- branches
To stringBe Notified - Branches to send notifications for. Valid values are
all,default,protected,default_and_protected. - channel string
- Default channel to use if no other channel is configured.
- confidential
Issue stringChannel - The name of the channel to receive confidential issue events notifications.
- confidential
Issues booleanEvents - Enable notifications for confidential issues events.
- confidential
Note stringChannel - The name of the channel to receive confidential note events notifications.
- confidential
Note booleanEvents - Enable notifications for confidential note events.
- issue
Channel string - The name of the channel to receive issue events notifications.
- issues
Events boolean - Enable notifications for issues events.
- labels
To stringBe Notified - Labels to send notifications for. Leave blank to receive notifications for all events.
- labels
To stringBe Notified Behavior - Labels to be notified for. Valid values are
match_any,match_all. - merge
Request stringChannel - The name of the channel to receive merge request events notifications.
- merge
Requests booleanEvents - Enable notifications for merge requests events.
- note
Channel string - The name of the channel to receive note events notifications.
- note
Events boolean - Enable notifications for note events.
- notify
Only booleanBroken Pipelines - Send notifications for broken pipelines.
- pipeline
Channel string - The name of the channel to receive pipeline events notifications.
- pipeline
Events boolean - Enable notifications for pipeline events.
- push
Channel string - The name of the channel to receive push events notifications.
- push
Events boolean - Enable notifications for push events.
- tag
Push stringChannel - The name of the channel to receive tag push events notifications.
- tag
Push booleanEvents - Enable notifications for tag push events.
- use
Inherited booleanSettings - Inherit settings from parent group.
- username string
- Mattermost notifications username.
- wiki
Page stringChannel - The name of the channel to receive wiki page events notifications.
- wiki
Page booleanEvents - Enable notifications for wiki page events.
- group str
- The ID or full path of the group to integrate with Mattermost.
- webhook str
- Mattermost notifications webhook (for example, http://mattermost.example.com/hooks/...).
- branches_
to_ strbe_ notified - Branches to send notifications for. Valid values are
all,default,protected,default_and_protected. - channel str
- Default channel to use if no other channel is configured.
- confidential_
issue_ strchannel - The name of the channel to receive confidential issue events notifications.
- confidential_
issues_ boolevents - Enable notifications for confidential issues events.
- confidential_
note_ strchannel - The name of the channel to receive confidential note events notifications.
- confidential_
note_ boolevents - Enable notifications for confidential note events.
- issue_
channel str - The name of the channel to receive issue events notifications.
- issues_
events bool - Enable notifications for issues events.
- labels_
to_ strbe_ notified - Labels to send notifications for. Leave blank to receive notifications for all events.
- labels_
to_ strbe_ notified_ behavior - Labels to be notified for. Valid values are
match_any,match_all. - merge_
request_ strchannel - The name of the channel to receive merge request events notifications.
- merge_
requests_ boolevents - Enable notifications for merge requests events.
- note_
channel str - The name of the channel to receive note events notifications.
- note_
events bool - Enable notifications for note events.
- notify_
only_ boolbroken_ pipelines - Send notifications for broken pipelines.
- pipeline_
channel str - The name of the channel to receive pipeline events notifications.
- pipeline_
events bool - Enable notifications for pipeline events.
- push_
channel str - The name of the channel to receive push events notifications.
- push_
events bool - Enable notifications for push events.
- tag_
push_ strchannel - The name of the channel to receive tag push events notifications.
- tag_
push_ boolevents - Enable notifications for tag push events.
- use_
inherited_ boolsettings - Inherit settings from parent group.
- username str
- Mattermost notifications username.
- wiki_
page_ strchannel - The name of the channel to receive wiki page events notifications.
- wiki_
page_ boolevents - Enable notifications for wiki page events.
- group String
- The ID or full path of the group to integrate with Mattermost.
- webhook String
- Mattermost notifications webhook (for example, http://mattermost.example.com/hooks/...).
- branches
To StringBe Notified - Branches to send notifications for. Valid values are
all,default,protected,default_and_protected. - channel String
- Default channel to use if no other channel is configured.
- confidential
Issue StringChannel - The name of the channel to receive confidential issue events notifications.
- confidential
Issues BooleanEvents - Enable notifications for confidential issues events.
- confidential
Note StringChannel - The name of the channel to receive confidential note events notifications.
- confidential
Note BooleanEvents - Enable notifications for confidential note events.
- issue
Channel String - The name of the channel to receive issue events notifications.
- issues
Events Boolean - Enable notifications for issues events.
- labels
To StringBe Notified - Labels to send notifications for. Leave blank to receive notifications for all events.
- labels
To StringBe Notified Behavior - Labels to be notified for. Valid values are
match_any,match_all. - merge
Request StringChannel - The name of the channel to receive merge request events notifications.
- merge
Requests BooleanEvents - Enable notifications for merge requests events.
- note
Channel String - The name of the channel to receive note events notifications.
- note
Events Boolean - Enable notifications for note events.
- notify
Only BooleanBroken Pipelines - Send notifications for broken pipelines.
- pipeline
Channel String - The name of the channel to receive pipeline events notifications.
- pipeline
Events Boolean - Enable notifications for pipeline events.
- push
Channel String - The name of the channel to receive push events notifications.
- push
Events Boolean - Enable notifications for push events.
- tag
Push StringChannel - The name of the channel to receive tag push events notifications.
- tag
Push BooleanEvents - Enable notifications for tag push events.
- use
Inherited BooleanSettings - Inherit settings from parent group.
- username String
- Mattermost notifications username.
- wiki
Page StringChannel - The name of the channel to receive wiki page events notifications.
- wiki
Page BooleanEvents - Enable notifications for wiki page events.
Outputs
All input properties are implicitly available as output properties. Additionally, the GroupIntegrationMattermost 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 GroupIntegrationMattermost Resource
Get an existing GroupIntegrationMattermost 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?: GroupIntegrationMattermostState, opts?: CustomResourceOptions): GroupIntegrationMattermost@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
branches_to_be_notified: Optional[str] = None,
channel: Optional[str] = None,
confidential_issue_channel: Optional[str] = None,
confidential_issues_events: Optional[bool] = None,
confidential_note_channel: Optional[str] = None,
confidential_note_events: Optional[bool] = None,
group: Optional[str] = None,
issue_channel: Optional[str] = None,
issues_events: Optional[bool] = None,
labels_to_be_notified: Optional[str] = None,
labels_to_be_notified_behavior: Optional[str] = None,
merge_request_channel: Optional[str] = None,
merge_requests_events: Optional[bool] = None,
note_channel: Optional[str] = None,
note_events: Optional[bool] = None,
notify_only_broken_pipelines: Optional[bool] = None,
pipeline_channel: Optional[str] = None,
pipeline_events: Optional[bool] = None,
push_channel: Optional[str] = None,
push_events: Optional[bool] = None,
tag_push_channel: Optional[str] = None,
tag_push_events: Optional[bool] = None,
use_inherited_settings: Optional[bool] = None,
username: Optional[str] = None,
webhook: Optional[str] = None,
wiki_page_channel: Optional[str] = None,
wiki_page_events: Optional[bool] = None) -> GroupIntegrationMattermostfunc GetGroupIntegrationMattermost(ctx *Context, name string, id IDInput, state *GroupIntegrationMattermostState, opts ...ResourceOption) (*GroupIntegrationMattermost, error)public static GroupIntegrationMattermost Get(string name, Input<string> id, GroupIntegrationMattermostState? state, CustomResourceOptions? opts = null)public static GroupIntegrationMattermost get(String name, Output<String> id, GroupIntegrationMattermostState state, CustomResourceOptions options)resources: _: type: gitlab:GroupIntegrationMattermost 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.
- Branches
To stringBe Notified - Branches to send notifications for. Valid values are
all,default,protected,default_and_protected. - Channel string
- Default channel to use if no other channel is configured.
- Confidential
Issue stringChannel - The name of the channel to receive confidential issue events notifications.
- Confidential
Issues boolEvents - Enable notifications for confidential issues events.
- Confidential
Note stringChannel - The name of the channel to receive confidential note events notifications.
- Confidential
Note boolEvents - Enable notifications for confidential note events.
- Group string
- The ID or full path of the group to integrate with Mattermost.
- Issue
Channel string - The name of the channel to receive issue events notifications.
- Issues
Events bool - Enable notifications for issues events.
- Labels
To stringBe Notified - Labels to send notifications for. Leave blank to receive notifications for all events.
- Labels
To stringBe Notified Behavior - Labels to be notified for. Valid values are
match_any,match_all. - Merge
Request stringChannel - The name of the channel to receive merge request events notifications.
- Merge
Requests boolEvents - Enable notifications for merge requests events.
- Note
Channel string - The name of the channel to receive note events notifications.
- Note
Events bool - Enable notifications for note events.
- Notify
Only boolBroken Pipelines - Send notifications for broken pipelines.
- Pipeline
Channel string - The name of the channel to receive pipeline events notifications.
- Pipeline
Events bool - Enable notifications for pipeline events.
- Push
Channel string - The name of the channel to receive push events notifications.
- Push
Events bool - Enable notifications for push events.
- Tag
Push stringChannel - The name of the channel to receive tag push events notifications.
- Tag
Push boolEvents - Enable notifications for tag push events.
- Use
Inherited boolSettings - Inherit settings from parent group.
- Username string
- Mattermost notifications username.
- Webhook string
- Mattermost notifications webhook (for example, http://mattermost.example.com/hooks/...).
- Wiki
Page stringChannel - The name of the channel to receive wiki page events notifications.
- Wiki
Page boolEvents - Enable notifications for wiki page events.
- Branches
To stringBe Notified - Branches to send notifications for. Valid values are
all,default,protected,default_and_protected. - Channel string
- Default channel to use if no other channel is configured.
- Confidential
Issue stringChannel - The name of the channel to receive confidential issue events notifications.
- Confidential
Issues boolEvents - Enable notifications for confidential issues events.
- Confidential
Note stringChannel - The name of the channel to receive confidential note events notifications.
- Confidential
Note boolEvents - Enable notifications for confidential note events.
- Group string
- The ID or full path of the group to integrate with Mattermost.
- Issue
Channel string - The name of the channel to receive issue events notifications.
- Issues
Events bool - Enable notifications for issues events.
- Labels
To stringBe Notified - Labels to send notifications for. Leave blank to receive notifications for all events.
- Labels
To stringBe Notified Behavior - Labels to be notified for. Valid values are
match_any,match_all. - Merge
Request stringChannel - The name of the channel to receive merge request events notifications.
- Merge
Requests boolEvents - Enable notifications for merge requests events.
- Note
Channel string - The name of the channel to receive note events notifications.
- Note
Events bool - Enable notifications for note events.
- Notify
Only boolBroken Pipelines - Send notifications for broken pipelines.
- Pipeline
Channel string - The name of the channel to receive pipeline events notifications.
- Pipeline
Events bool - Enable notifications for pipeline events.
- Push
Channel string - The name of the channel to receive push events notifications.
- Push
Events bool - Enable notifications for push events.
- Tag
Push stringChannel - The name of the channel to receive tag push events notifications.
- Tag
Push boolEvents - Enable notifications for tag push events.
- Use
Inherited boolSettings - Inherit settings from parent group.
- Username string
- Mattermost notifications username.
- Webhook string
- Mattermost notifications webhook (for example, http://mattermost.example.com/hooks/...).
- Wiki
Page stringChannel - The name of the channel to receive wiki page events notifications.
- Wiki
Page boolEvents - Enable notifications for wiki page events.
- branches
To StringBe Notified - Branches to send notifications for. Valid values are
all,default,protected,default_and_protected. - channel String
- Default channel to use if no other channel is configured.
- confidential
Issue StringChannel - The name of the channel to receive confidential issue events notifications.
- confidential
Issues BooleanEvents - Enable notifications for confidential issues events.
- confidential
Note StringChannel - The name of the channel to receive confidential note events notifications.
- confidential
Note BooleanEvents - Enable notifications for confidential note events.
- group String
- The ID or full path of the group to integrate with Mattermost.
- issue
Channel String - The name of the channel to receive issue events notifications.
- issues
Events Boolean - Enable notifications for issues events.
- labels
To StringBe Notified - Labels to send notifications for. Leave blank to receive notifications for all events.
- labels
To StringBe Notified Behavior - Labels to be notified for. Valid values are
match_any,match_all. - merge
Request StringChannel - The name of the channel to receive merge request events notifications.
- merge
Requests BooleanEvents - Enable notifications for merge requests events.
- note
Channel String - The name of the channel to receive note events notifications.
- note
Events Boolean - Enable notifications for note events.
- notify
Only BooleanBroken Pipelines - Send notifications for broken pipelines.
- pipeline
Channel String - The name of the channel to receive pipeline events notifications.
- pipeline
Events Boolean - Enable notifications for pipeline events.
- push
Channel String - The name of the channel to receive push events notifications.
- push
Events Boolean - Enable notifications for push events.
- tag
Push StringChannel - The name of the channel to receive tag push events notifications.
- tag
Push BooleanEvents - Enable notifications for tag push events.
- use
Inherited BooleanSettings - Inherit settings from parent group.
- username String
- Mattermost notifications username.
- webhook String
- Mattermost notifications webhook (for example, http://mattermost.example.com/hooks/...).
- wiki
Page StringChannel - The name of the channel to receive wiki page events notifications.
- wiki
Page BooleanEvents - Enable notifications for wiki page events.
- branches
To stringBe Notified - Branches to send notifications for. Valid values are
all,default,protected,default_and_protected. - channel string
- Default channel to use if no other channel is configured.
- confidential
Issue stringChannel - The name of the channel to receive confidential issue events notifications.
- confidential
Issues booleanEvents - Enable notifications for confidential issues events.
- confidential
Note stringChannel - The name of the channel to receive confidential note events notifications.
- confidential
Note booleanEvents - Enable notifications for confidential note events.
- group string
- The ID or full path of the group to integrate with Mattermost.
- issue
Channel string - The name of the channel to receive issue events notifications.
- issues
Events boolean - Enable notifications for issues events.
- labels
To stringBe Notified - Labels to send notifications for. Leave blank to receive notifications for all events.
- labels
To stringBe Notified Behavior - Labels to be notified for. Valid values are
match_any,match_all. - merge
Request stringChannel - The name of the channel to receive merge request events notifications.
- merge
Requests booleanEvents - Enable notifications for merge requests events.
- note
Channel string - The name of the channel to receive note events notifications.
- note
Events boolean - Enable notifications for note events.
- notify
Only booleanBroken Pipelines - Send notifications for broken pipelines.
- pipeline
Channel string - The name of the channel to receive pipeline events notifications.
- pipeline
Events boolean - Enable notifications for pipeline events.
- push
Channel string - The name of the channel to receive push events notifications.
- push
Events boolean - Enable notifications for push events.
- tag
Push stringChannel - The name of the channel to receive tag push events notifications.
- tag
Push booleanEvents - Enable notifications for tag push events.
- use
Inherited booleanSettings - Inherit settings from parent group.
- username string
- Mattermost notifications username.
- webhook string
- Mattermost notifications webhook (for example, http://mattermost.example.com/hooks/...).
- wiki
Page stringChannel - The name of the channel to receive wiki page events notifications.
- wiki
Page booleanEvents - Enable notifications for wiki page events.
- branches_
to_ strbe_ notified - Branches to send notifications for. Valid values are
all,default,protected,default_and_protected. - channel str
- Default channel to use if no other channel is configured.
- confidential_
issue_ strchannel - The name of the channel to receive confidential issue events notifications.
- confidential_
issues_ boolevents - Enable notifications for confidential issues events.
- confidential_
note_ strchannel - The name of the channel to receive confidential note events notifications.
- confidential_
note_ boolevents - Enable notifications for confidential note events.
- group str
- The ID or full path of the group to integrate with Mattermost.
- issue_
channel str - The name of the channel to receive issue events notifications.
- issues_
events bool - Enable notifications for issues events.
- labels_
to_ strbe_ notified - Labels to send notifications for. Leave blank to receive notifications for all events.
- labels_
to_ strbe_ notified_ behavior - Labels to be notified for. Valid values are
match_any,match_all. - merge_
request_ strchannel - The name of the channel to receive merge request events notifications.
- merge_
requests_ boolevents - Enable notifications for merge requests events.
- note_
channel str - The name of the channel to receive note events notifications.
- note_
events bool - Enable notifications for note events.
- notify_
only_ boolbroken_ pipelines - Send notifications for broken pipelines.
- pipeline_
channel str - The name of the channel to receive pipeline events notifications.
- pipeline_
events bool - Enable notifications for pipeline events.
- push_
channel str - The name of the channel to receive push events notifications.
- push_
events bool - Enable notifications for push events.
- tag_
push_ strchannel - The name of the channel to receive tag push events notifications.
- tag_
push_ boolevents - Enable notifications for tag push events.
- use_
inherited_ boolsettings - Inherit settings from parent group.
- username str
- Mattermost notifications username.
- webhook str
- Mattermost notifications webhook (for example, http://mattermost.example.com/hooks/...).
- wiki_
page_ strchannel - The name of the channel to receive wiki page events notifications.
- wiki_
page_ boolevents - Enable notifications for wiki page events.
- branches
To StringBe Notified - Branches to send notifications for. Valid values are
all,default,protected,default_and_protected. - channel String
- Default channel to use if no other channel is configured.
- confidential
Issue StringChannel - The name of the channel to receive confidential issue events notifications.
- confidential
Issues BooleanEvents - Enable notifications for confidential issues events.
- confidential
Note StringChannel - The name of the channel to receive confidential note events notifications.
- confidential
Note BooleanEvents - Enable notifications for confidential note events.
- group String
- The ID or full path of the group to integrate with Mattermost.
- issue
Channel String - The name of the channel to receive issue events notifications.
- issues
Events Boolean - Enable notifications for issues events.
- labels
To StringBe Notified - Labels to send notifications for. Leave blank to receive notifications for all events.
- labels
To StringBe Notified Behavior - Labels to be notified for. Valid values are
match_any,match_all. - merge
Request StringChannel - The name of the channel to receive merge request events notifications.
- merge
Requests BooleanEvents - Enable notifications for merge requests events.
- note
Channel String - The name of the channel to receive note events notifications.
- note
Events Boolean - Enable notifications for note events.
- notify
Only BooleanBroken Pipelines - Send notifications for broken pipelines.
- pipeline
Channel String - The name of the channel to receive pipeline events notifications.
- pipeline
Events Boolean - Enable notifications for pipeline events.
- push
Channel String - The name of the channel to receive push events notifications.
- push
Events Boolean - Enable notifications for push events.
- tag
Push StringChannel - The name of the channel to receive tag push events notifications.
- tag
Push BooleanEvents - Enable notifications for tag push events.
- use
Inherited BooleanSettings - Inherit settings from parent group.
- username String
- Mattermost notifications username.
- webhook String
- Mattermost notifications webhook (for example, http://mattermost.example.com/hooks/...).
- wiki
Page StringChannel - The name of the channel to receive wiki page events notifications.
- wiki
Page BooleanEvents - Enable notifications for wiki page events.
Import
Starting in Terraform v1.5.0, you can use an import block to import gitlab_group_integration_mattermost. For example:
terraform
import {
to = gitlab_group_integration_mattermost.example
id = “see CLI command below for ID”
}
Importing using the CLI is supported with the following syntax:
GitLab group Mattermost integrations can be imported using the group ID, e.g.
$ pulumi import gitlab:index/groupIntegrationMattermost:GroupIntegrationMattermost mattermost 12345
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
gitlabTerraform Provider.
