Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. ServiceJira
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

gitlab.ServiceJira

Explore with Pulumi AI

GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

The gitlab.ServiceJira resource allows to manage the lifecycle of a project integration with Jira.

This resource is deprecated. use gitlab.IntegrationJirainstead!

Upstream API: GitLab REST API docs

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const awesomeProject = new gitlab.Project("awesome_project", {
    name: "awesome_project",
    description: "My awesome project.",
    visibilityLevel: "public",
});
const jira = new gitlab.ServiceJira("jira", {
    project: awesomeProject.id,
    url: "https://jira.example.com",
    username: "user",
    password: "mypass",
});
Copy
import pulumi
import pulumi_gitlab as gitlab

awesome_project = gitlab.Project("awesome_project",
    name="awesome_project",
    description="My awesome project.",
    visibility_level="public")
jira = gitlab.ServiceJira("jira",
    project=awesome_project.id,
    url="https://jira.example.com",
    username="user",
    password="mypass")
Copy
package main

import (
	"github.com/pulumi/pulumi-gitlab/sdk/v8/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		awesomeProject, err := gitlab.NewProject(ctx, "awesome_project", &gitlab.ProjectArgs{
			Name:            pulumi.String("awesome_project"),
			Description:     pulumi.String("My awesome project."),
			VisibilityLevel: pulumi.String("public"),
		})
		if err != nil {
			return err
		}
		_, err = gitlab.NewServiceJira(ctx, "jira", &gitlab.ServiceJiraArgs{
			Project:  awesomeProject.ID(),
			Url:      pulumi.String("https://jira.example.com"),
			Username: pulumi.String("user"),
			Password: pulumi.String("mypass"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;

return await Deployment.RunAsync(() => 
{
    var awesomeProject = new GitLab.Project("awesome_project", new()
    {
        Name = "awesome_project",
        Description = "My awesome project.",
        VisibilityLevel = "public",
    });

    var jira = new GitLab.ServiceJira("jira", new()
    {
        Project = awesomeProject.Id,
        Url = "https://jira.example.com",
        Username = "user",
        Password = "mypass",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.Project;
import com.pulumi.gitlab.ProjectArgs;
import com.pulumi.gitlab.ServiceJira;
import com.pulumi.gitlab.ServiceJiraArgs;
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 awesomeProject = new Project("awesomeProject", ProjectArgs.builder()
            .name("awesome_project")
            .description("My awesome project.")
            .visibilityLevel("public")
            .build());

        var jira = new ServiceJira("jira", ServiceJiraArgs.builder()
            .project(awesomeProject.id())
            .url("https://jira.example.com")
            .username("user")
            .password("mypass")
            .build());

    }
}
Copy
resources:
  awesomeProject:
    type: gitlab:Project
    name: awesome_project
    properties:
      name: awesome_project
      description: My awesome project.
      visibilityLevel: public
  jira:
    type: gitlab:ServiceJira
    properties:
      project: ${awesomeProject.id}
      url: https://jira.example.com
      username: user
      password: mypass
Copy

Create ServiceJira Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ServiceJira(name: string, args: ServiceJiraArgs, opts?: CustomResourceOptions);
@overload
def ServiceJira(resource_name: str,
                args: ServiceJiraArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def ServiceJira(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                password: Optional[str] = None,
                url: Optional[str] = None,
                project: Optional[str] = None,
                jira_issue_transition_id: Optional[str] = None,
                issues_enabled: Optional[bool] = None,
                jira_issue_prefix: Optional[str] = None,
                jira_issue_regex: Optional[str] = None,
                jira_issue_transition_automatic: Optional[bool] = None,
                api_url: Optional[str] = None,
                merge_requests_events: Optional[bool] = None,
                jira_auth_type: Optional[int] = None,
                commit_events: Optional[bool] = None,
                project_key: Optional[str] = None,
                project_keys: Optional[Sequence[str]] = None,
                comment_on_event_enabled: Optional[bool] = None,
                use_inherited_settings: Optional[bool] = None,
                username: Optional[str] = None)
func NewServiceJira(ctx *Context, name string, args ServiceJiraArgs, opts ...ResourceOption) (*ServiceJira, error)
public ServiceJira(string name, ServiceJiraArgs args, CustomResourceOptions? opts = null)
public ServiceJira(String name, ServiceJiraArgs args)
public ServiceJira(String name, ServiceJiraArgs args, CustomResourceOptions options)

type: gitlab:ServiceJira
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ServiceJiraArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ServiceJiraArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ServiceJiraArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ServiceJiraArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ServiceJiraArgs
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 serviceJiraResource = new GitLab.ServiceJira("serviceJiraResource", new()
{
    Password = "string",
    Url = "string",
    Project = "string",
    JiraIssueTransitionId = "string",
    IssuesEnabled = false,
    JiraIssuePrefix = "string",
    JiraIssueRegex = "string",
    JiraIssueTransitionAutomatic = false,
    ApiUrl = "string",
    MergeRequestsEvents = false,
    JiraAuthType = 0,
    CommitEvents = false,
    ProjectKey = "string",
    ProjectKeys = new[]
    {
        "string",
    },
    CommentOnEventEnabled = false,
    UseInheritedSettings = false,
    Username = "string",
});
Copy
example, err := gitlab.NewServiceJira(ctx, "serviceJiraResource", &gitlab.ServiceJiraArgs{
	Password:                     pulumi.String("string"),
	Url:                          pulumi.String("string"),
	Project:                      pulumi.String("string"),
	JiraIssueTransitionId:        pulumi.String("string"),
	IssuesEnabled:                pulumi.Bool(false),
	JiraIssuePrefix:              pulumi.String("string"),
	JiraIssueRegex:               pulumi.String("string"),
	JiraIssueTransitionAutomatic: pulumi.Bool(false),
	ApiUrl:                       pulumi.String("string"),
	MergeRequestsEvents:          pulumi.Bool(false),
	JiraAuthType:                 pulumi.Int(0),
	CommitEvents:                 pulumi.Bool(false),
	ProjectKey:                   pulumi.String("string"),
	ProjectKeys: pulumi.StringArray{
		pulumi.String("string"),
	},
	CommentOnEventEnabled: pulumi.Bool(false),
	UseInheritedSettings:  pulumi.Bool(false),
	Username:              pulumi.String("string"),
})
Copy
var serviceJiraResource = new ServiceJira("serviceJiraResource", ServiceJiraArgs.builder()
    .password("string")
    .url("string")
    .project("string")
    .jiraIssueTransitionId("string")
    .issuesEnabled(false)
    .jiraIssuePrefix("string")
    .jiraIssueRegex("string")
    .jiraIssueTransitionAutomatic(false)
    .apiUrl("string")
    .mergeRequestsEvents(false)
    .jiraAuthType(0)
    .commitEvents(false)
    .projectKey("string")
    .projectKeys("string")
    .commentOnEventEnabled(false)
    .useInheritedSettings(false)
    .username("string")
    .build());
Copy
service_jira_resource = gitlab.ServiceJira("serviceJiraResource",
    password="string",
    url="string",
    project="string",
    jira_issue_transition_id="string",
    issues_enabled=False,
    jira_issue_prefix="string",
    jira_issue_regex="string",
    jira_issue_transition_automatic=False,
    api_url="string",
    merge_requests_events=False,
    jira_auth_type=0,
    commit_events=False,
    project_key="string",
    project_keys=["string"],
    comment_on_event_enabled=False,
    use_inherited_settings=False,
    username="string")
Copy
const serviceJiraResource = new gitlab.ServiceJira("serviceJiraResource", {
    password: "string",
    url: "string",
    project: "string",
    jiraIssueTransitionId: "string",
    issuesEnabled: false,
    jiraIssuePrefix: "string",
    jiraIssueRegex: "string",
    jiraIssueTransitionAutomatic: false,
    apiUrl: "string",
    mergeRequestsEvents: false,
    jiraAuthType: 0,
    commitEvents: false,
    projectKey: "string",
    projectKeys: ["string"],
    commentOnEventEnabled: false,
    useInheritedSettings: false,
    username: "string",
});
Copy
type: gitlab:ServiceJira
properties:
    apiUrl: string
    commentOnEventEnabled: false
    commitEvents: false
    issuesEnabled: false
    jiraAuthType: 0
    jiraIssuePrefix: string
    jiraIssueRegex: string
    jiraIssueTransitionAutomatic: false
    jiraIssueTransitionId: string
    mergeRequestsEvents: false
    password: string
    project: string
    projectKey: string
    projectKeys:
        - string
    url: string
    useInheritedSettings: false
    username: string
Copy

ServiceJira 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 ServiceJira resource accepts the following input properties:

Password This property is required. string
The Jira API token, password, or personal access token to be used with Jira. When your authentication method is basic (jiraauthtype 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 (jiraauthtype is 1), use the personal access token.
Project
This property is required.
Changes to this property will trigger replacement.
string
ID of the project you want to activate integration on.
Url This property is required. 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 bool
Enable comments inside Jira issues on each GitLab event (commit / merge request)
CommitEvents bool
Enable notifications for commit events
IssuesEnabled bool
Enable viewing Jira issues in GitLab.
JiraAuthType int
The authentication method to be used with Jira. 0 means Basic Authentication. 1 means Jira personal access token. Defaults to 0.
JiraIssuePrefix string
Prefix to match Jira issue keys.
JiraIssueRegex string
Regular expression to match Jira issue keys.
JiraIssueTransitionAutomatic bool
JiraIssueTransitionId 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.
MergeRequestsEvents bool
Enable notifications for merge request events
ProjectKey string
The short identifier for your JIRA project, all uppercase, e.g., PROJ.
ProjectKeys List<string>
Keys of Jira projects. When issues_enabled is true, this setting specifies which Jira projects to view issues from in GitLab.
UseInheritedSettings bool
Indicates whether or not to inherit default settings. Defaults to false.
Username 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 (jiraauthtype is 0).
Password This property is required. string
The Jira API token, password, or personal access token to be used with Jira. When your authentication method is basic (jiraauthtype 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 (jiraauthtype is 1), use the personal access token.
Project
This property is required.
Changes to this property will trigger replacement.
string
ID of the project you want to activate integration on.
Url This property is required. 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 bool
Enable comments inside Jira issues on each GitLab event (commit / merge request)
CommitEvents bool
Enable notifications for commit events
IssuesEnabled bool
Enable viewing Jira issues in GitLab.
JiraAuthType int
The authentication method to be used with Jira. 0 means Basic Authentication. 1 means Jira personal access token. Defaults to 0.
JiraIssuePrefix string
Prefix to match Jira issue keys.
JiraIssueRegex string
Regular expression to match Jira issue keys.
JiraIssueTransitionAutomatic bool
JiraIssueTransitionId 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.
MergeRequestsEvents bool
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. When issues_enabled is true, this setting specifies which Jira projects to view issues from in GitLab.
UseInheritedSettings bool
Indicates whether or not to inherit default settings. Defaults to false.
Username 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 (jiraauthtype is 0).
password This property is required. String
The Jira API token, password, or personal access token to be used with Jira. When your authentication method is basic (jiraauthtype 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 (jiraauthtype is 1), use the personal access token.
project
This property is required.
Changes to this property will trigger replacement.
String
ID of the project you want to activate integration on.
url This property is required. 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
Enable comments inside Jira issues on each GitLab event (commit / merge request)
commitEvents Boolean
Enable notifications for commit events
issuesEnabled Boolean
Enable viewing Jira issues in GitLab.
jiraAuthType Integer
The authentication method to be used with Jira. 0 means Basic Authentication. 1 means Jira personal access token. Defaults to 0.
jiraIssuePrefix String
Prefix to match Jira issue keys.
jiraIssueRegex String
Regular expression to match Jira issue keys.
jiraIssueTransitionAutomatic Boolean
jiraIssueTransitionId 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.
mergeRequestsEvents Boolean
Enable notifications for merge request events
projectKey String
The short identifier for your JIRA project, all uppercase, e.g., PROJ.
projectKeys List<String>
Keys of Jira projects. When issues_enabled is true, this setting specifies which Jira projects to view issues from in GitLab.
useInheritedSettings Boolean
Indicates whether or not to inherit default settings. Defaults to false.
username 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 (jiraauthtype is 0).
password This property is required. string
The Jira API token, password, or personal access token to be used with Jira. When your authentication method is basic (jiraauthtype 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 (jiraauthtype is 1), use the personal access token.
project
This property is required.
Changes to this property will trigger replacement.
string
ID of the project you want to activate integration on.
url This property is required. 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
Enable comments inside Jira issues on each GitLab event (commit / merge request)
commitEvents boolean
Enable notifications for commit events
issuesEnabled boolean
Enable viewing Jira issues in GitLab.
jiraAuthType number
The authentication method to be used with Jira. 0 means Basic Authentication. 1 means Jira personal access token. Defaults to 0.
jiraIssuePrefix string
Prefix to match Jira issue keys.
jiraIssueRegex string
Regular expression to match Jira issue keys.
jiraIssueTransitionAutomatic boolean
jiraIssueTransitionId 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.
mergeRequestsEvents boolean
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. When issues_enabled is true, this setting specifies which Jira projects to view issues from in GitLab.
useInheritedSettings boolean
Indicates whether or not to inherit default settings. Defaults to false.
username 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 (jiraauthtype is 0).
password This property is required. str
The Jira API token, password, or personal access token to be used with Jira. When your authentication method is basic (jiraauthtype 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 (jiraauthtype is 1), use the personal access token.
project
This property is required.
Changes to this property will trigger replacement.
str
ID of the project you want to activate integration on.
url This property is required. str
The URL to the JIRA project which is being linked to this GitLab project. For example, https://jira.example.com.
api_url str
The base URL to the Jira instance API. Web URL value is used if not set. For example, https://jira-api.example.com.
comment_on_event_enabled bool
Enable comments inside Jira issues on each GitLab event (commit / merge request)
commit_events bool
Enable notifications for commit events
issues_enabled bool
Enable viewing Jira issues in GitLab.
jira_auth_type int
The authentication method to be used with Jira. 0 means Basic Authentication. 1 means Jira personal access token. Defaults to 0.
jira_issue_prefix str
Prefix to match Jira issue keys.
jira_issue_regex str
Regular expression to match Jira issue keys.
jira_issue_transition_automatic bool
jira_issue_transition_id str
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.
merge_requests_events bool
Enable notifications for merge request events
project_key str
The short identifier for your JIRA project, all uppercase, e.g., PROJ.
project_keys Sequence[str]
Keys of Jira projects. When issues_enabled is true, this setting specifies which Jira projects to view issues from in GitLab.
use_inherited_settings bool
Indicates whether or not to inherit default settings. Defaults to false.
username str
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 (jiraauthtype is 0).
password This property is required. String
The Jira API token, password, or personal access token to be used with Jira. When your authentication method is basic (jiraauthtype 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 (jiraauthtype is 1), use the personal access token.
project
This property is required.
Changes to this property will trigger replacement.
String
ID of the project you want to activate integration on.
url This property is required. 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
Enable comments inside Jira issues on each GitLab event (commit / merge request)
commitEvents Boolean
Enable notifications for commit events
issuesEnabled Boolean
Enable viewing Jira issues in GitLab.
jiraAuthType Number
The authentication method to be used with Jira. 0 means Basic Authentication. 1 means Jira personal access token. Defaults to 0.
jiraIssuePrefix String
Prefix to match Jira issue keys.
jiraIssueRegex String
Regular expression to match Jira issue keys.
jiraIssueTransitionAutomatic Boolean
jiraIssueTransitionId 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.
mergeRequestsEvents Boolean
Enable notifications for merge request events
projectKey String
The short identifier for your JIRA project, all uppercase, e.g., PROJ.
projectKeys List<String>
Keys of Jira projects. When issues_enabled is true, this setting specifies which Jira projects to view issues from in GitLab.
useInheritedSettings Boolean
Indicates whether or not to inherit default settings. Defaults to false.
username 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 (jiraauthtype is 0).

Outputs

All input properties are implicitly available as output properties. Additionally, the ServiceJira resource produces the following output properties:

Active bool
Whether the integration is active.
CreatedAt string
Create time.
Id string
The provider-assigned unique ID for this managed resource.
Title string
Title.
UpdatedAt string
Update time.
Active bool
Whether the integration is active.
CreatedAt string
Create time.
Id string
The provider-assigned unique ID for this managed resource.
Title string
Title.
UpdatedAt string
Update time.
active Boolean
Whether the integration is active.
createdAt String
Create time.
id String
The provider-assigned unique ID for this managed resource.
title String
Title.
updatedAt String
Update time.
active boolean
Whether the integration is active.
createdAt string
Create time.
id string
The provider-assigned unique ID for this managed resource.
title string
Title.
updatedAt string
Update time.
active bool
Whether the integration is active.
created_at str
Create time.
id str
The provider-assigned unique ID for this managed resource.
title str
Title.
updated_at str
Update time.
active Boolean
Whether the integration is active.
createdAt String
Create time.
id String
The provider-assigned unique ID for this managed resource.
title String
Title.
updatedAt String
Update time.

Look up Existing ServiceJira Resource

Get an existing ServiceJira 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?: ServiceJiraState, opts?: CustomResourceOptions): ServiceJira
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        api_url: Optional[str] = None,
        comment_on_event_enabled: Optional[bool] = None,
        commit_events: Optional[bool] = None,
        created_at: Optional[str] = None,
        issues_enabled: Optional[bool] = None,
        jira_auth_type: Optional[int] = None,
        jira_issue_prefix: Optional[str] = None,
        jira_issue_regex: Optional[str] = None,
        jira_issue_transition_automatic: Optional[bool] = None,
        jira_issue_transition_id: Optional[str] = None,
        merge_requests_events: Optional[bool] = None,
        password: Optional[str] = None,
        project: Optional[str] = None,
        project_key: Optional[str] = None,
        project_keys: Optional[Sequence[str]] = None,
        title: Optional[str] = None,
        updated_at: Optional[str] = None,
        url: Optional[str] = None,
        use_inherited_settings: Optional[bool] = None,
        username: Optional[str] = None) -> ServiceJira
func GetServiceJira(ctx *Context, name string, id IDInput, state *ServiceJiraState, opts ...ResourceOption) (*ServiceJira, error)
public static ServiceJira Get(string name, Input<string> id, ServiceJiraState? state, CustomResourceOptions? opts = null)
public static ServiceJira get(String name, Output<String> id, ServiceJiraState state, CustomResourceOptions options)
resources:  _:    type: gitlab:ServiceJira    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
Active bool
Whether the integration is active.
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 bool
Enable comments inside Jira issues on each GitLab event (commit / merge request)
CommitEvents bool
Enable notifications for commit events
CreatedAt string
Create time.
IssuesEnabled bool
Enable viewing Jira issues in GitLab.
JiraAuthType int
The authentication method to be used with Jira. 0 means Basic Authentication. 1 means Jira personal access token. Defaults to 0.
JiraIssuePrefix string
Prefix to match Jira issue keys.
JiraIssueRegex string
Regular expression to match Jira issue keys.
JiraIssueTransitionAutomatic bool
JiraIssueTransitionId 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.
MergeRequestsEvents bool
Enable notifications for merge request events
Password string
The Jira API token, password, or personal access token to be used with Jira. When your authentication method is basic (jiraauthtype 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 (jiraauthtype is 1), use the personal access token.
Project Changes to this property will trigger replacement. string
ID of the project you want to activate integration on.
ProjectKey string
The short identifier for your JIRA project, all uppercase, e.g., PROJ.
ProjectKeys List<string>
Keys of Jira projects. When issues_enabled is true, this setting specifies which Jira projects to view issues from in GitLab.
Title string
Title.
UpdatedAt string
Update time.
Url string
The URL to the JIRA project which is being linked to this GitLab project. For example, https://jira.example.com.
UseInheritedSettings bool
Indicates whether or not to inherit default settings. Defaults to false.
Username 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 (jiraauthtype is 0).
Active bool
Whether the integration is active.
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 bool
Enable comments inside Jira issues on each GitLab event (commit / merge request)
CommitEvents bool
Enable notifications for commit events
CreatedAt string
Create time.
IssuesEnabled bool
Enable viewing Jira issues in GitLab.
JiraAuthType int
The authentication method to be used with Jira. 0 means Basic Authentication. 1 means Jira personal access token. Defaults to 0.
JiraIssuePrefix string
Prefix to match Jira issue keys.
JiraIssueRegex string
Regular expression to match Jira issue keys.
JiraIssueTransitionAutomatic bool
JiraIssueTransitionId 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.
MergeRequestsEvents bool
Enable notifications for merge request events
Password string
The Jira API token, password, or personal access token to be used with Jira. When your authentication method is basic (jiraauthtype 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 (jiraauthtype is 1), use the personal access token.
Project Changes to this property will trigger replacement. string
ID of the project you want to activate integration on.
ProjectKey string
The short identifier for your JIRA project, all uppercase, e.g., PROJ.
ProjectKeys []string
Keys of Jira projects. When issues_enabled is true, this setting specifies which Jira projects to view issues from in GitLab.
Title string
Title.
UpdatedAt string
Update time.
Url string
The URL to the JIRA project which is being linked to this GitLab project. For example, https://jira.example.com.
UseInheritedSettings bool
Indicates whether or not to inherit default settings. Defaults to false.
Username 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 (jiraauthtype is 0).
active Boolean
Whether the integration is active.
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
Enable comments inside Jira issues on each GitLab event (commit / merge request)
commitEvents Boolean
Enable notifications for commit events
createdAt String
Create time.
issuesEnabled Boolean
Enable viewing Jira issues in GitLab.
jiraAuthType Integer
The authentication method to be used with Jira. 0 means Basic Authentication. 1 means Jira personal access token. Defaults to 0.
jiraIssuePrefix String
Prefix to match Jira issue keys.
jiraIssueRegex String
Regular expression to match Jira issue keys.
jiraIssueTransitionAutomatic Boolean
jiraIssueTransitionId 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.
mergeRequestsEvents Boolean
Enable notifications for merge request events
password String
The Jira API token, password, or personal access token to be used with Jira. When your authentication method is basic (jiraauthtype 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 (jiraauthtype is 1), use the personal access token.
project Changes to this property will trigger replacement. String
ID of the project you want to activate integration on.
projectKey String
The short identifier for your JIRA project, all uppercase, e.g., PROJ.
projectKeys List<String>
Keys of Jira projects. When issues_enabled is true, this setting specifies which Jira projects to view issues from in GitLab.
title String
Title.
updatedAt String
Update time.
url String
The URL to the JIRA project which is being linked to this GitLab project. For example, https://jira.example.com.
useInheritedSettings Boolean
Indicates whether or not to inherit default settings. Defaults to false.
username 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 (jiraauthtype is 0).
active boolean
Whether the integration is active.
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
Enable comments inside Jira issues on each GitLab event (commit / merge request)
commitEvents boolean
Enable notifications for commit events
createdAt string
Create time.
issuesEnabled boolean
Enable viewing Jira issues in GitLab.
jiraAuthType number
The authentication method to be used with Jira. 0 means Basic Authentication. 1 means Jira personal access token. Defaults to 0.
jiraIssuePrefix string
Prefix to match Jira issue keys.
jiraIssueRegex string
Regular expression to match Jira issue keys.
jiraIssueTransitionAutomatic boolean
jiraIssueTransitionId 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.
mergeRequestsEvents boolean
Enable notifications for merge request events
password string
The Jira API token, password, or personal access token to be used with Jira. When your authentication method is basic (jiraauthtype 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 (jiraauthtype is 1), use the personal access token.
project Changes to this property will trigger replacement. string
ID of the project you want to activate integration on.
projectKey string
The short identifier for your JIRA project, all uppercase, e.g., PROJ.
projectKeys string[]
Keys of Jira projects. When issues_enabled is true, this setting specifies which Jira projects to view issues from in GitLab.
title string
Title.
updatedAt string
Update time.
url string
The URL to the JIRA project which is being linked to this GitLab project. For example, https://jira.example.com.
useInheritedSettings boolean
Indicates whether or not to inherit default settings. Defaults to false.
username 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 (jiraauthtype is 0).
active bool
Whether the integration is active.
api_url str
The base URL to the Jira instance API. Web URL value is used if not set. For example, https://jira-api.example.com.
comment_on_event_enabled bool
Enable comments inside Jira issues on each GitLab event (commit / merge request)
commit_events bool
Enable notifications for commit events
created_at str
Create time.
issues_enabled bool
Enable viewing Jira issues in GitLab.
jira_auth_type int
The authentication method to be used with Jira. 0 means Basic Authentication. 1 means Jira personal access token. Defaults to 0.
jira_issue_prefix str
Prefix to match Jira issue keys.
jira_issue_regex str
Regular expression to match Jira issue keys.
jira_issue_transition_automatic bool
jira_issue_transition_id str
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.
merge_requests_events bool
Enable notifications for merge request events
password str
The Jira API token, password, or personal access token to be used with Jira. When your authentication method is basic (jiraauthtype 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 (jiraauthtype is 1), use the personal access token.
project Changes to this property will trigger replacement. str
ID of the project you want to activate integration on.
project_key str
The short identifier for your JIRA project, all uppercase, e.g., PROJ.
project_keys Sequence[str]
Keys of Jira projects. When issues_enabled is true, this setting specifies which Jira projects to view issues from in GitLab.
title str
Title.
updated_at str
Update time.
url str
The URL to the JIRA project which is being linked to this GitLab project. For example, https://jira.example.com.
use_inherited_settings bool
Indicates whether or not to inherit default settings. Defaults to false.
username str
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 (jiraauthtype is 0).
active Boolean
Whether the integration is active.
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
Enable comments inside Jira issues on each GitLab event (commit / merge request)
commitEvents Boolean
Enable notifications for commit events
createdAt String
Create time.
issuesEnabled Boolean
Enable viewing Jira issues in GitLab.
jiraAuthType Number
The authentication method to be used with Jira. 0 means Basic Authentication. 1 means Jira personal access token. Defaults to 0.
jiraIssuePrefix String
Prefix to match Jira issue keys.
jiraIssueRegex String
Regular expression to match Jira issue keys.
jiraIssueTransitionAutomatic Boolean
jiraIssueTransitionId 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.
mergeRequestsEvents Boolean
Enable notifications for merge request events
password String
The Jira API token, password, or personal access token to be used with Jira. When your authentication method is basic (jiraauthtype 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 (jiraauthtype is 1), use the personal access token.
project Changes to this property will trigger replacement. String
ID of the project you want to activate integration on.
projectKey String
The short identifier for your JIRA project, all uppercase, e.g., PROJ.
projectKeys List<String>
Keys of Jira projects. When issues_enabled is true, this setting specifies which Jira projects to view issues from in GitLab.
title String
Title.
updatedAt String
Update time.
url String
The URL to the JIRA project which is being linked to this GitLab project. For example, https://jira.example.com.
useInheritedSettings Boolean
Indicates whether or not to inherit default settings. Defaults to false.
username 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 (jiraauthtype is 0).

Import

Starting in Terraform v1.5.0 you can use an import block to import gitlab_service_jira. For example:

terraform

import {

to = gitlab_service_jira.example

id = “see CLI command below for ID”

}

Import using the CLI is supported using the following syntax:

You can import a gitlab_service_jira state using the project ID, e.g.

$ pulumi import gitlab:index/serviceJira:ServiceJira jira 1
Copy

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 gitlab Terraform Provider.
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab