`branchProtection` Submodule

Constructs

BranchProtection

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

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new BranchProtection(Construct Scope, string Id, BranchProtectionConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`BranchProtectionConfig`	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: BranchProtectionConfig

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".
`PutAllowedToMerge`	No description.
`PutAllowedToPush`	No description.
`PutAllowedToUnprotect`	No description.
`ResetAllowedToMerge`	No description.
`ResetAllowedToPush`	No description.
`ResetAllowedToUnprotect`	No description.
`ResetAllowForcePush`	No description.
`ResetCodeOwnerApprovalRequired`	No description.
`ResetMergeAccessLevel`	No description.
`ResetPushAccessLevel`	No description.
`ResetUnprotectAccessLevel`	No description.

`ToString`

private string ToString()

Returns a string representation of this construct.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

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`

private void ResetOverrideLogicalId()

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

`ToHclTerraform`

private object ToHclTerraform()

`ToMetadata`

private object ToMetadata()

`ToTerraform`

private object ToTerraform()

Adds this resource to the terraform JSON output.

`AddMoveTarget`

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.

`MoveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`HasResourceMove`

private object HasResourceMove()

`ImportFrom`

private void ImportFrom(string Id, TerraformProvider Provider = null)

`Id`^Required

Type: string

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`MoveFromId`

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.

`Id`^Required

Type: string

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

`MoveTo`

private void MoveTo(string MoveTarget, object Index = null)

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: object

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

`MoveToId`

private void MoveToId(string Id)

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".

`PutAllowedToMerge`

private void PutAllowedToMerge(object Value)

`Value`^Required

Type: object

`PutAllowedToPush`

private void PutAllowedToPush(object Value)

`Value`^Required

Type: object

`PutAllowedToUnprotect`

private void PutAllowedToUnprotect(object Value)

`Value`^Required

Type: object

`ResetAllowedToMerge`

private void ResetAllowedToMerge()

`ResetAllowedToPush`

private void ResetAllowedToPush()

`ResetAllowedToUnprotect`

private void ResetAllowedToUnprotect()

`ResetAllowForcePush`

private void ResetAllowForcePush()

`ResetCodeOwnerApprovalRequired`

private void ResetCodeOwnerApprovalRequired()

`ResetMergeAccessLevel`

private void ResetMergeAccessLevel()

`ResetPushAccessLevel`

private void ResetPushAccessLevel()

`ResetUnprotectAccessLevel`

private void ResetUnprotectAccessLevel()

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.
`IsTerraformResource`	No description.
`GenerateConfigForImport`	Generates CDKTF code for importing a BranchProtection resource upon running "cdktf plan ".

`IsConstruct`

using HashiCorp.Cdktf.Providers.Gitlab;

BranchProtection.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.

`X`^Required

Type: object

Any object.

`IsTerraformElement`

using HashiCorp.Cdktf.Providers.Gitlab;

BranchProtection.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Gitlab;

BranchProtection.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Gitlab;

BranchProtection.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a BranchProtection 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 BranchProtection to import.

`ImportFromId`^Required

Type: string

The id of the existing BranchProtection that should be imported.

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

`Provider`^Optional

Type: HashiCorp.Cdktf.TerraformProvider

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

Properties

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.
`AllowedToMerge`	`BranchProtectionAllowedToMergeList`	No description.
`AllowedToPush`	`BranchProtectionAllowedToPushList`	No description.
`AllowedToUnprotect`	`BranchProtectionAllowedToUnprotectList`	No description.
`BranchProtectionId`	`double`	No description.
`Id`	`string`	No description.
`AllowedToMergeInput`	`object`	No description.
`AllowedToPushInput`	`object`	No description.
`AllowedToUnprotectInput`	`object`	No description.
`AllowForcePushInput`	`object`	No description.
`BranchInput`	`string`	No description.
`CodeOwnerApprovalRequiredInput`	`object`	No description.
`MergeAccessLevelInput`	`string`	No description.
`ProjectInput`	`string`	No description.
`PushAccessLevelInput`	`string`	No description.
`UnprotectAccessLevelInput`	`string`	No description.
`AllowForcePush`	`object`	No description.
`Branch`	`string`	No description.
`CodeOwnerApprovalRequired`	`object`	No description.
`MergeAccessLevel`	`string`	No description.
`Project`	`string`	No description.
`PushAccessLevel`	`string`	No description.
`UnprotectAccessLevel`	`string`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: HashiCorp.Cdktf.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

Type: System.Collections.Generic.IDictionary<string, object>

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

public object Connection { get; }

Type: object

`Count`^Optional

public object Count { get; }

Type: object

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; }

