projectApprovalRule.typescript.md

projectApprovalRule Submodule

Constructs

ProjectApprovalRule

Represents a {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_approval_rule gitlab_project_approval_rule}.

Initializers

import { projectApprovalRule } from '@cdktf/provider-gitlab'

new projectApprovalRule.ProjectApprovalRule(scope: Construct, id: string, config: ProjectApprovalRuleConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	ProjectApprovalRuleConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: ProjectApprovalRuleConfig

---

Methods

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".
resetAppliesToAllProtectedBranches	No description.
resetDisableImportingDefaultAnyApproverRuleOnCreate	No description.
resetGroupIds	No description.
resetId	No description.
resetProtectedBranchIds	No description.
resetRuleType	No description.
resetUserIds	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

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

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

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

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

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

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

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

---

index^Optional

• Type: string | number

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

---

moveToId

public moveToId(id: string): void

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

id^Required

• Type: string

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

---

resetAppliesToAllProtectedBranches

public resetAppliesToAllProtectedBranches(): void

resetDisableImportingDefaultAnyApproverRuleOnCreate

public resetDisableImportingDefaultAnyApproverRuleOnCreate(): void

resetGroupIds

public resetGroupIds(): void

resetId

public resetId(): void

resetProtectedBranchIds

public resetProtectedBranchIds(): void

resetRuleType

public resetRuleType(): void

resetUserIds

public resetUserIds(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a ProjectApprovalRule resource upon running "cdktf plan ".

---

isConstruct

import { projectApprovalRule } from '@cdktf/provider-gitlab'

projectApprovalRule.ProjectApprovalRule.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { projectApprovalRule } from '@cdktf/provider-gitlab'

projectApprovalRule.ProjectApprovalRule.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { projectApprovalRule } from '@cdktf/provider-gitlab'

projectApprovalRule.ProjectApprovalRule.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { projectApprovalRule } from '@cdktf/provider-gitlab'

projectApprovalRule.ProjectApprovalRule.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing ProjectApprovalRule that should be imported.

Refer to the {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_approval_rule#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
appliesToAllProtectedBranchesInput	boolean | cdktf.IResolvable	No description.
approvalsRequiredInput	number	No description.
disableImportingDefaultAnyApproverRuleOnCreateInput	boolean | cdktf.IResolvable	No description.
groupIdsInput	number[]	No description.
idInput	string	No description.
nameInput	string	No description.
projectInput	string	No description.
protectedBranchIdsInput	number[]	No description.
ruleTypeInput	string	No description.
userIdsInput	number[]	No description.
appliesToAllProtectedBranches	boolean | cdktf.IResolvable	No description.
approvalsRequired	number	No description.
disableImportingDefaultAnyApproverRuleOnCreate	boolean | cdktf.IResolvable	No description.
groupIds	number[]	No description.
id	string	No description.
name	string	No description.
project	string	No description.
protectedBranchIds	number[]	No description.
ruleType	string	No description.
userIds	number[]	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

appliesToAllProtectedBranchesInput^Optional

public readonly appliesToAllProtectedBranchesInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

approvalsRequiredInput^Optional

public readonly approvalsRequiredInput: number;

• Type: number

---

disableImportingDefaultAnyApproverRuleOnCreateInput^Optional

public readonly disableImportingDefaultAnyApproverRuleOnCreateInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

groupIdsInput^Optional

public readonly groupIdsInput: number[];

• Type: number[]

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

projectInput^Optional

public readonly projectInput: string;

• Type: string

---

protectedBranchIdsInput^Optional

public readonly protectedBranchIdsInput: number[];

• Type: number[]

---

ruleTypeInput^Optional

public readonly ruleTypeInput: string;

• Type: string

---

userIdsInput^Optional

public readonly userIdsInput: number[];

• Type: number[]

---

appliesToAllProtectedBranches^Required

public readonly appliesToAllProtectedBranches: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

approvalsRequired^Required

public readonly approvalsRequired: number;

• Type: number

---

disableImportingDefaultAnyApproverRuleOnCreate^Required

public readonly disableImportingDefaultAnyApproverRuleOnCreate: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

groupIds^Required

public readonly groupIds: number[];

• Type: number[]

---

id^Required

public readonly id: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

project^Required

public readonly project: string;

• Type: string

---

protectedBranchIds^Required

public readonly protectedBranchIds: number[];

• Type: number[]

---

ruleType^Required

public readonly ruleType: string;

• Type: string

---

userIds^Required

public readonly userIds: number[];

• Type: number[]

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ProjectApprovalRuleConfig

Initializer

import { projectApprovalRule } from '@cdktf/provider-gitlab'

const projectApprovalRuleConfig: projectApprovalRule.ProjectApprovalRuleConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
approvalsRequired	number	The number of approvals required for this rule.
name	string	The name of the approval rule.
project	string	The name or id of the project to add the approval rules.
appliesToAllProtectedBranches	boolean | cdktf.IResolvable	Whether the rule is applied to all protected branches.
disableImportingDefaultAnyApproverRuleOnCreate	boolean | cdktf.IResolvable	When this flag is set, the default any_approver rule will not be imported if present.
groupIds	number[]	A list of group IDs whose members can approve of the merge request.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_approval_rule#id ProjectApprovalRule#id}.
protectedBranchIds	number[]	A list of protected branch IDs (not branch names) for which the rule applies.
ruleType	string	String, defaults to 'regular'.
userIds	number[]	A list of specific User IDs to add to the list of approvers.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

approvalsRequired^Required

public readonly approvalsRequired: number;

• Type: number

The number of approvals required for this rule.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_approval_rule#approvals_required ProjectApprovalRule#approvals_required}

---

name^Required

public readonly name: string;

• Type: string

The name of the approval rule.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_approval_rule#name ProjectApprovalRule#name}

---

project^Required

public readonly project: string;

• Type: string

The name or id of the project to add the approval rules.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_approval_rule#project ProjectApprovalRule#project}

---

appliesToAllProtectedBranches^Optional

public readonly appliesToAllProtectedBranches: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Whether the rule is applied to all protected branches.

If set to 'true', the value of protected_branch_ids is ignored. Default is 'false'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_approval_rule#applies_to_all_protected_branches ProjectApprovalRule#applies_to_all_protected_branches}

---

disableImportingDefaultAnyApproverRuleOnCreate^Optional

public readonly disableImportingDefaultAnyApproverRuleOnCreate: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

When this flag is set, the default any_approver rule will not be imported if present.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_approval_rule#disable_importing_default_any_approver_rule_on_create ProjectApprovalRule#disable_importing_default_any_approver_rule_on_create}

---

groupIds^Optional

public readonly groupIds: number[];

• Type: number[]

A list of group IDs whose members can approve of the merge request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_approval_rule#group_ids ProjectApprovalRule#group_ids}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_approval_rule#id ProjectApprovalRule#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.

---

protectedBranchIds^Optional

public readonly protectedBranchIds: number[];

• Type: number[]

A list of protected branch IDs (not branch names) for which the rule applies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_approval_rule#protected_branch_ids ProjectApprovalRule#protected_branch_ids}

---

ruleType^Optional

public readonly ruleType: string;

• Type: string

String, defaults to 'regular'.

The type of rule. any_approver is a pre-configured default rule with approvals_required at 0. Valid values are regular, any_approver.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_approval_rule#rule_type ProjectApprovalRule#rule_type}

---

userIds^Optional

public readonly userIds: number[];

• Type: number[]

A list of specific User IDs to add to the list of approvers.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.0.1/docs/resources/project_approval_rule#user_ids ProjectApprovalRule#user_ids}

---