Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira gitlab_service_jira}.
import { serviceJira } from '@cdktf/provider-gitlab'
new serviceJira.ServiceJira(scope: Construct, id: string, config: ServiceJiraConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
ServiceJiraConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: ServiceJiraConfig
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". |
resetApiUrl |
No description. |
resetCommentOnEventEnabled |
No description. |
resetCommitEvents |
No description. |
resetId |
No description. |
resetIssuesEnabled |
No description. |
resetJiraAuthType |
No description. |
resetJiraIssuePrefix |
No description. |
resetJiraIssueRegex |
No description. |
resetJiraIssueTransitionAutomatic |
No description. |
resetJiraIssueTransitionId |
No description. |
resetMergeRequestsEvents |
No description. |
resetProjectKey |
No description. |
resetProjectKeys |
No description. |
resetUseInheritedSettings |
No description. |
resetUsername |
No description. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): any
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
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.
- Type: string
The string move target that will correspond to this resource.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
public importFrom(id: string, provider?: TerraformProvider): void
- Type: string
- Type: cdktf.TerraformProvider
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public moveTo(moveTarget: string, index?: string | number): void
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: string | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public moveToId(id: string): void
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public resetApiUrl(): void
public resetCommentOnEventEnabled(): void
public resetCommitEvents(): void
public resetId(): void
public resetIssuesEnabled(): void
public resetJiraAuthType(): void
public resetJiraIssuePrefix(): void
public resetJiraIssueRegex(): void
public resetJiraIssueTransitionAutomatic(): void
public resetJiraIssueTransitionId(): void
public resetMergeRequestsEvents(): void
public resetProjectKey(): void
public resetProjectKeys(): void
public resetUseInheritedSettings(): void
public resetUsername(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a ServiceJira resource upon running "cdktf plan ". |
import { serviceJira } from '@cdktf/provider-gitlab'
serviceJira.ServiceJira.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.
- Type: any
Any object.
import { serviceJira } from '@cdktf/provider-gitlab'
serviceJira.ServiceJira.isTerraformElement(x: any)
- Type: any
import { serviceJira } from '@cdktf/provider-gitlab'
serviceJira.ServiceJira.isTerraformResource(x: any)
- Type: any
import { serviceJira } from '@cdktf/provider-gitlab'
serviceJira.ServiceJira.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a ServiceJira resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the ServiceJira to import.
- Type: string
The id of the existing ServiceJira that should be imported.
Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the ServiceJira to import is found.
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. |
active |
cdktf.IResolvable |
No description. |
createdAt |
string |
No description. |
title |
string |
No description. |
updatedAt |
string |
No description. |
apiUrlInput |
string |
No description. |
commentOnEventEnabledInput |
boolean | cdktf.IResolvable |
No description. |
commitEventsInput |
boolean | cdktf.IResolvable |
No description. |
idInput |
string |
No description. |
issuesEnabledInput |
boolean | cdktf.IResolvable |
No description. |
jiraAuthTypeInput |
number |
No description. |
jiraIssuePrefixInput |
string |
No description. |
jiraIssueRegexInput |
string |
No description. |
jiraIssueTransitionAutomaticInput |
boolean | cdktf.IResolvable |
No description. |
jiraIssueTransitionIdInput |
string |
No description. |
mergeRequestsEventsInput |
boolean | cdktf.IResolvable |
No description. |
passwordInput |
string |
No description. |
projectInput |
string |
No description. |
projectKeyInput |
string |
No description. |
projectKeysInput |
string[] |
No description. |
urlInput |
string |
No description. |
useInheritedSettingsInput |
boolean | cdktf.IResolvable |
No description. |
usernameInput |
string |
No description. |
apiUrl |
string |
No description. |
commentOnEventEnabled |
boolean | cdktf.IResolvable |
No description. |
commitEvents |
boolean | cdktf.IResolvable |
No description. |
id |
string |
No description. |
issuesEnabled |
boolean | cdktf.IResolvable |
No description. |
jiraAuthType |
number |
No description. |
jiraIssuePrefix |
string |
No description. |
jiraIssueRegex |
string |
No description. |
jiraIssueTransitionAutomatic |
boolean | cdktf.IResolvable |
No description. |
jiraIssueTransitionId |
string |
No description. |
mergeRequestsEvents |
boolean | cdktf.IResolvable |
No description. |
password |
string |
No description. |
project |
string |
No description. |
projectKey |
string |
No description. |
projectKeys |
string[] |
No description. |
url |
string |
No description. |
useInheritedSettings |
boolean | cdktf.IResolvable |
No description. |
username |
string |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly active: IResolvable;
- Type: cdktf.IResolvable
public readonly createdAt: string;
- Type: string
public readonly title: string;
- Type: string
public readonly updatedAt: string;
- Type: string
public readonly apiUrlInput: string;
- Type: string
public readonly commentOnEventEnabledInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly commitEventsInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly idInput: string;
- Type: string
public readonly issuesEnabledInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly jiraAuthTypeInput: number;
- Type: number
public readonly jiraIssuePrefixInput: string;
- Type: string
public readonly jiraIssueRegexInput: string;
- Type: string
public readonly jiraIssueTransitionAutomaticInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly jiraIssueTransitionIdInput: string;
- Type: string
public readonly mergeRequestsEventsInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly passwordInput: string;
- Type: string
public readonly projectInput: string;
- Type: string
public readonly projectKeyInput: string;
- Type: string
public readonly projectKeysInput: string[];
- Type: string[]
public readonly urlInput: string;
- Type: string
public readonly useInheritedSettingsInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly usernameInput: string;
- Type: string
public readonly apiUrl: string;
- Type: string
public readonly commentOnEventEnabled: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly commitEvents: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly id: string;
- Type: string
public readonly issuesEnabled: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly jiraAuthType: number;
- Type: number
public readonly jiraIssuePrefix: string;
- Type: string
public readonly jiraIssueRegex: string;
- Type: string
public readonly jiraIssueTransitionAutomatic: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly jiraIssueTransitionId: string;
- Type: string
public readonly mergeRequestsEvents: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly password: string;
- Type: string
public readonly project: string;
- Type: string
public readonly projectKey: string;
- Type: string
public readonly projectKeys: string[];
- Type: string[]
public readonly url: string;
- Type: string
public readonly useInheritedSettings: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly username: string;
- Type: string
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { serviceJira } from '@cdktf/provider-gitlab'
const serviceJiraConfig: serviceJira.ServiceJiraConfig = { ... }
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. |
password |
string |
The Jira API token, password, or personal access token to be used with Jira. |
project |
string |
ID of the project you want to activate integration on. |
url |
string |
The URL to the JIRA project which is being linked to this GitLab project. For example, https://jira.example.com. |
apiUrl |
string |
The base URL to the Jira instance API. Web URL value is used if not set. For example, https://jira-api.example.com. |
commentOnEventEnabled |
boolean | cdktf.IResolvable |
Enable comments inside Jira issues on each GitLab event (commit / merge request). |
commitEvents |
boolean | cdktf.IResolvable |
Enable notifications for commit events. |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#id ServiceJira#id}. |
issuesEnabled |
boolean | cdktf.IResolvable |
Enable viewing Jira issues in GitLab. |
jiraAuthType |
number |
The authentication method to be used with Jira. |
jiraIssuePrefix |
string |
Prefix to match Jira issue keys. |
jiraIssueRegex |
string |
Regular expression to match Jira issue keys. |
jiraIssueTransitionAutomatic |
boolean | cdktf.IResolvable |
Enable automatic issue transitions. Takes precedence over jira_issue_transition_id if enabled. Defaults to false. |
jiraIssueTransitionId |
string |
The ID of a transition that moves issues to a closed state. |
mergeRequestsEvents |
boolean | cdktf.IResolvable |
Enable notifications for merge request events. |
projectKey |
string |
The short identifier for your JIRA project, all uppercase, e.g., PROJ. |
projectKeys |
string[] |
Keys of Jira projects. |
useInheritedSettings |
boolean | cdktf.IResolvable |
Indicates whether or not to inherit default settings. Defaults to false. |
username |
string |
The email or username to be used with Jira. |
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly password: string;
- Type: string
The Jira API token, password, or personal access token to be used with Jira.
When your authentication method is basic (jira_auth_type is 0), use an API token for Jira Cloud or a password for Jira Data Center or Jira Server. When your authentication method is a Jira personal access token (jira_auth_type is 1), use the personal access token.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#password ServiceJira#password}
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.6.1/docs/resources/service_jira#project ServiceJira#project}
public readonly url: string;
- Type: string
The URL to the JIRA project which is being linked to this GitLab project. For example, https://jira.example.com.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#url ServiceJira#url}
public readonly apiUrl: string;
- Type: string
The base URL to the Jira instance API. Web URL value is used if not set. For example, https://jira-api.example.com.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#api_url ServiceJira#api_url}
public readonly commentOnEventEnabled: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Enable comments inside Jira issues on each GitLab event (commit / merge request).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#comment_on_event_enabled ServiceJira#comment_on_event_enabled}
public readonly commitEvents: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Enable notifications for commit events.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#commit_events ServiceJira#commit_events}
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#id ServiceJira#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.
public readonly issuesEnabled: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Enable viewing Jira issues in GitLab.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#issues_enabled ServiceJira#issues_enabled}
public readonly jiraAuthType: number;
- Type: number
The authentication method to be used with Jira.
0 means Basic Authentication. 1 means Jira personal access token. Defaults to 0.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#jira_auth_type ServiceJira#jira_auth_type}
public readonly jiraIssuePrefix: string;
- Type: string
Prefix to match Jira issue keys.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#jira_issue_prefix ServiceJira#jira_issue_prefix}
public readonly jiraIssueRegex: string;
- Type: string
Regular expression to match Jira issue keys.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#jira_issue_regex ServiceJira#jira_issue_regex}
public readonly jiraIssueTransitionAutomatic: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Enable automatic issue transitions. Takes precedence over jira_issue_transition_id if enabled. Defaults to false.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#jira_issue_transition_automatic ServiceJira#jira_issue_transition_automatic}
public readonly jiraIssueTransitionId: string;
- Type: string
The ID of a transition that moves issues to a closed state.
You can find this number under the JIRA workflow administration (Administration > Issues > Workflows) by selecting View under Operations of the desired workflow of your project. By default, this ID is set to 2. Note*: importing this field is only supported since GitLab 15.2.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#jira_issue_transition_id ServiceJira#jira_issue_transition_id}
public readonly mergeRequestsEvents: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Enable notifications for merge request events.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#merge_requests_events ServiceJira#merge_requests_events}
public readonly projectKey: string;
- Type: string
The short identifier for your JIRA project, all uppercase, e.g., PROJ.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#project_key ServiceJira#project_key}
public readonly projectKeys: string[];
- Type: string[]
Keys of Jira projects.
When issues_enabled is true, this setting specifies which Jira projects to view issues from in GitLab.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#project_keys ServiceJira#project_keys}
public readonly useInheritedSettings: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Indicates whether or not to inherit default settings. Defaults to false.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#use_inherited_settings ServiceJira#use_inherited_settings}
public readonly username: string;
- Type: string
The email or username to be used with Jira.
For Jira Cloud use an email, for Jira Data Center and Jira Server use a username. Required when using Basic authentication (jira_auth_type is 0).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#username ServiceJira#username}