Type: object[]

`AllowedToMerge`^Required

public BranchProtectionAllowedToMergeList AllowedToMerge { get; }

Type: BranchProtectionAllowedToMergeList

`AllowedToPush`^Required

public BranchProtectionAllowedToPushList AllowedToPush { get; }

Type: BranchProtectionAllowedToPushList

`AllowedToUnprotect`^Required

public BranchProtectionAllowedToUnprotectList AllowedToUnprotect { get; }

Type: BranchProtectionAllowedToUnprotectList

`BranchProtectionId`^Required

public double BranchProtectionId { get; }

Type: double

`Id`^Required

public string Id { get; }

Type: string

`AllowedToMergeInput`^Optional

public object AllowedToMergeInput { get; }

Type: object

`AllowedToPushInput`^Optional

public object AllowedToPushInput { get; }

Type: object

`AllowedToUnprotectInput`^Optional

public object AllowedToUnprotectInput { get; }

Type: object

`AllowForcePushInput`^Optional

public object AllowForcePushInput { get; }

Type: object

`BranchInput`^Optional

public string BranchInput { get; }

Type: string

`CodeOwnerApprovalRequiredInput`^Optional

public object CodeOwnerApprovalRequiredInput { get; }

Type: object

`MergeAccessLevelInput`^Optional

public string MergeAccessLevelInput { get; }

Type: string

`ProjectInput`^Optional

public string ProjectInput { get; }

Type: string

`PushAccessLevelInput`^Optional

public string PushAccessLevelInput { get; }

Type: string

`UnprotectAccessLevelInput`^Optional

public string UnprotectAccessLevelInput { get; }

Type: string

`AllowForcePush`^Required

public object AllowForcePush { get; }

Type: object

`Branch`^Required

public string Branch { get; }

Type: string

`CodeOwnerApprovalRequired`^Required

public object CodeOwnerApprovalRequired { get; }

Type: object

`MergeAccessLevel`^Required

public string MergeAccessLevel { get; }

Type: string

`Project`^Required

public string Project { get; }

Type: string

`PushAccessLevel`^Required

public string PushAccessLevel { get; }

Type: string

`UnprotectAccessLevel`^Required

public string UnprotectAccessLevel { get; }

Type: string

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

BranchProtectionAllowedToMerge

Initializer

using HashiCorp.Cdktf.Providers.Gitlab;

new BranchProtectionAllowedToMerge {
    double GroupId = null,
    double UserId = null
};

Properties

Name	Type	Description
`GroupId`	`double`	The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with `user_id`.
`UserId`	`double`	The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with `group_id`.

`GroupId`^Optional

public double GroupId { get; set; }

Type: double

The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with user_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#group_id BranchProtection#group_id}

`UserId`^Optional

public double UserId { get; set; }

Type: double

The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with group_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#user_id BranchProtection#user_id}

BranchProtectionAllowedToPush

Initializer

using HashiCorp.Cdktf.Providers.Gitlab;

new BranchProtectionAllowedToPush {
    double DeployKeyId = null,
    double GroupId = null,
    double UserId = null
};

Properties

