BranchProtection

# gitlab_branch_protection

This resource allows you to protect a specific branch by an access level so that the user with less access level cannot Merge/Push to the branch. GitLab EE features to protect by group or user are not supported.

Example Usage

using Pulumi;
using GitLab = Pulumi.GitLab;

class MyStack : Stack
{
    public MyStack()
    {
        var branchProtect = new GitLab.BranchProtection("branchProtect", new GitLab.BranchProtectionArgs
        {
            Branch = "BranchProtected",
            MergeAccessLevel = "developer",
            Project = "12345",
            PushAccessLevel = "developer",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-gitlab/sdk/v4/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.NewBranchProtection(ctx, "branchProtect", &gitlab.BranchProtectionArgs{
			Branch:           pulumi.String("BranchProtected"),
			MergeAccessLevel: pulumi.String("developer"),
			Project:          pulumi.String("12345"),
			PushAccessLevel:  pulumi.String("developer"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_gitlab as gitlab

branch_protect = gitlab.BranchProtection("branchProtect",
    branch="BranchProtected",
    merge_access_level="developer",
    project="12345",
    push_access_level="developer")
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const branchProtect = new gitlab.BranchProtection("BranchProtect", {
    branch: "BranchProtected",
    mergeAccessLevel: "developer",
    project: "12345",
    pushAccessLevel: "developer",
});

Create a BranchProtection Resource

new BranchProtection(name: string, args: BranchProtectionArgs, opts?: CustomResourceOptions);
@overload
def BranchProtection(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     branch: Optional[str] = None,
                     code_owner_approval_required: Optional[bool] = None,
                     merge_access_level: Optional[str] = None,
                     project: Optional[str] = None,
                     push_access_level: Optional[str] = None)
@overload
def BranchProtection(resource_name: str,
                     args: BranchProtectionArgs,
                     opts: Optional[ResourceOptions] = None)
func NewBranchProtection(ctx *Context, name string, args BranchProtectionArgs, opts ...ResourceOption) (*BranchProtection, error)
public BranchProtection(string name, BranchProtectionArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args BranchProtectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args BranchProtectionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args BranchProtectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BranchProtectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

BranchProtection Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The BranchProtection resource accepts the following input properties:

Branch string
Name of the branch.
MergeAccessLevel string
One of five levels of access to the project.
Project string
The id of the project.
PushAccessLevel string
One of five levels of access to the project.
CodeOwnerApprovalRequired bool
Bool, defaults to false. Can be set to true to require code owner approval before merging.
Branch string
Name of the branch.
MergeAccessLevel string
One of five levels of access to the project.
Project string
The id of the project.
PushAccessLevel string
One of five levels of access to the project.
CodeOwnerApprovalRequired bool
Bool, defaults to false. Can be set to true to require code owner approval before merging.
branch string
Name of the branch.
mergeAccessLevel string
One of five levels of access to the project.
project string
The id of the project.
pushAccessLevel string
One of five levels of access to the project.
codeOwnerApprovalRequired boolean
Bool, defaults to false. Can be set to true to require code owner approval before merging.
branch str
Name of the branch.
merge_access_level str
One of five levels of access to the project.
project str
The id of the project.
push_access_level str
One of five levels of access to the project.
code_owner_approval_required bool
Bool, defaults to false. Can be set to true to require code owner approval before merging.

Outputs

All input properties are implicitly available as output properties. Additionally, the BranchProtection resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing BranchProtection Resource

Get an existing BranchProtection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BranchProtectionState, opts?: CustomResourceOptions): BranchProtection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        branch: Optional[str] = None,
        code_owner_approval_required: Optional[bool] = None,
        merge_access_level: Optional[str] = None,
        project: Optional[str] = None,
        push_access_level: Optional[str] = None) -> BranchProtection
func GetBranchProtection(ctx *Context, name string, id IDInput, state *BranchProtectionState, opts ...ResourceOption) (*BranchProtection, error)
public static BranchProtection Get(string name, Input<string> id, BranchProtectionState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Branch string
Name of the branch.
CodeOwnerApprovalRequired bool
Bool, defaults to false. Can be set to true to require code owner approval before merging.
MergeAccessLevel string
One of five levels of access to the project.
Project string
The id of the project.
PushAccessLevel string
One of five levels of access to the project.
Branch string
Name of the branch.
CodeOwnerApprovalRequired bool
Bool, defaults to false. Can be set to true to require code owner approval before merging.
MergeAccessLevel string
One of five levels of access to the project.
Project string
The id of the project.
PushAccessLevel string
One of five levels of access to the project.
branch string
Name of the branch.
codeOwnerApprovalRequired boolean
Bool, defaults to false. Can be set to true to require code owner approval before merging.
mergeAccessLevel string
One of five levels of access to the project.
project string
The id of the project.
pushAccessLevel string
One of five levels of access to the project.
branch str
Name of the branch.
code_owner_approval_required bool
Bool, defaults to false. Can be set to true to require code owner approval before merging.
merge_access_level str
One of five levels of access to the project.
project str
The id of the project.
push_access_level str
One of five levels of access to the project.

Package Details

Repository
https://github.com/pulumi/pulumi-gitlab
License
Apache-2.0
Notes
This Pulumi package is based on the gitlab Terraform Provider.