Documentation
¶
Index ¶
- func IntegrationMattermost_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func IntegrationMattermost_IsConstruct(x interface{}) *bool
- func IntegrationMattermost_IsTerraformElement(x interface{}) *bool
- func IntegrationMattermost_IsTerraformResource(x interface{}) *bool
- func IntegrationMattermost_TfResourceType() *string
- func NewIntegrationMattermost_Override(i IntegrationMattermost, scope constructs.Construct, id *string, ...)
- type IntegrationMattermost
- type IntegrationMattermostConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IntegrationMattermost_GenerateConfigForImport ¶
func IntegrationMattermost_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a IntegrationMattermost resource upon running "cdktf plan <stack-name>".
func IntegrationMattermost_IsConstruct ¶
func IntegrationMattermost_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func IntegrationMattermost_IsTerraformElement ¶
func IntegrationMattermost_IsTerraformElement(x interface{}) *bool
Experimental.
func IntegrationMattermost_IsTerraformResource ¶
func IntegrationMattermost_IsTerraformResource(x interface{}) *bool
Experimental.
func IntegrationMattermost_TfResourceType ¶
func IntegrationMattermost_TfResourceType() *string
func NewIntegrationMattermost_Override ¶
func NewIntegrationMattermost_Override(i IntegrationMattermost, scope constructs.Construct, id *string, config *IntegrationMattermostConfig)
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost gitlab_integration_mattermost} Resource.
Types ¶
type IntegrationMattermost ¶
type IntegrationMattermost interface {
cdktf.TerraformResource
BranchesToBeNotified() *string
SetBranchesToBeNotified(val *string)
BranchesToBeNotifiedInput() *string
// Experimental.
CdktfStack() cdktf.TerraformStack
ConfidentialIssueChannel() *string
SetConfidentialIssueChannel(val *string)
ConfidentialIssueChannelInput() *string
ConfidentialIssuesEvents() interface{}
SetConfidentialIssuesEvents(val interface{})
ConfidentialIssuesEventsInput() interface{}
ConfidentialNoteChannel() *string
SetConfidentialNoteChannel(val *string)
ConfidentialNoteChannelInput() *string
ConfidentialNoteEvents() interface{}
SetConfidentialNoteEvents(val interface{})
ConfidentialNoteEventsInput() interface{}
// Experimental.
Connection() interface{}
// Experimental.
SetConnection(val interface{})
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
// Experimental.
Count() interface{}
// Experimental.
SetCount(val interface{})
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*string)
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
Id() *string
SetId(val *string)
IdInput() *string
IssueChannel() *string
SetIssueChannel(val *string)
IssueChannelInput() *string
IssuesEvents() interface{}
SetIssuesEvents(val interface{})
IssuesEventsInput() interface{}
// Experimental.
Lifecycle() *cdktf.TerraformResourceLifecycle
// Experimental.
SetLifecycle(val *cdktf.TerraformResourceLifecycle)
MergeRequestChannel() *string
SetMergeRequestChannel(val *string)
MergeRequestChannelInput() *string
MergeRequestsEvents() interface{}
SetMergeRequestsEvents(val interface{})
MergeRequestsEventsInput() interface{}
// The tree node.
Node() constructs.Node
NoteChannel() *string
SetNoteChannel(val *string)
NoteChannelInput() *string
NoteEvents() interface{}
SetNoteEvents(val interface{})
NoteEventsInput() interface{}
NotifyOnlyBrokenPipelines() interface{}
SetNotifyOnlyBrokenPipelines(val interface{})
NotifyOnlyBrokenPipelinesInput() interface{}
PipelineChannel() *string
SetPipelineChannel(val *string)
PipelineChannelInput() *string
PipelineEvents() interface{}
SetPipelineEvents(val interface{})
PipelineEventsInput() interface{}
Project() *string
SetProject(val *string)
ProjectInput() *string
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
PushChannel() *string
SetPushChannel(val *string)
PushChannelInput() *string
PushEvents() interface{}
SetPushEvents(val interface{})
PushEventsInput() interface{}
// Experimental.
RawOverrides() interface{}
TagPushChannel() *string
SetTagPushChannel(val *string)
TagPushChannelInput() *string
TagPushEvents() interface{}
SetTagPushEvents(val interface{})
TagPushEventsInput() interface{}
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *string
Username() *string
SetUsername(val *string)
UsernameInput() *string
Webhook() *string
SetWebhook(val *string)
WebhookInput() *string
WikiPageChannel() *string
SetWikiPageChannel(val *string)
WikiPageChannelInput() *string
WikiPageEvents() interface{}
SetWikiPageEvents(val interface{})
WikiPageEventsInput() interface{}
// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
// Experimental.
AddMoveTarget(moveTarget *string)
// Experimental.
AddOverride(path *string, value interface{})
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
HasResourceMove() interface{}
// Experimental.
ImportFrom(id *string, provider cdktf.TerraformProvider)
// Experimental.
InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
// 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.
// Experimental.
MoveFromId(id *string)
// Moves this resource to the target resource given by moveTarget.
// Experimental.
MoveTo(moveTarget *string, index interface{})
// Moves this resource to the resource corresponding to "id".
// Experimental.
MoveToId(id *string)
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
ResetBranchesToBeNotified()
ResetConfidentialIssueChannel()
ResetConfidentialIssuesEvents()
ResetConfidentialNoteChannel()
ResetConfidentialNoteEvents()
ResetId()
ResetIssueChannel()
ResetIssuesEvents()
ResetMergeRequestChannel()
ResetMergeRequestsEvents()
ResetNoteChannel()
ResetNoteEvents()
ResetNotifyOnlyBrokenPipelines()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetPipelineChannel()
ResetPipelineEvents()
ResetPushChannel()
ResetPushEvents()
ResetTagPushChannel()
ResetTagPushEvents()
ResetUsername()
ResetWikiPageChannel()
ResetWikiPageEvents()
SynthesizeAttributes() *map[string]interface{}
SynthesizeHclAttributes() *map[string]interface{}
// Experimental.
ToHclTerraform() interface{}
// Experimental.
ToMetadata() interface{}
// Returns a string representation of this construct.
ToString() *string
// Adds this resource to the terraform JSON output.
// Experimental.
ToTerraform() interface{}
}
Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost gitlab_integration_mattermost}.
func NewIntegrationMattermost ¶
func NewIntegrationMattermost(scope constructs.Construct, id *string, config *IntegrationMattermostConfig) IntegrationMattermost
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost gitlab_integration_mattermost} Resource.
type IntegrationMattermostConfig ¶
type IntegrationMattermostConfig struct {
// Experimental.
Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
// Experimental.
Count interface{} `field:"optional" json:"count" yaml:"count"`
// Experimental.
DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
// Experimental.
ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
// Experimental.
Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
// Experimental.
Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
// Experimental.
Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
// ID of the project you want to activate integration on.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#project IntegrationMattermost#project}
Project *string `field:"required" json:"project" yaml:"project"`
// 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.6.1/docs/resources/integration_mattermost#webhook IntegrationMattermost#webhook}
Webhook *string `field:"required" json:"webhook" yaml:"webhook"`
// 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.6.1/docs/resources/integration_mattermost#branches_to_be_notified IntegrationMattermost#branches_to_be_notified}
BranchesToBeNotified *string `field:"optional" json:"branchesToBeNotified" yaml:"branchesToBeNotified"`
// The name of the channel to receive confidential issue events notifications.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#confidential_issue_channel IntegrationMattermost#confidential_issue_channel}
ConfidentialIssueChannel *string `field:"optional" json:"confidentialIssueChannel" yaml:"confidentialIssueChannel"`
// Enable notifications for confidential issues events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#confidential_issues_events IntegrationMattermost#confidential_issues_events}
ConfidentialIssuesEvents interface{} `field:"optional" json:"confidentialIssuesEvents" yaml:"confidentialIssuesEvents"`
// The name of the channel to receive confidential note events notifications.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#confidential_note_channel IntegrationMattermost#confidential_note_channel}
ConfidentialNoteChannel *string `field:"optional" json:"confidentialNoteChannel" yaml:"confidentialNoteChannel"`
// Enable notifications for confidential note events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#confidential_note_events IntegrationMattermost#confidential_note_events}
ConfidentialNoteEvents interface{} `field:"optional" json:"confidentialNoteEvents" yaml:"confidentialNoteEvents"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.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.
Id *string `field:"optional" json:"id" yaml:"id"`
// The name of the channel to receive issue events notifications.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#issue_channel IntegrationMattermost#issue_channel}
IssueChannel *string `field:"optional" json:"issueChannel" yaml:"issueChannel"`
// Enable notifications for issues events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#issues_events IntegrationMattermost#issues_events}
IssuesEvents interface{} `field:"optional" json:"issuesEvents" yaml:"issuesEvents"`
// The name of the channel to receive merge request events notifications.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#merge_request_channel IntegrationMattermost#merge_request_channel}
MergeRequestChannel *string `field:"optional" json:"mergeRequestChannel" yaml:"mergeRequestChannel"`
// Enable notifications for merge requests events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#merge_requests_events IntegrationMattermost#merge_requests_events}
MergeRequestsEvents interface{} `field:"optional" json:"mergeRequestsEvents" yaml:"mergeRequestsEvents"`
// The name of the channel to receive note events notifications.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#note_channel IntegrationMattermost#note_channel}
NoteChannel *string `field:"optional" json:"noteChannel" yaml:"noteChannel"`
// Enable notifications for note events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#note_events IntegrationMattermost#note_events}
NoteEvents interface{} `field:"optional" json:"noteEvents" yaml:"noteEvents"`
// Send notifications for broken pipelines.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#notify_only_broken_pipelines IntegrationMattermost#notify_only_broken_pipelines}
NotifyOnlyBrokenPipelines interface{} `field:"optional" json:"notifyOnlyBrokenPipelines" yaml:"notifyOnlyBrokenPipelines"`
// The name of the channel to receive pipeline events notifications.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#pipeline_channel IntegrationMattermost#pipeline_channel}
PipelineChannel *string `field:"optional" json:"pipelineChannel" yaml:"pipelineChannel"`
// Enable notifications for pipeline events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#pipeline_events IntegrationMattermost#pipeline_events}
PipelineEvents interface{} `field:"optional" json:"pipelineEvents" yaml:"pipelineEvents"`
// The name of the channel to receive push events notifications.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#push_channel IntegrationMattermost#push_channel}
PushChannel *string `field:"optional" json:"pushChannel" yaml:"pushChannel"`
// Enable notifications for push events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#push_events IntegrationMattermost#push_events}
PushEvents interface{} `field:"optional" json:"pushEvents" yaml:"pushEvents"`
// The name of the channel to receive tag push events notifications.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#tag_push_channel IntegrationMattermost#tag_push_channel}
TagPushChannel *string `field:"optional" json:"tagPushChannel" yaml:"tagPushChannel"`
// Enable notifications for tag push events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#tag_push_events IntegrationMattermost#tag_push_events}
TagPushEvents interface{} `field:"optional" json:"tagPushEvents" yaml:"tagPushEvents"`
// Username to use.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#username IntegrationMattermost#username}
Username *string `field:"optional" json:"username" yaml:"username"`
// The name of the channel to receive wiki page events notifications.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#wiki_page_channel IntegrationMattermost#wiki_page_channel}
WikiPageChannel *string `field:"optional" json:"wikiPageChannel" yaml:"wikiPageChannel"`
// Enable notifications for wiki page events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/integration_mattermost#wiki_page_events IntegrationMattermost#wiki_page_events}
WikiPageEvents interface{} `field:"optional" json:"wikiPageEvents" yaml:"wikiPageEvents"`
}