Skip to content

Latest commit

 

History

History
1939 lines (1227 loc) · 81.1 KB

serviceJira.python.md

File metadata and controls

1939 lines (1227 loc) · 81.1 KB
Raw

serviceJira Submodule

Constructs

ServiceJira

Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira gitlab_service_jira}.

Initializers 

from cdktf_cdktf_provider_gitlab import service_jira

serviceJira.ServiceJira(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  password: str,
  project: str,
  url: str,
  api_url: str = None,
  comment_on_event_enabled: typing.Union[bool, IResolvable] = None,
  commit_events: typing.Union[bool, IResolvable] = None,
  id: str = None,
  issues_enabled: typing.Union[bool, IResolvable] = None,
  jira_auth_type: typing.Union[int, float] = None,
  jira_issue_prefix: str = None,
  jira_issue_regex: str = None,
  jira_issue_transition_automatic: typing.Union[bool, IResolvable] = None,
  jira_issue_transition_id: str = None,
  merge_requests_events: typing.Union[bool, IResolvable] = None,
  project_key: str = None,
  project_keys: typing.List[str] = None,
  use_inherited_settings: typing.Union[bool, IResolvable] = None,
  username: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
password str The Jira API token, password, or personal access token to be used with Jira.
project str ID of the project you want to activate integration on.
url 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 typing.Union[bool, cdktf.IResolvable] Enable comments inside Jira issues on each GitLab event (commit / merge request).
commit_events typing.Union[bool, cdktf.IResolvable] Enable notifications for commit events.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#id ServiceJira#id}.
issues_enabled typing.Union[bool, cdktf.IResolvable] Enable viewing Jira issues in GitLab.
jira_auth_type typing.Union[int, float] The authentication method to be used with Jira.
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 typing.Union[bool, cdktf.IResolvable] Enable automatic issue transitions. Takes precedence over jira_issue_transition_id if enabled. Defaults to false.
jira_issue_transition_id str The ID of a transition that moves issues to a closed state.
merge_requests_events typing.Union[bool, cdktf.IResolvable] Enable notifications for merge request events.
project_key str The short identifier for your JIRA project, all uppercase, e.g., PROJ.
project_keys typing.List[str] Keys of Jira projects.
use_inherited_settings typing.Union[bool, cdktf.IResolvable] Indicates whether or not to inherit default settings. Defaults to false.
username str The email or username to be used with Jira.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
passwordRequired
  • Type: str

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}

projectRequired
  • Type: str

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}

urlRequired
  • Type: str

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}

api_urlOptional
  • Type: str

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}

comment_on_event_enabledOptional
  • Type: typing.Union[bool, 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}

commit_eventsOptional
  • Type: typing.Union[bool, 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}

idOptional
  • Type: str

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.

issues_enabledOptional
  • Type: typing.Union[bool, 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}

jira_auth_typeOptional
  • Type: typing.Union[int, float]

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}

jira_issue_prefixOptional
  • Type: str

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}

jira_issue_regexOptional
  • Type: str

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}

jira_issue_transition_automaticOptional
  • Type: typing.Union[bool, 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}

jira_issue_transition_idOptional
  • Type: 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. 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}

merge_requests_eventsOptional
  • Type: typing.Union[bool, 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}

project_keyOptional
  • Type: str

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}

project_keysOptional
  • Type: typing.List[str]

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}

use_inherited_settingsOptional
  • Type: typing.Union[bool, 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}

usernameOptional
  • Type: 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 (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}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
reset_api_url No description.
reset_comment_on_event_enabled No description.
reset_commit_events No description.
reset_id No description.
reset_issues_enabled No description.
reset_jira_auth_type No description.
reset_jira_issue_prefix No description.
reset_jira_issue_regex No description.
reset_jira_issue_transition_automatic No description.
reset_jira_issue_transition_id No description.
reset_merge_requests_events No description.
reset_project_key No description.
reset_project_keys No description.
reset_use_inherited_settings No description.
reset_username No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

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

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

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.

idRequired
  • Type: str

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

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

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

move_to_id 
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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

