Documentation
¶
Index ¶
- func IntegrationJira_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func IntegrationJira_IsConstruct(x interface{}) *bool
- func IntegrationJira_IsTerraformElement(x interface{}) *bool
- func IntegrationJira_IsTerraformResource(x interface{}) *bool
- func IntegrationJira_TfResourceType() *string
- func NewIntegrationJira_Override(i IntegrationJira, scope constructs.Construct, id *string, ...)
- type IntegrationJira
- type IntegrationJiraConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IntegrationJira_GenerateConfigForImport ¶
func IntegrationJira_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a IntegrationJira resource upon running "cdktf plan <stack-name>".
func IntegrationJira_IsConstruct ¶
func IntegrationJira_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func IntegrationJira_IsTerraformElement ¶
func IntegrationJira_IsTerraformElement(x interface{}) *bool
Experimental.
func IntegrationJira_IsTerraformResource ¶
func IntegrationJira_IsTerraformResource(x interface{}) *bool
Experimental.
func IntegrationJira_TfResourceType ¶
func IntegrationJira_TfResourceType() *string
func NewIntegrationJira_Override ¶
func NewIntegrationJira_Override(i IntegrationJira, scope constructs.Construct, id *string, config *IntegrationJiraConfig)
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/integration_jira gitlab_integration_jira} Resource.
Types ¶
type IntegrationJira ¶
type IntegrationJira interface {
cdktf.TerraformResource
Active() cdktf.IResolvable
ApiUrl() *string
SetApiUrl(val *string)
ApiUrlInput() *string
// Experimental.
CdktfStack() cdktf.TerraformStack
CommentOnEventEnabled() interface{}
SetCommentOnEventEnabled(val interface{})
CommentOnEventEnabledInput() interface{}
CommitEvents() interface{}
SetCommitEvents(val interface{})
CommitEventsInput() interface{}
// Experimental.
Connection() interface{}
// Experimental.
SetConnection(val interface{})
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
// Experimental.
Count() interface{}
// Experimental.
SetCount(val interface{})
CreatedAt() *string
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*string)
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
Id() *string
SetId(val *string)
IdInput() *string
IssuesEnabled() interface{}
SetIssuesEnabled(val interface{})
IssuesEnabledInput() interface{}
JiraAuthType() *float64
SetJiraAuthType(val *float64)
JiraAuthTypeInput() *float64
JiraIssuePrefix() *string
SetJiraIssuePrefix(val *string)
JiraIssuePrefixInput() *string
JiraIssueRegex() *string
SetJiraIssueRegex(val *string)
JiraIssueRegexInput() *string
JiraIssueTransitionAutomatic() interface{}
SetJiraIssueTransitionAutomatic(val interface{})
JiraIssueTransitionAutomaticInput() interface{}
JiraIssueTransitionId() *string
SetJiraIssueTransitionId(val *string)
JiraIssueTransitionIdInput() *string
// Experimental.
Lifecycle() *cdktf.TerraformResourceLifecycle
// Experimental.
SetLifecycle(val *cdktf.TerraformResourceLifecycle)
MergeRequestsEvents() interface{}
SetMergeRequestsEvents(val interface{})
MergeRequestsEventsInput() interface{}
// The tree node.
Node() constructs.Node
Password() *string
SetPassword(val *string)
PasswordInput() *string
Project() *string
SetProject(val *string)
ProjectInput() *string
ProjectKey() *string
SetProjectKey(val *string)
ProjectKeyInput() *string
ProjectKeys() *[]*string
SetProjectKeys(val *[]*string)
ProjectKeysInput() *[]*string
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
// Experimental.
RawOverrides() interface{}
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *string
Title() *string
UpdatedAt() *string
Url() *string
SetUrl(val *string)
UrlInput() *string
UseInheritedSettings() interface{}
SetUseInheritedSettings(val interface{})
UseInheritedSettingsInput() interface{}
Username() *string
SetUsername(val *string)
UsernameInput() *string
// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
// Experimental.
AddMoveTarget(moveTarget *string)
// Experimental.
AddOverride(path *string, value interface{})
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
HasResourceMove() interface{}
// Experimental.
ImportFrom(id *string, provider cdktf.TerraformProvider)
// Experimental.
InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
// Move the resource corresponding to "id" to this resource.
//
// Note that the resource being moved from must be marked as moved using it's instance function.
// Experimental.
MoveFromId(id *string)
// Moves this resource to the target resource given by moveTarget.
// Experimental.
MoveTo(moveTarget *string, index interface{})
// Moves this resource to the resource corresponding to "id".
// Experimental.
MoveToId(id *string)
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
ResetApiUrl()
ResetCommentOnEventEnabled()
ResetCommitEvents()
ResetId()
ResetIssuesEnabled()
ResetJiraAuthType()
ResetJiraIssuePrefix()
ResetJiraIssueRegex()
ResetJiraIssueTransitionAutomatic()
ResetJiraIssueTransitionId()
ResetMergeRequestsEvents()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetProjectKey()
ResetProjectKeys()
ResetUseInheritedSettings()
ResetUsername()
SynthesizeAttributes() *map[string]interface{}
SynthesizeHclAttributes() *map[string]interface{}
// Experimental.
ToHclTerraform() interface{}
// Experimental.
ToMetadata() interface{}
// Returns a string representation of this construct.
ToString() *string
// Adds this resource to the terraform JSON output.
// Experimental.
ToTerraform() interface{}
}
Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/integration_jira gitlab_integration_jira}.
func NewIntegrationJira ¶
func NewIntegrationJira(scope constructs.Construct, id *string, config *IntegrationJiraConfig) IntegrationJira
Create a new {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/integration_jira gitlab_integration_jira} Resource.
type IntegrationJiraConfig ¶
type IntegrationJiraConfig struct {
// Experimental.
Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
// Experimental.
Count interface{} `field:"optional" json:"count" yaml:"count"`
// Experimental.
DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
// Experimental.
ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
// Experimental.
Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
// Experimental.
Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
// Experimental.
Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
// 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.7.0/docs/resources/integration_jira#password IntegrationJira#password}
Password *string `field:"required" json:"password" yaml:"password"`
// ID of the project you want to activate integration on.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/integration_jira#project IntegrationJira#project}
Project *string `field:"required" json:"project" yaml:"project"`
// 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.7.0/docs/resources/integration_jira#url IntegrationJira#url}
Url *string `field:"required" json:"url" yaml:"url"`
// 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.7.0/docs/resources/integration_jira#api_url IntegrationJira#api_url}
ApiUrl *string `field:"optional" json:"apiUrl" yaml:"apiUrl"`
// 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.7.0/docs/resources/integration_jira#comment_on_event_enabled IntegrationJira#comment_on_event_enabled}
CommentOnEventEnabled interface{} `field:"optional" json:"commentOnEventEnabled" yaml:"commentOnEventEnabled"`
// Enable notifications for commit events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/integration_jira#commit_events IntegrationJira#commit_events}
CommitEvents interface{} `field:"optional" json:"commitEvents" yaml:"commitEvents"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/integration_jira#id IntegrationJira#id}.
//
// Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
// If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
Id *string `field:"optional" json:"id" yaml:"id"`
// Enable viewing Jira issues in GitLab.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/integration_jira#issues_enabled IntegrationJira#issues_enabled}
IssuesEnabled interface{} `field:"optional" json:"issuesEnabled" yaml:"issuesEnabled"`
// 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.7.0/docs/resources/integration_jira#jira_auth_type IntegrationJira#jira_auth_type}
JiraAuthType *float64 `field:"optional" json:"jiraAuthType" yaml:"jiraAuthType"`
// Prefix to match Jira issue keys.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/integration_jira#jira_issue_prefix IntegrationJira#jira_issue_prefix}
JiraIssuePrefix *string `field:"optional" json:"jiraIssuePrefix" yaml:"jiraIssuePrefix"`
// Regular expression to match Jira issue keys.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/integration_jira#jira_issue_regex IntegrationJira#jira_issue_regex}
JiraIssueRegex *string `field:"optional" json:"jiraIssueRegex" yaml:"jiraIssueRegex"`
// Enable automatic issue transitions.
//
// Takes precedence over jira_issue_transition_id if enabled. Defaults to false. This value cannot be imported, and will not perform drift detection if changed outside Terraform.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/integration_jira#jira_issue_transition_automatic IntegrationJira#jira_issue_transition_automatic}
JiraIssueTransitionAutomatic interface{} `field:"optional" json:"jiraIssueTransitionAutomatic" yaml:"jiraIssueTransitionAutomatic"`
// 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.7.0/docs/resources/integration_jira#jira_issue_transition_id IntegrationJira#jira_issue_transition_id}
JiraIssueTransitionId *string `field:"optional" json:"jiraIssueTransitionId" yaml:"jiraIssueTransitionId"`
// Enable notifications for merge request events.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/integration_jira#merge_requests_events IntegrationJira#merge_requests_events}
MergeRequestsEvents interface{} `field:"optional" json:"mergeRequestsEvents" yaml:"mergeRequestsEvents"`
// 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.7.0/docs/resources/integration_jira#project_key IntegrationJira#project_key}
ProjectKey *string `field:"optional" json:"projectKey" yaml:"projectKey"`
// 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.7.0/docs/resources/integration_jira#project_keys IntegrationJira#project_keys}
ProjectKeys *[]*string `field:"optional" json:"projectKeys" yaml:"projectKeys"`
// Indicates whether or not to inherit default settings. Defaults to false.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.7.0/docs/resources/integration_jira#use_inherited_settings IntegrationJira#use_inherited_settings}
UseInheritedSettings interface{} `field:"optional" json:"useInheritedSettings" yaml:"useInheritedSettings"`
// 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.7.0/docs/resources/integration_jira#username IntegrationJira#username}
Username *string `field:"optional" json:"username" yaml:"username"`
}