Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/service_jira gitlab_service_jira}.
using HashiCorp.Cdktf.Providers.Gitlab;
new ServiceJira(Construct Scope, string Id, ServiceJiraConfig Config);
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. |
private string ToString()
Returns a string representation of this construct.
private void AddOverride(string Path, object Value)
- Type: string
- Type: object
private void OverrideLogicalId(string NewLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
private object ToHclTerraform()
private object ToMetadata()
private object ToTerraform()
Adds this resource to the terraform JSON output.
private void AddMoveTarget(string MoveTarget)
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.
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
- Type: string
private string[] GetListAttribute(string TerraformAttribute)
- Type: string
private double GetNumberAttribute(string TerraformAttribute)
- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
- Type: string
private string GetStringAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
- Type: string
private object HasResourceMove()
private void ImportFrom(string Id, TerraformProvider Provider = null)
- Type: string
- Type: HashiCorp.Cdktf.TerraformProvider
private IResolvable InterpolationForAttribute(string TerraformAttribute)
- Type: string
private void MoveFromId(string Id)
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".
private void MoveTo(string MoveTarget, object Index = null)
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: object
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
private void MoveToId(string Id)
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
private void ResetApiUrl()
private void ResetCommentOnEventEnabled()
private void ResetCommitEvents()
private void ResetId()
private void ResetIssuesEnabled()
private void ResetJiraAuthType()
private void ResetJiraIssuePrefix()
private void ResetJiraIssueRegex()
private void ResetJiraIssueTransitionAutomatic()
private void ResetJiraIssueTransitionId()
private void ResetMergeRequestsEvents()
private void ResetProjectKey()
private void ResetProjectKeys()
private void ResetUseInheritedSettings()
private void ResetUsername()
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 ". |
using HashiCorp.Cdktf.Providers.Gitlab;
ServiceJira.IsConstruct(object X);
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: object
Any object.
using HashiCorp.Cdktf.Providers.Gitlab;
ServiceJira.IsTerraformElement(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Gitlab;
ServiceJira.IsTerraformResource(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Gitlab;
ServiceJira.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);
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: HashiCorp.Cdktf.TerraformProvider
? Optional instance of the provider where the ServiceJira to import is found.
Name | Type | Description |
---|---|---|
Node |
Constructs.Node |
The tree node. |
CdktfStack |
HashiCorp.Cdktf.TerraformStack |
No description. |
Fqn |
string |
No description. |
FriendlyUniqueId |
string |
No description. |
TerraformMetaArguments |
System.Collections.Generic.IDictionary<string, object> |
No description. |
TerraformResourceType |
string |
No description. |
TerraformGeneratorMetadata |
HashiCorp.Cdktf.TerraformProviderGeneratorMetadata |
No description. |
Connection |
object |
No description. |
Count |
object |
No description. |
DependsOn |
string[] |
No description. |
ForEach |
HashiCorp.Cdktf.ITerraformIterator |
No description. |
Lifecycle |
HashiCorp.Cdktf.TerraformResourceLifecycle |
No description. |
Provider |
HashiCorp.Cdktf.TerraformProvider |
No description. |
Provisioners |
object[] |
No description. |
Active |
HashiCorp.Cdktf.IResolvable |
No description. |
CreatedAt |
string |
No description. |
Title |
string |
No description. |
UpdatedAt |
string |
No description. |
ApiUrlInput |
string |
No description. |
CommentOnEventEnabledInput |
object |
No description. |
CommitEventsInput |
object |
No description. |
IdInput |
string |
No description. |
IssuesEnabledInput |
object |
No description. |
JiraAuthTypeInput |
double |
No description. |
JiraIssuePrefixInput |
string |
No description. |
JiraIssueRegexInput |
string |
No description. |
JiraIssueTransitionAutomaticInput |
object |
No description. |
JiraIssueTransitionIdInput |
string |
No description. |
MergeRequestsEventsInput |
object |
No description. |
PasswordInput |
string |
No description. |
ProjectInput |
string |
No description. |
ProjectKeyInput |
string |
No description. |
ProjectKeysInput |
string[] |
No description. |
UrlInput |
string |
No description. |
UseInheritedSettingsInput |
object |
No description. |
UsernameInput |
string |
No description. |
ApiUrl |
string |
No description. |
CommentOnEventEnabled |
object |
No description. |
CommitEvents |
object |
No description. |
Id |
string |
No description. |
IssuesEnabled |
object |
No description. |
JiraAuthType |
double |
No description. |
JiraIssuePrefix |
string |
No description. |
JiraIssueRegex |
string |
No description. |
JiraIssueTransitionAutomatic |
object |
No description. |
JiraIssueTransitionId |
string |
No description. |
MergeRequestsEvents |
object |
No description. |
Password |
string |
No description. |
Project |
string |
No description. |
ProjectKey |
string |
No description. |
ProjectKeys |
string[] |
No description. |
Url |
string |
No description. |
UseInheritedSettings |
object |
No description. |
Username |
string |
No description. |
public Node Node { get; }
- Type: Constructs.Node
The tree node.
public TerraformStack CdktfStack { get; }
- Type: HashiCorp.Cdktf.TerraformStack
public string Fqn { get; }
- Type: string
public string FriendlyUniqueId { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
- Type: System.Collections.Generic.IDictionary<string, object>
public string TerraformResourceType { get; }
- Type: string
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
- Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
public object Connection { get; }
- Type: object
public object Count { get; }
- Type: object
public string[] DependsOn { get; }
- Type: string[]
public ITerraformIterator ForEach { get; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; }
- Type: object[]
public IResolvable Active { get; }
- Type: HashiCorp.Cdktf.IResolvable
public string CreatedAt { get; }
- Type: string
public string Title { get; }
- Type: string
public string UpdatedAt { get; }
- Type: string
public string ApiUrlInput { get; }
- Type: string
public object CommentOnEventEnabledInput { get; }
- Type: object
public object CommitEventsInput { get; }
- Type: object
public string IdInput { get; }
- Type: string
public object IssuesEnabledInput { get; }
- Type: object
public double JiraAuthTypeInput { get; }
- Type: double
public string JiraIssuePrefixInput { get; }
- Type: string
public string JiraIssueRegexInput { get; }
- Type: string
public object JiraIssueTransitionAutomaticInput { get; }
- Type: object
public string JiraIssueTransitionIdInput { get; }
- Type: string
public object MergeRequestsEventsInput { get; }
- Type: object
public string PasswordInput { get; }
- Type: string
public string ProjectInput { get; }
- Type: string
public string ProjectKeyInput { get; }
- Type: string
public string[] ProjectKeysInput { get; }
- Type: string[]
public string UrlInput { get; }
- Type: string
public object UseInheritedSettingsInput { get; }
- Type: object
public string UsernameInput { get; }
- Type: string
public string ApiUrl { get; }
- Type: string
public object CommentOnEventEnabled { get; }
- Type: object
public object CommitEvents { get; }
- Type: object
public string Id { get; }
- Type: string
public object IssuesEnabled { get; }
- Type: object
public double JiraAuthType { get; }
- Type: double
public string JiraIssuePrefix { get; }
- Type: string
public string JiraIssueRegex { get; }
- Type: string
public object JiraIssueTransitionAutomatic { get; }
- Type: object
public string JiraIssueTransitionId { get; }
- Type: string
public object MergeRequestsEvents { get; }
- Type: object
public string Password { get; }
- Type: string
public string Project { get; }
- Type: string
public string ProjectKey { get; }
- Type: string
public string[] ProjectKeys { get; }
- Type: string[]
public string Url { get; }
- Type: string
public object UseInheritedSettings { get; }
- Type: object
public string Username { get; }
- Type: string
Name | Type | Description |
---|---|---|
TfResourceType |
string |
No description. |
public string TfResourceType { get; }
- Type: string
using HashiCorp.Cdktf.Providers.Gitlab;
new ServiceJiraConfig {
object Connection = null,
object Count = null,
ITerraformDependable[] DependsOn = null,
ITerraformIterator ForEach = null,
TerraformResourceLifecycle Lifecycle = null,
TerraformProvider Provider = null,
object[] Provisioners = null,
string Password,
string Project,
string Url,
string ApiUrl = null,
object CommentOnEventEnabled = null,
object CommitEvents = null,
string Id = null,
object IssuesEnabled = null,
double JiraAuthType = null,
string JiraIssuePrefix = null,
string JiraIssueRegex = null,
object JiraIssueTransitionAutomatic = null,
string JiraIssueTransitionId = null,
object MergeRequestsEvents = null,
string ProjectKey = null,
string[] ProjectKeys = null,
object UseInheritedSettings = null,
string Username = null
};
Name | Type | Description |
---|---|---|
Connection |
object |
No description. |
Count |
object |
No description. |
DependsOn |
HashiCorp.Cdktf.ITerraformDependable[] |
No description. |
ForEach |
HashiCorp.Cdktf.ITerraformIterator |
No description. |
Lifecycle |
HashiCorp.Cdktf.TerraformResourceLifecycle |
No description. |
Provider |
HashiCorp.Cdktf.TerraformProvider |
No description. |
Provisioners |
object[] |
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 |
object |
Enable comments inside Jira issues on each GitLab event (commit / merge request). |
CommitEvents |
object |
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 |
object |
Enable viewing Jira issues in GitLab. |
JiraAuthType |
double |
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 |
object |
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 |
object |
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 |
object |
Indicates whether or not to inherit default settings. Defaults to false. |
Username |
string |
The email or username to be used with Jira. |
public object Connection { get; set; }
- Type: object
public object Count { get; set; }
- Type: object
public ITerraformDependable[] DependsOn { get; set; }
- Type: HashiCorp.Cdktf.ITerraformDependable[]
public ITerraformIterator ForEach { get; set; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; set; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; set; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; set; }
- Type: object[]
public string Password { get; set; }
- 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 string Project { get; set; }
- 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 string Url { get; set; }
- 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 string ApiUrl { get; set; }
- 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 object CommentOnEventEnabled { get; set; }
- Type: object
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 object CommitEvents { get; set; }
- Type: object
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 string Id { get; set; }
- 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 object IssuesEnabled { get; set; }
- Type: object
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 double JiraAuthType { get; set; }
- Type: double
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 string JiraIssuePrefix { get; set; }
- 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 string JiraIssueRegex { get; set; }
- 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 object JiraIssueTransitionAutomatic { get; set; }
- Type: object
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 string JiraIssueTransitionId { get; set; }
- 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 object MergeRequestsEvents { get; set; }
- Type: object
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 string ProjectKey { get; set; }
- 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 string[] ProjectKeys { get; set; }
- 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 object UseInheritedSettings { get; set; }
- Type: object
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 string Username { get; set; }
- 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}