Name	Type	Description
`DeployKeyId`	`double`	The ID of a GitLab deploy key allowed to perform the relevant action.
`GroupId`	`double`	The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with `deploy_key_id` and `user_id`.
`UserId`	`double`	The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with `deploy_key_id` and `group_id`.

`DeployKeyId`^Optional

public double DeployKeyId { get; set; }

Type: double

The ID of a GitLab deploy key allowed to perform the relevant action.

Mutually exclusive with group_id and user_id. This field is read-only until Gitlab 17.5.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#deploy_key_id BranchProtection#deploy_key_id}

`GroupId`^Optional

public double GroupId { get; set; }

Type: double

The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with deploy_key_id and user_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#group_id BranchProtection#group_id}

`UserId`^Optional

public double UserId { get; set; }

Type: double

The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with deploy_key_id and group_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#user_id BranchProtection#user_id}

BranchProtectionAllowedToUnprotect

Initializer

using HashiCorp.Cdktf.Providers.Gitlab;

new BranchProtectionAllowedToUnprotect {
    double GroupId = null,
    double UserId = null
};

Properties

Name	Type	Description
`GroupId`	`double`	The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with `user_id`.
`UserId`	`double`	The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with `group_id`.

`GroupId`^Optional

public double GroupId { get; set; }

Type: double

The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with user_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#group_id BranchProtection#group_id}

`UserId`^Optional

public double UserId { get; set; }

Type: double

The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with group_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#user_id BranchProtection#user_id}

BranchProtectionConfig

Initializer

using HashiCorp.Cdktf.Providers.Gitlab;

new BranchProtectionConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Branch,
    string Project,
    object AllowedToMerge = null,
    object AllowedToPush = null,
    object AllowedToUnprotect = null,
    object AllowForcePush = null,
    object CodeOwnerApprovalRequired = null,
    string MergeAccessLevel = null,
    string PushAccessLevel = null,
    string UnprotectAccessLevel = null
};

Properties

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.
`Branch`	`string`	Name of the branch.
`Project`	`string`	The id of the project.
`AllowedToMerge`	`object`	allowed_to_merge block.
`AllowedToPush`	`object`	allowed_to_push block.
`AllowedToUnprotect`	`object`	allowed_to_unprotect block.
`AllowForcePush`	`object`	Can be set to true to allow users with push access to force push.
`CodeOwnerApprovalRequired`	`object`	Can be set to true to require code owner approval before merging. Only available for Premium and Ultimate instances.
`MergeAccessLevel`	`string`	Access levels allowed to merge. Valid values are: `no one`, `developer`, `maintainer`.
`PushAccessLevel`	`string`	Access levels allowed to push. Valid values are: `no one`, `developer`, `maintainer`.
`UnprotectAccessLevel`	`string`	Access levels allowed to unprotect. Valid values are: `developer`, `maintainer`, `admin`.

`Connection`^Optional

public object Connection { get; set; }

Type: object

`Count`^Optional

public object Count { get; set; }

Type: object

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: HashiCorp.Cdktf.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; set; }

Type: object[]

`Branch`^Required

public string Branch { get; set; }

Type: string

Name of the branch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#branch BranchProtection#branch}

`Project`^Required

public string Project { get; set; }

Type: string

The id of the project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#project BranchProtection#project}

`AllowedToMerge`^Optional

public object AllowedToMerge { get; set; }

Type: object

allowed_to_merge block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#allowed_to_merge BranchProtection#allowed_to_merge}

`AllowedToPush`^Optional

public object AllowedToPush { get; set; }

Type: object

allowed_to_push block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#allowed_to_push BranchProtection#allowed_to_push}

`AllowedToUnprotect`^Optional

public object AllowedToUnprotect { get; set; }

Type: object

allowed_to_unprotect block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#allowed_to_unprotect BranchProtection#allowed_to_unprotect}

`AllowForcePush`^Optional

public object AllowForcePush { get; set; }

Type: object