reset_api_url 
def reset_api_url() -> None
reset_comment_on_event_enabled 
def reset_comment_on_event_enabled() -> None
reset_commit_events 
def reset_commit_events() -> None
reset_id 
def reset_id() -> None
reset_issues_enabled 
def reset_issues_enabled() -> None
reset_jira_auth_type 
def reset_jira_auth_type() -> None
reset_jira_issue_prefix 
def reset_jira_issue_prefix() -> None
reset_jira_issue_regex 
def reset_jira_issue_regex() -> None
reset_jira_issue_transition_automatic 
def reset_jira_issue_transition_automatic() -> None
reset_jira_issue_transition_id 
def reset_jira_issue_transition_id() -> None
reset_merge_requests_events 
def reset_merge_requests_events() -> None
reset_project_key 
def reset_project_key() -> None
reset_project_keys 
def reset_project_keys() -> None
reset_use_inherited_settings 
def reset_use_inherited_settings() -> None
reset_username 
def reset_username() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a ServiceJira resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_gitlab import service_jira

serviceJira.ServiceJira.is_construct(
  x: typing.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.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_gitlab import service_jira

serviceJira.ServiceJira.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_gitlab import service_jira

serviceJira.ServiceJira.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_gitlab import service_jira

serviceJira.ServiceJira.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

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

providerOptional
  • Type: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
active cdktf.IResolvable No description.
created_at str No description.
title str No description.
updated_at str No description.
api_url_input str No description.
comment_on_event_enabled_input typing.Union[bool, cdktf.IResolvable] No description.
commit_events_input typing.Union[bool, cdktf.IResolvable] No description.
id_input str No description.
issues_enabled_input typing.Union[bool, cdktf.IResolvable] No description.
jira_auth_type_input typing.Union[int, float] No description.
jira_issue_prefix_input str No description.
jira_issue_regex_input str No description.
jira_issue_transition_automatic_input typing.Union[bool, cdktf.IResolvable] No description.
jira_issue_transition_id_input str No description.
merge_requests_events_input typing.Union[bool, cdktf.IResolvable] No description.
password_input str No description.
project_input str No description.
project_key_input str No description.
project_keys_input typing.List[str] No description.
url_input str No description.
use_inherited_settings_input typing.Union[bool, cdktf.IResolvable] No description.
username_input str No description.
api_url str No description.
comment_on_event_enabled typing.Union[bool, cdktf.IResolvable] No description.
commit_events typing.Union[bool, cdktf.IResolvable] No description.
id str No description.
issues_enabled typing.Union[bool, cdktf.IResolvable] No description.
jira_auth_type typing.Union[int, float] No description.
jira_issue_prefix str No description.
jira_issue_regex str No description.
jira_issue_transition_automatic typing.Union[bool, cdktf.IResolvable] No description.
jira_issue_transition_id str No description.
merge_requests_events typing.Union[bool, cdktf.IResolvable] No description.
password str No description.
project str No description.
project_key str No description.
project_keys typing.List[str] No description.
url str No description.
use_inherited_settings typing.Union[bool, cdktf.IResolvable] No description.
username str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
activeRequired 
active: IResolvable
  • Type: cdktf.IResolvable
created_atRequired 
created_at: str
  • Type: str
titleRequired 
title: str
  • Type: str
updated_atRequired 
updated_at: str
  • Type: str
api_url_inputOptional 
api_url_input: str
  • Type: str
comment_on_event_enabled_inputOptional 
comment_on_event_enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
commit_events_inputOptional 
commit_events_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
id_inputOptional 
id_input: str
  • Type: str
issues_enabled_inputOptional 
issues_enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
jira_auth_type_inputOptional 
jira_auth_type_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
jira_issue_prefix_inputOptional 
jira_issue_prefix_input: str
  • Type: str
jira_issue_regex_inputOptional 
jira_issue_regex_input: str
  • Type: str
jira_issue_transition_automatic_inputOptional 
jira_issue_transition_automatic_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
jira_issue_transition_id_inputOptional 
jira_issue_transition_id_input: str
  • Type: str
merge_requests_events_inputOptional 
merge_requests_events_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
password_inputOptional 
password_input: str
  • Type: str
project_inputOptional 
project_input: str
  • Type: str
project_key_inputOptional 
project_key_input: str
  • Type: str
project_keys_inputOptional 
project_keys_input: typing.List[str]
  • Type: typing.List[str]
url_inputOptional 
url_input: str
  • Type: str
use_inherited_settings_inputOptional 
use_inherited_settings_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
username_inputOptional 
username_input: str
  • Type: str
api_urlRequired 
api_url: str
  • Type: str
comment_on_event_enabledRequired 
comment_on_event_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
commit_eventsRequired 
commit_events: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
idRequired 
id: str
  • Type: str
issues_enabledRequired 
issues_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
jira_auth_typeRequired 
jira_auth_type: typing.Union[int, float]
  • Type: typing.Union[int, float]
jira_issue_prefixRequired 
jira_issue_prefix: str
  • Type: str
jira_issue_regexRequired 
jira_issue_regex: str
  • Type: str
jira_issue_transition_automaticRequired 
jira_issue_transition_automatic: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
jira_issue_transition_idRequired 
jira_issue_transition_id: str
  • Type: str
merge_requests_eventsRequired 
merge_requests_events: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
passwordRequired 
password: str
  • Type: str
projectRequired 
project: str
  • Type: str
project_keyRequired 
project_key: str
  • Type: str
project_keysRequired 
project_keys: typing.List[str]
  • Type: typing.List[str]
urlRequired 
url: str
  • Type: str
use_inherited_settingsRequired 
use_inherited_settings: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
usernameRequired 
username: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

ServiceJiraConfig

Initializer 

from cdktf_cdktf_provider_gitlab import service_jira

serviceJira.ServiceJiraConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  password: str,
  project: str,
  url: str,
  api_url: str = None,
  comment_on_event_enabled: typing.Union[bool, IResolvable] = None,
  commit_events: typing.Union[bool, IResolvable] = None,
  id: str = None,
  issues_enabled: typing.Union[bool, IResolvable] = None,
  jira_auth_type: typing.Union[int, float] = None,
  jira_issue_prefix: str = None,
  jira_issue_regex: str = None,
  jira_issue_transition_automatic: typing.Union[bool, IResolvable] = None,
  jira_issue_transition_id: str = None,
  merge_requests_events: typing.Union[bool, IResolvable] = None,
  project_key: str = None,
  project_keys: typing.List[str] = None,
  use_inherited_settings: typing.Union[bool, IResolvable] = None,
  username: str = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
password str The Jira API token, password, or personal access token to be used with Jira.
project str ID of the project you want to activate integration on.
url 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 typing.Union[bool, cdktf.IResolvable] Enable comments inside Jira issues on each GitLab event (commit / merge request).
commit_events typing.Union[bool, cdktf.IResolvable] Enable notifications for commit events.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira#id ServiceJira#id}.
issues_enabled typing.Union[bool, cdktf.IResolvable] Enable viewing Jira issues in GitLab.
jira_auth_type typing.Union[int, float] The authentication method to be used with Jira.
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 typing.Union[bool, cdktf.IResolvable] Enable automatic issue transitions. Takes precedence over jira_issue_transition_id if enabled. Defaults to false.
jira_issue_transition_id str The ID of a transition that moves issues to a closed state.
merge_requests_events typing.Union[bool, cdktf.IResolvable] Enable notifications for merge request events.
project_key str The short identifier for your JIRA project, all uppercase, e.g., PROJ.
project_keys typing.List[str] Keys of Jira projects.
use_inherited_settings typing.Union[bool, cdktf.IResolvable] Indicates whether or not to inherit default settings. Defaults to false.
username str The email or username to be used with Jira.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
passwordRequired 
password: str
  • Type: str

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}

projectRequired 
project: str
  • Type: str

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}

urlRequired 
url: str
  • Type: str

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}

api_urlOptional 
api_url: str
  • Type: str

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}

comment_on_event_enabledOptional 
comment_on_event_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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}

commit_eventsOptional 
commit_events: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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}

idOptional 
id: str
  • Type: str

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.

issues_enabledOptional 
issues_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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}

jira_auth_typeOptional 
jira_auth_type: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

jira_issue_prefixOptional 
jira_issue_prefix: str
  • Type: str

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}

jira_issue_regexOptional 
jira_issue_regex: str
  • Type: str

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}

jira_issue_transition_automaticOptional 
jira_issue_transition_automatic: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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}

jira_issue_transition_idOptional 
jira_issue_transition_id: str
  • Type: 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. 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}

merge_requests_eventsOptional 
merge_requests_events: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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}

project_keyOptional 
project_key: str
  • Type: str

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}

project_keysOptional 
project_keys: typing.List[str]
  • Type: typing.List[str]

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}

use_inherited_settingsOptional 
use_inherited_settings: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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}

usernameOptional 
username: str
  • Type: 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 (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}