`integrationMattermost` Submodule

Constructs

IntegrationMattermost

Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost gitlab_integration_mattermost}.

Initializers

import { integrationMattermost } from '@cdktf/provider-gitlab'

new integrationMattermost.IntegrationMattermost(scope: Construct, id: string, config: IntegrationMattermostConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`IntegrationMattermostConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: IntegrationMattermostConfig

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to "id" to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to "id".
`resetBranchesToBeNotified`	No description.
`resetConfidentialIssueChannel`	No description.
`resetConfidentialIssuesEvents`	No description.
`resetConfidentialNoteChannel`	No description.
`resetConfidentialNoteEvents`	No description.
`resetId`	No description.
`resetIssueChannel`	No description.
`resetIssuesEvents`	No description.
`resetMergeRequestChannel`	No description.
`resetMergeRequestsEvents`	No description.
`resetNoteChannel`	No description.
`resetNoteEvents`	No description.
`resetNotifyOnlyBrokenPipelines`	No description.
`resetPipelineChannel`	No description.
`resetPipelineEvents`	No description.
`resetPushChannel`	No description.
`resetPushEvents`	No description.
`resetTagPushChannel`	No description.
`resetTagPushEvents`	No description.
`resetUsername`	No description.
`resetWikiPageChannel`	No description.
`resetWikiPageEvents`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`moveToId`

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`resetBranchesToBeNotified`

public resetBranchesToBeNotified(): void

`resetConfidentialIssueChannel`

public resetConfidentialIssueChannel(): void

`resetConfidentialIssuesEvents`

public resetConfidentialIssuesEvents(): void

`resetConfidentialNoteChannel`

public resetConfidentialNoteChannel(): void

`resetConfidentialNoteEvents`

public resetConfidentialNoteEvents(): void

`resetId`

public resetId(): void

`resetIssueChannel`

public resetIssueChannel(): void

`resetIssuesEvents`

public resetIssuesEvents(): void

`resetMergeRequestChannel`

public resetMergeRequestChannel(): void

`resetMergeRequestsEvents`

public resetMergeRequestsEvents(): void

`resetNoteChannel`

public resetNoteChannel(): void

`resetNoteEvents`

public resetNoteEvents(): void

`resetNotifyOnlyBrokenPipelines`

public resetNotifyOnlyBrokenPipelines(): void

`resetPipelineChannel`

public resetPipelineChannel(): void

`resetPipelineEvents`

public resetPipelineEvents(): void

`resetPushChannel`

public resetPushChannel(): void

`resetPushEvents`

public resetPushEvents(): void

`resetTagPushChannel`

public resetTagPushChannel(): void

`resetTagPushEvents`

public resetTagPushEvents(): void

`resetUsername`

public resetUsername(): void

`resetWikiPageChannel`

public resetWikiPageChannel(): void

`resetWikiPageEvents`

public resetWikiPageEvents(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a IntegrationMattermost resource upon running "cdktf plan ".

`isConstruct`

import { integrationMattermost } from '@cdktf/provider-gitlab'

integrationMattermost.IntegrationMattermost.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { integrationMattermost } from '@cdktf/provider-gitlab'

integrationMattermost.IntegrationMattermost.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { integrationMattermost } from '@cdktf/provider-gitlab'

integrationMattermost.IntegrationMattermost.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { integrationMattermost } from '@cdktf/provider-gitlab'

integrationMattermost.IntegrationMattermost.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a IntegrationMattermost resource upon running "cdktf plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

The construct id used in the generated config for the IntegrationMattermost to import.

`importFromId`^Required

Type: string

The id of the existing IntegrationMattermost that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the IntegrationMattermost to import is found.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktf.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`branchesToBeNotifiedInput`	`string`	No description.
`confidentialIssueChannelInput`	`string`	No description.
`confidentialIssuesEventsInput`	`boolean \| cdktf.IResolvable`	No description.
`confidentialNoteChannelInput`	`string`	No description.
`confidentialNoteEventsInput`	`boolean \| cdktf.IResolvable`	No description.
`idInput`	`string`	No description.
`issueChannelInput`	`string`	No description.
`issuesEventsInput`	`boolean \| cdktf.IResolvable`	No description.
`mergeRequestChannelInput`	`string`	No description.
`mergeRequestsEventsInput`	`boolean \| cdktf.IResolvable`	No description.
`noteChannelInput`	`string`	No description.
`noteEventsInput`	`boolean \| cdktf.IResolvable`	No description.
`notifyOnlyBrokenPipelinesInput`	`boolean \| cdktf.IResolvable`	No description.
`pipelineChannelInput`	`string`	No description.
`pipelineEventsInput`	`boolean \| cdktf.IResolvable`	No description.
`projectInput`	`string`	No description.
`pushChannelInput`	`string`	No description.
`pushEventsInput`	`boolean \| cdktf.IResolvable`	No description.
`tagPushChannelInput`	`string`	No description.
`tagPushEventsInput`	`boolean \| cdktf.IResolvable`	No description.
`usernameInput`	`string`	No description.
`webhookInput`	`string`	No description.
`wikiPageChannelInput`	`string`	No description.
`wikiPageEventsInput`	`boolean \| cdktf.IResolvable`	No description.
`branchesToBeNotified`	`string`	No description.
`confidentialIssueChannel`	`string`	No description.
`confidentialIssuesEvents`	`boolean \| cdktf.IResolvable`	No description.
`confidentialNoteChannel`	`string`	No description.
`confidentialNoteEvents`	`boolean \| cdktf.IResolvable`	No description.
`id`	`string`	No description.
`issueChannel`	`string`	No description.
`issuesEvents`	`boolean \| cdktf.IResolvable`	No description.
`mergeRequestChannel`	`string`	No description.
`mergeRequestsEvents`	`boolean \| cdktf.IResolvable`	No description.
`noteChannel`	`string`	No description.
`noteEvents`	`boolean \| cdktf.IResolvable`	No description.
`notifyOnlyBrokenPipelines`	`boolean \| cdktf.IResolvable`	No description.
`pipelineChannel`	`string`	No description.
`pipelineEvents`	`boolean \| cdktf.IResolvable`	No description.
`project`	`string`	No description.
`pushChannel`	`string`	No description.
`pushEvents`	`boolean \| cdktf.IResolvable`	No description.
`tagPushChannel`	`string`	No description.
`tagPushEvents`	`boolean \| cdktf.IResolvable`	No description.
`username`	`string`	No description.
`webhook`	`string`	No description.
`wikiPageChannel`	`string`	No description.
`wikiPageEvents`	`boolean \| cdktf.IResolvable`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`branchesToBeNotifiedInput`^Optional

public readonly branchesToBeNotifiedInput: string;

Type: string

`confidentialIssueChannelInput`^Optional

public readonly confidentialIssueChannelInput: string;

Type: string

`confidentialIssuesEventsInput`^Optional

public readonly confidentialIssuesEventsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`confidentialNoteChannelInput`^Optional

public readonly confidentialNoteChannelInput: string;

Type: string

`confidentialNoteEventsInput`^Optional

public readonly confidentialNoteEventsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`idInput`^Optional

public readonly idInput: string;

Type: string

`issueChannelInput`^Optional

public readonly issueChannelInput: string;

Type: string

`issuesEventsInput`^Optional

public readonly issuesEventsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`mergeRequestChannelInput`^Optional

public readonly mergeRequestChannelInput: string;

Type: string

`mergeRequestsEventsInput`^Optional

public readonly mergeRequestsEventsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`noteChannelInput`^Optional

public readonly noteChannelInput: string;

Type: string

`noteEventsInput`^Optional

public readonly noteEventsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`notifyOnlyBrokenPipelinesInput`^Optional

public readonly notifyOnlyBrokenPipelinesInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`pipelineChannelInput`^Optional

public readonly pipelineChannelInput: string;

Type: string

`pipelineEventsInput`^Optional

public readonly pipelineEventsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`pushChannelInput`^Optional

public readonly pushChannelInput: string;

Type: string

`pushEventsInput`^Optional

public readonly pushEventsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`tagPushChannelInput`^Optional

public readonly tagPushChannelInput: string;

Type: string

`tagPushEventsInput`^Optional

public readonly tagPushEventsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`usernameInput`^Optional

public readonly usernameInput: string;

Type: string

`webhookInput`^Optional

public readonly webhookInput: string;

Type: string

`wikiPageChannelInput`^Optional

public readonly wikiPageChannelInput: string;

Type: string

`wikiPageEventsInput`^Optional

public readonly wikiPageEventsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`branchesToBeNotified`^Required

public readonly branchesToBeNotified: string;

Type: string

`confidentialIssueChannel`^Required

public readonly confidentialIssueChannel: string;

Type: string

`confidentialIssuesEvents`^Required

public readonly confidentialIssuesEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`confidentialNoteChannel`^Required

public readonly confidentialNoteChannel: string;

Type: string

`confidentialNoteEvents`^Required

public readonly confidentialNoteEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`id`^Required

public readonly id: string;

Type: string

`issueChannel`^Required

public readonly issueChannel: string;

Type: string

`issuesEvents`^Required

public readonly issuesEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`mergeRequestChannel`^Required

public readonly mergeRequestChannel: string;

Type: string

`mergeRequestsEvents`^Required

public readonly mergeRequestsEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`noteChannel`^Required

public readonly noteChannel: string;

Type: string

`noteEvents`^Required

public readonly noteEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`notifyOnlyBrokenPipelines`^Required

public readonly notifyOnlyBrokenPipelines: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`pipelineChannel`^Required

public readonly pipelineChannel: string;

Type: string

`pipelineEvents`^Required

public readonly pipelineEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`project`^Required

public readonly project: string;

Type: string

`pushChannel`^Required

public readonly pushChannel: string;

Type: string

`pushEvents`^Required

public readonly pushEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`tagPushChannel`^Required

public readonly tagPushChannel: string;

Type: string

`tagPushEvents`^Required

public readonly tagPushEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`username`^Required

public readonly username: string;

Type: string

`webhook`^Required

public readonly webhook: string;

Type: string

`wikiPageChannel`^Required

public readonly wikiPageChannel: string;

Type: string

`wikiPageEvents`^Required

public readonly wikiPageEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

IntegrationMattermostConfig

Initializer

import { integrationMattermost } from '@cdktf/provider-gitlab'

const integrationMattermostConfig: integrationMattermost.IntegrationMattermostConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`cdktf.ITerraformDependable[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`project`	`string`	ID of the project you want to activate integration on.
`webhook`	`string`	Webhook URL (Example, https://mattermost.yourdomain.com/hooks/...). This value cannot be imported.
`branchesToBeNotified`	`string`	Branches to send notifications for. Valid options are "all", "default", "protected", and "default_and_protected".
`confidentialIssueChannel`	`string`	The name of the channel to receive confidential issue events notifications.
`confidentialIssuesEvents`	`boolean \| cdktf.IResolvable`	Enable notifications for confidential issues events.
`confidentialNoteChannel`	`string`	The name of the channel to receive confidential note events notifications.
`confidentialNoteEvents`	`boolean \| cdktf.IResolvable`	Enable notifications for confidential note events.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#id IntegrationMattermost#id}.
`issueChannel`	`string`	The name of the channel to receive issue events notifications.
`issuesEvents`	`boolean \| cdktf.IResolvable`	Enable notifications for issues events.
`mergeRequestChannel`	`string`	The name of the channel to receive merge request events notifications.
`mergeRequestsEvents`	`boolean \| cdktf.IResolvable`	Enable notifications for merge requests events.
`noteChannel`	`string`	The name of the channel to receive note events notifications.
`noteEvents`	`boolean \| cdktf.IResolvable`	Enable notifications for note events.
`notifyOnlyBrokenPipelines`	`boolean \| cdktf.IResolvable`	Send notifications for broken pipelines.
`pipelineChannel`	`string`	The name of the channel to receive pipeline events notifications.
`pipelineEvents`	`boolean \| cdktf.IResolvable`	Enable notifications for pipeline events.
`pushChannel`	`string`	The name of the channel to receive push events notifications.
`pushEvents`	`boolean \| cdktf.IResolvable`	Enable notifications for push events.
`tagPushChannel`	`string`	The name of the channel to receive tag push events notifications.
`tagPushEvents`	`boolean \| cdktf.IResolvable`	Enable notifications for tag push events.
`username`	`string`	Username to use.
`wikiPageChannel`	`string`	The name of the channel to receive wiki page events notifications.
`wikiPageEvents`	`boolean \| cdktf.IResolvable`	Enable notifications for wiki page events.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`project`^Required

public readonly project: string;

Type: string

ID of the project you want to activate integration on.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#project IntegrationMattermost#project}

`webhook`^Required

public readonly webhook: string;

Type: string

Webhook URL (Example, https://mattermost.yourdomain.com/hooks/...). This value cannot be imported.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#webhook IntegrationMattermost#webhook}

`branchesToBeNotified`^Optional

public readonly branchesToBeNotified: string;

Type: string

Branches to send notifications for. Valid options are "all", "default", "protected", and "default_and_protected".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#branches_to_be_notified IntegrationMattermost#branches_to_be_notified}

`confidentialIssueChannel`^Optional

public readonly confidentialIssueChannel: string;

Type: string

The name of the channel to receive confidential issue events notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#confidential_issue_channel IntegrationMattermost#confidential_issue_channel}

`confidentialIssuesEvents`^Optional

public readonly confidentialIssuesEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Enable notifications for confidential issues events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#confidential_issues_events IntegrationMattermost#confidential_issues_events}

`confidentialNoteChannel`^Optional

public readonly confidentialNoteChannel: string;

Type: string

The name of the channel to receive confidential note events notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#confidential_note_channel IntegrationMattermost#confidential_note_channel}

`confidentialNoteEvents`^Optional

public readonly confidentialNoteEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Enable notifications for confidential note events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#confidential_note_events IntegrationMattermost#confidential_note_events}

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#id IntegrationMattermost#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`issueChannel`^Optional

public readonly issueChannel: string;

Type: string

The name of the channel to receive issue events notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#issue_channel IntegrationMattermost#issue_channel}

`issuesEvents`^Optional

public readonly issuesEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Enable notifications for issues events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#issues_events IntegrationMattermost#issues_events}

`mergeRequestChannel`^Optional

public readonly mergeRequestChannel: string;

Type: string

The name of the channel to receive merge request events notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#merge_request_channel IntegrationMattermost#merge_request_channel}

`mergeRequestsEvents`^Optional

public readonly mergeRequestsEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Enable notifications for merge requests events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#merge_requests_events IntegrationMattermost#merge_requests_events}

`noteChannel`^Optional

public readonly noteChannel: string;

Type: string

The name of the channel to receive note events notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#note_channel IntegrationMattermost#note_channel}

`noteEvents`^Optional

public readonly noteEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Enable notifications for note events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#note_events IntegrationMattermost#note_events}

`notifyOnlyBrokenPipelines`^Optional

public readonly notifyOnlyBrokenPipelines: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Send notifications for broken pipelines.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#notify_only_broken_pipelines IntegrationMattermost#notify_only_broken_pipelines}

`pipelineChannel`^Optional

public readonly pipelineChannel: string;

Type: string

The name of the channel to receive pipeline events notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#pipeline_channel IntegrationMattermost#pipeline_channel}

`pipelineEvents`^Optional

public readonly pipelineEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Enable notifications for pipeline events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#pipeline_events IntegrationMattermost#pipeline_events}

`pushChannel`^Optional

public readonly pushChannel: string;

Type: string

The name of the channel to receive push events notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#push_channel IntegrationMattermost#push_channel}

`pushEvents`^Optional

public readonly pushEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Enable notifications for push events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#push_events IntegrationMattermost#push_events}

`tagPushChannel`^Optional

public readonly tagPushChannel: string;

Type: string

The name of the channel to receive tag push events notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#tag_push_channel IntegrationMattermost#tag_push_channel}

`tagPushEvents`^Optional

public readonly tagPushEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Enable notifications for tag push events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#tag_push_events IntegrationMattermost#tag_push_events}

`username`^Optional

public readonly username: string;

Type: string

Username to use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#username IntegrationMattermost#username}

`wikiPageChannel`^Optional

public readonly wikiPageChannel: string;

Type: string

The name of the channel to receive wiki page events notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#wiki_page_channel IntegrationMattermost#wiki_page_channel}

`wikiPageEvents`^Optional

public readonly wikiPageEvents: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Enable notifications for wiki page events.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/integration_mattermost#wiki_page_events IntegrationMattermost#wiki_page_events}

Files

integrationMattermost.typescript.md

Latest commit

History

integrationMattermost.typescript.md

File metadata and controls

integrationMattermost Submodule

Constructs