Can be set to true to allow users with push access to force push.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#allow_force_push BranchProtection#allow_force_push}

`CodeOwnerApprovalRequired`^Optional

public object CodeOwnerApprovalRequired { get; set; }

Type: object

Can be set to true to require code owner approval before merging. Only available for Premium and Ultimate instances.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#code_owner_approval_required BranchProtection#code_owner_approval_required}

`MergeAccessLevel`^Optional

public string MergeAccessLevel { get; set; }

Type: string

Access levels allowed to merge. Valid values are: no one, developer, maintainer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#merge_access_level BranchProtection#merge_access_level}

`PushAccessLevel`^Optional

public string PushAccessLevel { get; set; }

Type: string

Access levels allowed to push. Valid values are: no one, developer, maintainer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#push_access_level BranchProtection#push_access_level}

`UnprotectAccessLevel`^Optional

public string UnprotectAccessLevel { get; set; }

Type: string

Access levels allowed to unprotect. Valid values are: developer, maintainer, admin.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/gitlabhq/gitlab/17.6.1/docs/resources/branch_protection#unprotect_access_level BranchProtection#unprotect_access_level}

Classes

BranchProtectionAllowedToMergeList

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new BranchProtectionAllowedToMergeList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`WrapsSet`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`WrapsSet`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`AllWithMapKey`	Creating an iterator for this complex list.
`ComputeFqn`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`AllWithMapKey`

private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`MapKeyAttributeName`^Required

Type: string

`ComputeFqn`

private string ComputeFqn()

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

private BranchProtectionAllowedToMergeOutputReference Get(double Index)

`Index`^Required

Type: double

the index of the item to return.

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

public string Fqn { get; }

Type: string

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

BranchProtectionAllowedToMergeOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new BranchProtectionAllowedToMergeOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`ComplexObjectIndex`	`double`	the index of this item in the list.
`ComplexObjectIsFromSet`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`ComplexObjectIndex`^Required

Type: double

the index of this item in the list.

`ComplexObjectIsFromSet`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`ComputeFqn`	No description.
`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.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`ResetGroupId`	No description.
`ResetUserId`	No description.

`ComputeFqn`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetGroupId`

private void ResetGroupId()

`ResetUserId`

private void ResetUserId()

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`AccessLevel`	`string`	No description.
`AccessLevelDescription`	`string`	No description.
`GroupIdInput`	`double`	No description.
`UserIdInput`	`double`	No description.
`GroupId`	`double`	No description.
`UserId`	`double`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

public string Fqn { get; }

Type: string

`AccessLevel`^Required

public string AccessLevel { get; }

Type: string

`AccessLevelDescription`^Required

public string AccessLevelDescription { get; }

Type: string

`GroupIdInput`^Optional

public double GroupIdInput { get; }

Type: double

`UserIdInput`^Optional

public double UserIdInput { get; }

Type: double

`GroupId`^Required

public double GroupId { get; }

Type: double

`UserId`^Required

public double UserId { get; }

Type: double

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

BranchProtectionAllowedToPushList

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new BranchProtectionAllowedToPushList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`WrapsSet`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`WrapsSet`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`AllWithMapKey`	Creating an iterator for this complex list.
`ComputeFqn`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`AllWithMapKey`

private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`MapKeyAttributeName`^Required

Type: string

`ComputeFqn`

private string ComputeFqn()

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

private BranchProtectionAllowedToPushOutputReference Get(double Index)

`Index`^Required

Type: double

the index of the item to return.

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

public string Fqn { get; }

Type: string

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

BranchProtectionAllowedToPushOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new BranchProtectionAllowedToPushOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`ComplexObjectIndex`	`double`	the index of this item in the list.
`ComplexObjectIsFromSet`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`ComplexObjectIndex`^Required

Type: double

the index of this item in the list.

