1. Packages
  2. Bitbucket Provider
  3. API Docs
  4. ProjectBranchingModel
bitbucket 2.46.0 published on Monday, Apr 14, 2025 by drfaust92

bitbucket.ProjectBranchingModel

Explore with Pulumi AI

bitbucket logo
bitbucket 2.46.0 published on Monday, Apr 14, 2025 by drfaust92

    Provides a Bitbucket project branching model resource.

    This allows you for setting up branching models for your project.

    OAuth2 Scopes: project:admin

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as bitbucket from "@pulumi/bitbucket";
    
    const exampleProject = new bitbucket.Project("exampleProject", {
        owner: "example",
        key: "FFFFF",
    });
    const exampleProjectBranchingModel = new bitbucket.ProjectBranchingModel("exampleProjectBranchingModel", {
        workspace: "example",
        project: exampleProject.key,
        development: {
            useMainbranch: true,
        },
        branchTypes: [
            {
                enabled: true,
                kind: "feature",
                prefix: "example/",
            },
            {
                enabled: true,
                kind: "hotfix",
                prefix: "hotfix/",
            },
            {
                enabled: true,
                kind: "release",
                prefix: "release/",
            },
            {
                enabled: true,
                kind: "bugfix",
                prefix: "bugfix/",
            },
        ],
    });
    
    import pulumi
    import pulumi_bitbucket as bitbucket
    
    example_project = bitbucket.Project("exampleProject",
        owner="example",
        key="FFFFF")
    example_project_branching_model = bitbucket.ProjectBranchingModel("exampleProjectBranchingModel",
        workspace="example",
        project=example_project.key,
        development={
            "use_mainbranch": True,
        },
        branch_types=[
            {
                "enabled": True,
                "kind": "feature",
                "prefix": "example/",
            },
            {
                "enabled": True,
                "kind": "hotfix",
                "prefix": "hotfix/",
            },
            {
                "enabled": True,
                "kind": "release",
                "prefix": "release/",
            },
            {
                "enabled": True,
                "kind": "bugfix",
                "prefix": "bugfix/",
            },
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/bitbucket/v2/bitbucket"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleProject, err := bitbucket.NewProject(ctx, "exampleProject", &bitbucket.ProjectArgs{
    			Owner: pulumi.String("example"),
    			Key:   pulumi.String("FFFFF"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = bitbucket.NewProjectBranchingModel(ctx, "exampleProjectBranchingModel", &bitbucket.ProjectBranchingModelArgs{
    			Workspace: pulumi.String("example"),
    			Project:   exampleProject.Key,
    			Development: &bitbucket.ProjectBranchingModelDevelopmentArgs{
    				UseMainbranch: pulumi.Bool(true),
    			},
    			BranchTypes: bitbucket.ProjectBranchingModelBranchTypeArray{
    				&bitbucket.ProjectBranchingModelBranchTypeArgs{
    					Enabled: pulumi.Bool(true),
    					Kind:    pulumi.String("feature"),
    					Prefix:  pulumi.String("example/"),
    				},
    				&bitbucket.ProjectBranchingModelBranchTypeArgs{
    					Enabled: pulumi.Bool(true),
    					Kind:    pulumi.String("hotfix"),
    					Prefix:  pulumi.String("hotfix/"),
    				},
    				&bitbucket.ProjectBranchingModelBranchTypeArgs{
    					Enabled: pulumi.Bool(true),
    					Kind:    pulumi.String("release"),
    					Prefix:  pulumi.String("release/"),
    				},
    				&bitbucket.ProjectBranchingModelBranchTypeArgs{
    					Enabled: pulumi.Bool(true),
    					Kind:    pulumi.String("bugfix"),
    					Prefix:  pulumi.String("bugfix/"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Bitbucket = Pulumi.Bitbucket;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleProject = new Bitbucket.Project("exampleProject", new()
        {
            Owner = "example",
            Key = "FFFFF",
        });
    
        var exampleProjectBranchingModel = new Bitbucket.ProjectBranchingModel("exampleProjectBranchingModel", new()
        {
            Workspace = "example",
            Project = exampleProject.Key,
            Development = new Bitbucket.Inputs.ProjectBranchingModelDevelopmentArgs
            {
                UseMainbranch = true,
            },
            BranchTypes = new[]
            {
                new Bitbucket.Inputs.ProjectBranchingModelBranchTypeArgs
                {
                    Enabled = true,
                    Kind = "feature",
                    Prefix = "example/",
                },
                new Bitbucket.Inputs.ProjectBranchingModelBranchTypeArgs
                {
                    Enabled = true,
                    Kind = "hotfix",
                    Prefix = "hotfix/",
                },
                new Bitbucket.Inputs.ProjectBranchingModelBranchTypeArgs
                {
                    Enabled = true,
                    Kind = "release",
                    Prefix = "release/",
                },
                new Bitbucket.Inputs.ProjectBranchingModelBranchTypeArgs
                {
                    Enabled = true,
                    Kind = "bugfix",
                    Prefix = "bugfix/",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.bitbucket.Project;
    import com.pulumi.bitbucket.ProjectArgs;
    import com.pulumi.bitbucket.ProjectBranchingModel;
    import com.pulumi.bitbucket.ProjectBranchingModelArgs;
    import com.pulumi.bitbucket.inputs.ProjectBranchingModelDevelopmentArgs;
    import com.pulumi.bitbucket.inputs.ProjectBranchingModelBranchTypeArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var exampleProject = new Project("exampleProject", ProjectArgs.builder()
                .owner("example")
                .key("FFFFF")
                .build());
    
            var exampleProjectBranchingModel = new ProjectBranchingModel("exampleProjectBranchingModel", ProjectBranchingModelArgs.builder()
                .workspace("example")
                .project(exampleProject.key())
                .development(ProjectBranchingModelDevelopmentArgs.builder()
                    .useMainbranch(true)
                    .build())
                .branchTypes(            
                    ProjectBranchingModelBranchTypeArgs.builder()
                        .enabled(true)
                        .kind("feature")
                        .prefix("example/")
                        .build(),
                    ProjectBranchingModelBranchTypeArgs.builder()
                        .enabled(true)
                        .kind("hotfix")
                        .prefix("hotfix/")
                        .build(),
                    ProjectBranchingModelBranchTypeArgs.builder()
                        .enabled(true)
                        .kind("release")
                        .prefix("release/")
                        .build(),
                    ProjectBranchingModelBranchTypeArgs.builder()
                        .enabled(true)
                        .kind("bugfix")
                        .prefix("bugfix/")
                        .build())
                .build());
    
        }
    }
    
    resources:
      exampleProject:
        type: bitbucket:Project
        properties:
          owner: example
          key: FFFFF
      exampleProjectBranchingModel:
        type: bitbucket:ProjectBranchingModel
        properties:
          workspace: example
          project: ${exampleProject.key}
          development:
            useMainbranch: true
          branchTypes:
            - enabled: true
              kind: feature
              prefix: example/
            - enabled: true
              kind: hotfix
              prefix: hotfix/
            - enabled: true
              kind: release
              prefix: release/
            - enabled: true
              kind: bugfix
              prefix: bugfix/
    

    Create ProjectBranchingModel Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ProjectBranchingModel(name: string, args: ProjectBranchingModelArgs, opts?: CustomResourceOptions);
    @overload
    def ProjectBranchingModel(resource_name: str,
                              args: ProjectBranchingModelArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def ProjectBranchingModel(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              development: Optional[ProjectBranchingModelDevelopmentArgs] = None,
                              project: Optional[str] = None,
                              workspace: Optional[str] = None,
                              branch_types: Optional[Sequence[ProjectBranchingModelBranchTypeArgs]] = None,
                              production: Optional[ProjectBranchingModelProductionArgs] = None,
                              project_branching_model_id: Optional[str] = None)
    func NewProjectBranchingModel(ctx *Context, name string, args ProjectBranchingModelArgs, opts ...ResourceOption) (*ProjectBranchingModel, error)
    public ProjectBranchingModel(string name, ProjectBranchingModelArgs args, CustomResourceOptions? opts = null)
    public ProjectBranchingModel(String name, ProjectBranchingModelArgs args)
    public ProjectBranchingModel(String name, ProjectBranchingModelArgs args, CustomResourceOptions options)
    
    type: bitbucket:ProjectBranchingModel
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ProjectBranchingModelArgs
    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 ProjectBranchingModelArgs
    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 ProjectBranchingModelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectBranchingModelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectBranchingModelArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var projectBranchingModelResource = new Bitbucket.ProjectBranchingModel("projectBranchingModelResource", new()
    {
        Development = new Bitbucket.Inputs.ProjectBranchingModelDevelopmentArgs
        {
            BranchDoesNotExist = false,
            IsValid = false,
            Name = "string",
            UseMainbranch = false,
        },
        Project = "string",
        Workspace = "string",
        BranchTypes = new[]
        {
            new Bitbucket.Inputs.ProjectBranchingModelBranchTypeArgs
            {
                Kind = "string",
                Enabled = false,
                Prefix = "string",
            },
        },
        Production = new Bitbucket.Inputs.ProjectBranchingModelProductionArgs
        {
            BranchDoesNotExist = false,
            Enabled = false,
            IsValid = false,
            Name = "string",
            UseMainbranch = false,
        },
        ProjectBranchingModelId = "string",
    });
    
    example, err := bitbucket.NewProjectBranchingModel(ctx, "projectBranchingModelResource", &bitbucket.ProjectBranchingModelArgs{
    	Development: &bitbucket.ProjectBranchingModelDevelopmentArgs{
    		BranchDoesNotExist: pulumi.Bool(false),
    		IsValid:            pulumi.Bool(false),
    		Name:               pulumi.String("string"),
    		UseMainbranch:      pulumi.Bool(false),
    	},
    	Project:   pulumi.String("string"),
    	Workspace: pulumi.String("string"),
    	BranchTypes: bitbucket.ProjectBranchingModelBranchTypeArray{
    		&bitbucket.ProjectBranchingModelBranchTypeArgs{
    			Kind:    pulumi.String("string"),
    			Enabled: pulumi.Bool(false),
    			Prefix:  pulumi.String("string"),
    		},
    	},
    	Production: &bitbucket.ProjectBranchingModelProductionArgs{
    		BranchDoesNotExist: pulumi.Bool(false),
    		Enabled:            pulumi.Bool(false),
    		IsValid:            pulumi.Bool(false),
    		Name:               pulumi.String("string"),
    		UseMainbranch:      pulumi.Bool(false),
    	},
    	ProjectBranchingModelId: pulumi.String("string"),
    })
    
    var projectBranchingModelResource = new ProjectBranchingModel("projectBranchingModelResource", ProjectBranchingModelArgs.builder()
        .development(ProjectBranchingModelDevelopmentArgs.builder()
            .branchDoesNotExist(false)
            .isValid(false)
            .name("string")
            .useMainbranch(false)
            .build())
        .project("string")
        .workspace("string")
        .branchTypes(ProjectBranchingModelBranchTypeArgs.builder()
            .kind("string")
            .enabled(false)
            .prefix("string")
            .build())
        .production(ProjectBranchingModelProductionArgs.builder()
            .branchDoesNotExist(false)
            .enabled(false)
            .isValid(false)
            .name("string")
            .useMainbranch(false)
            .build())
        .projectBranchingModelId("string")
        .build());
    
    project_branching_model_resource = bitbucket.ProjectBranchingModel("projectBranchingModelResource",
        development={
            "branch_does_not_exist": False,
            "is_valid": False,
            "name": "string",
            "use_mainbranch": False,
        },
        project="string",
        workspace="string",
        branch_types=[{
            "kind": "string",
            "enabled": False,
            "prefix": "string",
        }],
        production={
            "branch_does_not_exist": False,
            "enabled": False,
            "is_valid": False,
            "name": "string",
            "use_mainbranch": False,
        },
        project_branching_model_id="string")
    
    const projectBranchingModelResource = new bitbucket.ProjectBranchingModel("projectBranchingModelResource", {
        development: {
            branchDoesNotExist: false,
            isValid: false,
            name: "string",
            useMainbranch: false,
        },
        project: "string",
        workspace: "string",
        branchTypes: [{
            kind: "string",
            enabled: false,
            prefix: "string",
        }],
        production: {
            branchDoesNotExist: false,
            enabled: false,
            isValid: false,
            name: "string",
            useMainbranch: false,
        },
        projectBranchingModelId: "string",
    });
    
    type: bitbucket:ProjectBranchingModel
    properties:
        branchTypes:
            - enabled: false
              kind: string
              prefix: string
        development:
            branchDoesNotExist: false
            isValid: false
            name: string
            useMainbranch: false
        production:
            branchDoesNotExist: false
            enabled: false
            isValid: false
            name: string
            useMainbranch: false
        project: string
        projectBranchingModelId: string
        workspace: string
    

    ProjectBranchingModel Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ProjectBranchingModel resource accepts the following input properties:

    Development ProjectBranchingModelDevelopment
    The development branch can be configured to a specific branch or to track the main branch. When set to a specific branch it must currently exist. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a development property will leave the development branch unchanged. See Development below.
    Project string
    The key of the project.
    Workspace string
    The workspace of this project. Can be you or any team you have write access to.
    BranchTypes List<ProjectBranchingModelBranchType>
    A set of branch type to define feature, bugfix, release, hotfix prefixes. See Branch Type below.
    Production ProjectBranchingModelProduction
    The production branch can be a specific branch, the main branch or disabled. When set to a specific branch it must currently exist. The enabled property can be used to enable (true) or disable (false) it. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a production property will leave the production branch unchanged. See Production below.
    ProjectBranchingModelId string
    Development ProjectBranchingModelDevelopmentArgs
    The development branch can be configured to a specific branch or to track the main branch. When set to a specific branch it must currently exist. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a development property will leave the development branch unchanged. See Development below.
    Project string
    The key of the project.
    Workspace string
    The workspace of this project. Can be you or any team you have write access to.
    BranchTypes []ProjectBranchingModelBranchTypeArgs
    A set of branch type to define feature, bugfix, release, hotfix prefixes. See Branch Type below.
    Production ProjectBranchingModelProductionArgs
    The production branch can be a specific branch, the main branch or disabled. When set to a specific branch it must currently exist. The enabled property can be used to enable (true) or disable (false) it. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a production property will leave the production branch unchanged. See Production below.
    ProjectBranchingModelId string
    development ProjectBranchingModelDevelopment
    The development branch can be configured to a specific branch or to track the main branch. When set to a specific branch it must currently exist. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a development property will leave the development branch unchanged. See Development below.
    project String
    The key of the project.
    workspace String
    The workspace of this project. Can be you or any team you have write access to.
    branchTypes List<ProjectBranchingModelBranchType>
    A set of branch type to define feature, bugfix, release, hotfix prefixes. See Branch Type below.
    production ProjectBranchingModelProduction
    The production branch can be a specific branch, the main branch or disabled. When set to a specific branch it must currently exist. The enabled property can be used to enable (true) or disable (false) it. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a production property will leave the production branch unchanged. See Production below.
    projectBranchingModelId String
    development ProjectBranchingModelDevelopment
    The development branch can be configured to a specific branch or to track the main branch. When set to a specific branch it must currently exist. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a development property will leave the development branch unchanged. See Development below.
    project string
    The key of the project.
    workspace string
    The workspace of this project. Can be you or any team you have write access to.
    branchTypes ProjectBranchingModelBranchType[]
    A set of branch type to define feature, bugfix, release, hotfix prefixes. See Branch Type below.
    production ProjectBranchingModelProduction
    The production branch can be a specific branch, the main branch or disabled. When set to a specific branch it must currently exist. The enabled property can be used to enable (true) or disable (false) it. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a production property will leave the production branch unchanged. See Production below.
    projectBranchingModelId string
    development ProjectBranchingModelDevelopmentArgs
    The development branch can be configured to a specific branch or to track the main branch. When set to a specific branch it must currently exist. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a development property will leave the development branch unchanged. See Development below.
    project str
    The key of the project.
    workspace str
    The workspace of this project. Can be you or any team you have write access to.
    branch_types Sequence[ProjectBranchingModelBranchTypeArgs]
    A set of branch type to define feature, bugfix, release, hotfix prefixes. See Branch Type below.
    production ProjectBranchingModelProductionArgs
    The production branch can be a specific branch, the main branch or disabled. When set to a specific branch it must currently exist. The enabled property can be used to enable (true) or disable (false) it. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a production property will leave the production branch unchanged. See Production below.
    project_branching_model_id str
    development Property Map
    The development branch can be configured to a specific branch or to track the main branch. When set to a specific branch it must currently exist. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a development property will leave the development branch unchanged. See Development below.
    project String
    The key of the project.
    workspace String
    The workspace of this project. Can be you or any team you have write access to.
    branchTypes List<Property Map>
    A set of branch type to define feature, bugfix, release, hotfix prefixes. See Branch Type below.
    production Property Map
    The production branch can be a specific branch, the main branch or disabled. When set to a specific branch it must currently exist. The enabled property can be used to enable (true) or disable (false) it. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a production property will leave the production branch unchanged. See Production below.
    projectBranchingModelId String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ProjectBranchingModel 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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ProjectBranchingModel Resource

    Get an existing ProjectBranchingModel 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?: ProjectBranchingModelState, opts?: CustomResourceOptions): ProjectBranchingModel
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            branch_types: Optional[Sequence[ProjectBranchingModelBranchTypeArgs]] = None,
            development: Optional[ProjectBranchingModelDevelopmentArgs] = None,
            production: Optional[ProjectBranchingModelProductionArgs] = None,
            project: Optional[str] = None,
            project_branching_model_id: Optional[str] = None,
            workspace: Optional[str] = None) -> ProjectBranchingModel
    func GetProjectBranchingModel(ctx *Context, name string, id IDInput, state *ProjectBranchingModelState, opts ...ResourceOption) (*ProjectBranchingModel, error)
    public static ProjectBranchingModel Get(string name, Input<string> id, ProjectBranchingModelState? state, CustomResourceOptions? opts = null)
    public static ProjectBranchingModel get(String name, Output<String> id, ProjectBranchingModelState state, CustomResourceOptions options)
    resources:  _:    type: bitbucket:ProjectBranchingModel    get:      id: ${id}
    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.
    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:
    BranchTypes List<ProjectBranchingModelBranchType>
    A set of branch type to define feature, bugfix, release, hotfix prefixes. See Branch Type below.
    Development ProjectBranchingModelDevelopment
    The development branch can be configured to a specific branch or to track the main branch. When set to a specific branch it must currently exist. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a development property will leave the development branch unchanged. See Development below.
    Production ProjectBranchingModelProduction
    The production branch can be a specific branch, the main branch or disabled. When set to a specific branch it must currently exist. The enabled property can be used to enable (true) or disable (false) it. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a production property will leave the production branch unchanged. See Production below.
    Project string
    The key of the project.
    ProjectBranchingModelId string
    Workspace string
    The workspace of this project. Can be you or any team you have write access to.
    BranchTypes []ProjectBranchingModelBranchTypeArgs
    A set of branch type to define feature, bugfix, release, hotfix prefixes. See Branch Type below.
    Development ProjectBranchingModelDevelopmentArgs
    The development branch can be configured to a specific branch or to track the main branch. When set to a specific branch it must currently exist. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a development property will leave the development branch unchanged. See Development below.
    Production ProjectBranchingModelProductionArgs
    The production branch can be a specific branch, the main branch or disabled. When set to a specific branch it must currently exist. The enabled property can be used to enable (true) or disable (false) it. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a production property will leave the production branch unchanged. See Production below.
    Project string
    The key of the project.
    ProjectBranchingModelId string
    Workspace string
    The workspace of this project. Can be you or any team you have write access to.
    branchTypes List<ProjectBranchingModelBranchType>
    A set of branch type to define feature, bugfix, release, hotfix prefixes. See Branch Type below.
    development ProjectBranchingModelDevelopment
    The development branch can be configured to a specific branch or to track the main branch. When set to a specific branch it must currently exist. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a development property will leave the development branch unchanged. See Development below.
    production ProjectBranchingModelProduction
    The production branch can be a specific branch, the main branch or disabled. When set to a specific branch it must currently exist. The enabled property can be used to enable (true) or disable (false) it. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a production property will leave the production branch unchanged. See Production below.
    project String
    The key of the project.
    projectBranchingModelId String
    workspace String
    The workspace of this project. Can be you or any team you have write access to.
    branchTypes ProjectBranchingModelBranchType[]
    A set of branch type to define feature, bugfix, release, hotfix prefixes. See Branch Type below.
    development ProjectBranchingModelDevelopment
    The development branch can be configured to a specific branch or to track the main branch. When set to a specific branch it must currently exist. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a development property will leave the development branch unchanged. See Development below.
    production ProjectBranchingModelProduction
    The production branch can be a specific branch, the main branch or disabled. When set to a specific branch it must currently exist. The enabled property can be used to enable (true) or disable (false) it. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a production property will leave the production branch unchanged. See Production below.
    project string
    The key of the project.
    projectBranchingModelId string
    workspace string
    The workspace of this project. Can be you or any team you have write access to.
    branch_types Sequence[ProjectBranchingModelBranchTypeArgs]
    A set of branch type to define feature, bugfix, release, hotfix prefixes. See Branch Type below.
    development ProjectBranchingModelDevelopmentArgs
    The development branch can be configured to a specific branch or to track the main branch. When set to a specific branch it must currently exist. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a development property will leave the development branch unchanged. See Development below.
    production ProjectBranchingModelProductionArgs
    The production branch can be a specific branch, the main branch or disabled. When set to a specific branch it must currently exist. The enabled property can be used to enable (true) or disable (false) it. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a production property will leave the production branch unchanged. See Production below.
    project str
    The key of the project.
    project_branching_model_id str
    workspace str
    The workspace of this project. Can be you or any team you have write access to.
    branchTypes List<Property Map>
    A set of branch type to define feature, bugfix, release, hotfix prefixes. See Branch Type below.
    development Property Map
    The development branch can be configured to a specific branch or to track the main branch. When set to a specific branch it must currently exist. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a development property will leave the development branch unchanged. See Development below.
    production Property Map
    The production branch can be a specific branch, the main branch or disabled. When set to a specific branch it must currently exist. The enabled property can be used to enable (true) or disable (false) it. Only the passed properties will be updated. The properties not passed will be left unchanged. A request without a production property will leave the production branch unchanged. See Production below.
    project String
    The key of the project.
    projectBranchingModelId String
    workspace String
    The workspace of this project. Can be you or any team you have write access to.

    Supporting Types

    ProjectBranchingModelBranchType, ProjectBranchingModelBranchTypeArgs

    Kind string
    The kind of the branch type. Valid values are feature, bugfix, release, hotfix.
    Enabled bool
    Whether the branch type is enabled or not. A disabled branch type may contain an invalid prefix.
    Prefix string
    The prefix for this branch type. A branch with this prefix will be classified as per kind. The prefix of an enabled branch type must be a valid branch prefix. Additionally, it cannot be blank, empty or null. The prefix for a disabled branch type can be empty or invalid.
    Kind string
    The kind of the branch type. Valid values are feature, bugfix, release, hotfix.
    Enabled bool
    Whether the branch type is enabled or not. A disabled branch type may contain an invalid prefix.
    Prefix string
    The prefix for this branch type. A branch with this prefix will be classified as per kind. The prefix of an enabled branch type must be a valid branch prefix. Additionally, it cannot be blank, empty or null. The prefix for a disabled branch type can be empty or invalid.
    kind String
    The kind of the branch type. Valid values are feature, bugfix, release, hotfix.
    enabled Boolean
    Whether the branch type is enabled or not. A disabled branch type may contain an invalid prefix.
    prefix String
    The prefix for this branch type. A branch with this prefix will be classified as per kind. The prefix of an enabled branch type must be a valid branch prefix. Additionally, it cannot be blank, empty or null. The prefix for a disabled branch type can be empty or invalid.
    kind string
    The kind of the branch type. Valid values are feature, bugfix, release, hotfix.
    enabled boolean
    Whether the branch type is enabled or not. A disabled branch type may contain an invalid prefix.
    prefix string
    The prefix for this branch type. A branch with this prefix will be classified as per kind. The prefix of an enabled branch type must be a valid branch prefix. Additionally, it cannot be blank, empty or null. The prefix for a disabled branch type can be empty or invalid.
    kind str
    The kind of the branch type. Valid values are feature, bugfix, release, hotfix.
    enabled bool
    Whether the branch type is enabled or not. A disabled branch type may contain an invalid prefix.
    prefix str
    The prefix for this branch type. A branch with this prefix will be classified as per kind. The prefix of an enabled branch type must be a valid branch prefix. Additionally, it cannot be blank, empty or null. The prefix for a disabled branch type can be empty or invalid.
    kind String
    The kind of the branch type. Valid values are feature, bugfix, release, hotfix.
    enabled Boolean
    Whether the branch type is enabled or not. A disabled branch type may contain an invalid prefix.
    prefix String
    The prefix for this branch type. A branch with this prefix will be classified as per kind. The prefix of an enabled branch type must be a valid branch prefix. Additionally, it cannot be blank, empty or null. The prefix for a disabled branch type can be empty or invalid.

    ProjectBranchingModelDevelopment, ProjectBranchingModelDevelopmentArgs

    BranchDoesNotExist bool
    Optional and only returned for a project's branching model. Indicates if the indicated branch exists on the project (false) or not (true). This is useful for determining a fallback to the mainbranch when a project is inheriting its project's branching model.
    IsValid bool
    Name string
    The configured branch. It must be null when use_mainbranch is true. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set).
    UseMainbranch bool
    Indicates if the setting points at an explicit branch (false) or tracks the main branch (true). When true the name must be null or not provided. When false the name must contain a non-empty branch name.
    BranchDoesNotExist bool
    Optional and only returned for a project's branching model. Indicates if the indicated branch exists on the project (false) or not (true). This is useful for determining a fallback to the mainbranch when a project is inheriting its project's branching model.
    IsValid bool
    Name string
    The configured branch. It must be null when use_mainbranch is true. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set).
    UseMainbranch bool
    Indicates if the setting points at an explicit branch (false) or tracks the main branch (true). When true the name must be null or not provided. When false the name must contain a non-empty branch name.
    branchDoesNotExist Boolean
    Optional and only returned for a project's branching model. Indicates if the indicated branch exists on the project (false) or not (true). This is useful for determining a fallback to the mainbranch when a project is inheriting its project's branching model.
    isValid Boolean
    name String
    The configured branch. It must be null when use_mainbranch is true. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set).
    useMainbranch Boolean
    Indicates if the setting points at an explicit branch (false) or tracks the main branch (true). When true the name must be null or not provided. When false the name must contain a non-empty branch name.
    branchDoesNotExist boolean
    Optional and only returned for a project's branching model. Indicates if the indicated branch exists on the project (false) or not (true). This is useful for determining a fallback to the mainbranch when a project is inheriting its project's branching model.
    isValid boolean
    name string
    The configured branch. It must be null when use_mainbranch is true. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set).
    useMainbranch boolean
    Indicates if the setting points at an explicit branch (false) or tracks the main branch (true). When true the name must be null or not provided. When false the name must contain a non-empty branch name.
    branch_does_not_exist bool
    Optional and only returned for a project's branching model. Indicates if the indicated branch exists on the project (false) or not (true). This is useful for determining a fallback to the mainbranch when a project is inheriting its project's branching model.
    is_valid bool
    name str
    The configured branch. It must be null when use_mainbranch is true. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set).
    use_mainbranch bool
    Indicates if the setting points at an explicit branch (false) or tracks the main branch (true). When true the name must be null or not provided. When false the name must contain a non-empty branch name.
    branchDoesNotExist Boolean
    Optional and only returned for a project's branching model. Indicates if the indicated branch exists on the project (false) or not (true). This is useful for determining a fallback to the mainbranch when a project is inheriting its project's branching model.
    isValid Boolean
    name String
    The configured branch. It must be null when use_mainbranch is true. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set).
    useMainbranch Boolean
    Indicates if the setting points at an explicit branch (false) or tracks the main branch (true). When true the name must be null or not provided. When false the name must contain a non-empty branch name.

    ProjectBranchingModelProduction, ProjectBranchingModelProductionArgs

    BranchDoesNotExist bool
    Optional and only returned for a project's branching model. Indicates if the indicated branch exists on the project (false) or not (true). This is useful for determining a fallback to the mainbranch when a project is inheriting its project's branching model.
    Enabled bool
    Indicates if branch is enabled or not.
    IsValid bool
    Name string
    The configured branch. It must be null when use_mainbranch is true. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set).
    UseMainbranch bool
    Indicates if the setting points at an explicit branch (false) or tracks the main branch (true). When true the name must be null or not provided. When false the name must contain a non-empty branch name.
    BranchDoesNotExist bool
    Optional and only returned for a project's branching model. Indicates if the indicated branch exists on the project (false) or not (true). This is useful for determining a fallback to the mainbranch when a project is inheriting its project's branching model.
    Enabled bool
    Indicates if branch is enabled or not.
    IsValid bool
    Name string
    The configured branch. It must be null when use_mainbranch is true. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set).
    UseMainbranch bool
    Indicates if the setting points at an explicit branch (false) or tracks the main branch (true). When true the name must be null or not provided. When false the name must contain a non-empty branch name.
    branchDoesNotExist Boolean
    Optional and only returned for a project's branching model. Indicates if the indicated branch exists on the project (false) or not (true). This is useful for determining a fallback to the mainbranch when a project is inheriting its project's branching model.
    enabled Boolean
    Indicates if branch is enabled or not.
    isValid Boolean
    name String
    The configured branch. It must be null when use_mainbranch is true. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set).
    useMainbranch Boolean
    Indicates if the setting points at an explicit branch (false) or tracks the main branch (true). When true the name must be null or not provided. When false the name must contain a non-empty branch name.
    branchDoesNotExist boolean
    Optional and only returned for a project's branching model. Indicates if the indicated branch exists on the project (false) or not (true). This is useful for determining a fallback to the mainbranch when a project is inheriting its project's branching model.
    enabled boolean
    Indicates if branch is enabled or not.
    isValid boolean
    name string
    The configured branch. It must be null when use_mainbranch is true. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set).
    useMainbranch boolean
    Indicates if the setting points at an explicit branch (false) or tracks the main branch (true). When true the name must be null or not provided. When false the name must contain a non-empty branch name.
    branch_does_not_exist bool
    Optional and only returned for a project's branching model. Indicates if the indicated branch exists on the project (false) or not (true). This is useful for determining a fallback to the mainbranch when a project is inheriting its project's branching model.
    enabled bool
    Indicates if branch is enabled or not.
    is_valid bool
    name str
    The configured branch. It must be null when use_mainbranch is true. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set).
    use_mainbranch bool
    Indicates if the setting points at an explicit branch (false) or tracks the main branch (true). When true the name must be null or not provided. When false the name must contain a non-empty branch name.
    branchDoesNotExist Boolean
    Optional and only returned for a project's branching model. Indicates if the indicated branch exists on the project (false) or not (true). This is useful for determining a fallback to the mainbranch when a project is inheriting its project's branching model.
    enabled Boolean
    Indicates if branch is enabled or not.
    isValid Boolean
    name String
    The configured branch. It must be null when use_mainbranch is true. Otherwise it must be a non-empty value. It is possible for the configured branch to not exist (e.g. it was deleted after the settings are set).
    useMainbranch Boolean
    Indicates if the setting points at an explicit branch (false) or tracks the main branch (true). When true the name must be null or not provided. When false the name must contain a non-empty branch name.

    Import

    Branching Models can be imported using the workspace and project separated by a (/), e.g.,

    $ pulumi import bitbucket:index/projectBranchingModel:ProjectBranchingModel example workspace/project
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    bitbucket drfaust92/terraform-provider-bitbucket
    License
    Notes
    This Pulumi package is based on the bitbucket Terraform Provider.
    bitbucket logo
    bitbucket 2.46.0 published on Monday, Apr 14, 2025 by drfaust92