`ComplexObjectIsFromSet`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`ComputeFqn`	No description.
`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.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`ResetDeployKeyId`	No description.
`ResetGroupId`	No description.
`ResetUserId`	No description.

`ComputeFqn`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetDeployKeyId`

private void ResetDeployKeyId()

`ResetGroupId`

private void ResetGroupId()

`ResetUserId`

private void ResetUserId()

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`AccessLevel`	`string`	No description.
`AccessLevelDescription`	`string`	No description.
`DeployKeyIdInput`	`double`	No description.
`GroupIdInput`	`double`	No description.
`UserIdInput`	`double`	No description.
`DeployKeyId`	`double`	No description.
`GroupId`	`double`	No description.
`UserId`	`double`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

public string Fqn { get; }

Type: string

`AccessLevel`^Required

public string AccessLevel { get; }

Type: string

`AccessLevelDescription`^Required

public string AccessLevelDescription { get; }

Type: string

`DeployKeyIdInput`^Optional

public double DeployKeyIdInput { get; }

Type: double

`GroupIdInput`^Optional

public double GroupIdInput { get; }

Type: double

`UserIdInput`^Optional

public double UserIdInput { get; }

Type: double

`DeployKeyId`^Required

public double DeployKeyId { get; }

Type: double

`GroupId`^Required

public double GroupId { get; }

Type: double

`UserId`^Required

public double UserId { get; }

Type: double

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

BranchProtectionAllowedToUnprotectList

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new BranchProtectionAllowedToUnprotectList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`WrapsSet`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`WrapsSet`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`AllWithMapKey`	Creating an iterator for this complex list.
`ComputeFqn`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`Get`	No description.

`AllWithMapKey`

private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`MapKeyAttributeName`^Required

Type: string

`ComputeFqn`

private string ComputeFqn()

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`Get`

private BranchProtectionAllowedToUnprotectOutputReference Get(double Index)

`Index`^Required

Type: double

the index of the item to return.

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

public string Fqn { get; }

Type: string

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

BranchProtectionAllowedToUnprotectOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Gitlab;

new BranchProtectionAllowedToUnprotectOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);

Name	Type	Description
`TerraformResource`	`HashiCorp.Cdktf.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`ComplexObjectIndex`	`double`	the index of this item in the list.
`ComplexObjectIsFromSet`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`TerraformResource`^Required

Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

`TerraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`ComplexObjectIndex`^Required

Type: double

the index of this item in the list.

`ComplexObjectIsFromSet`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`ComputeFqn`	No description.
`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.
`InterpolationForAttribute`	No description.
`Resolve`	Produce the Token's value at resolution time.
`ToString`	Return a string representation of this resolvable object.
`ResetGroupId`	No description.
`ResetUserId`	No description.

`ComputeFqn`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetGroupId`

private void ResetGroupId()

`ResetUserId`

private void ResetUserId()

Properties

Name	Type	Description
`CreationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`Fqn`	`string`	No description.
`AccessLevel`	`string`	No description.
`AccessLevelDescription`	`string`	No description.
`GroupIdInput`	`double`	No description.
`UserIdInput`	`double`	No description.
`GroupId`	`double`	No description.
`UserId`	`double`	No description.
`InternalValue`	`object`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`Fqn`^Required

public string Fqn { get; }

Type: string

`AccessLevel`^Required

public string AccessLevel { get; }

Type: string

`AccessLevelDescription`^Required

public string AccessLevelDescription { get; }

Type: string

`GroupIdInput`^Optional

public double GroupIdInput { get; }

Type: double

`UserIdInput`^Optional

public double UserIdInput { get; }

Type: double

`GroupId`^Required

public double GroupId { get; }

Type: double

`UserId`^Required

public double UserId { get; }

Type: double

`InternalValue`^Optional

public object InternalValue { get; }

Type: object

Files

branchProtection.csharp.md

Latest commit

History

branchProtection.csharp.md

File metadata and controls

branchProtection Submodule

Constructs