Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. ProjectIssueBoard
GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi
pulumi/pulumi-gitlab

gitlab.ProjectIssueBoard

Explore with Pulumi AI

gitlab logo
GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi
pulumi/pulumi-gitlab

    The gitlab.ProjectIssueBoard resource allows to manage the lifecycle of a Project Issue Board.

    NOTE: If the board lists are changed all lists will be recreated.

    Upstream API: GitLab REST API docs

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  example:
    type: gitlab:Project
    properties:
      name: example project
      description: Lorem Ipsum
      visibilityLevel: public
  exampleUser:
    type: gitlab:User
    name: example
    properties:
      name: example
      username: example
      email: example@example.com
      password: example1$$$
  exampleProjectMembership:
    type: gitlab:ProjectMembership
    name: example
    properties:
      projectId: ${example.id}
      userId: ${exampleUser.id}
      accessLevel: developer
  exampleProjectMilestone:
    type: gitlab:ProjectMilestone
    name: example
    properties:
      project: ${example.id}
      title: m1
  this:
    type: gitlab:ProjectIssueBoard
    properties:
      project: ${example.id}
      name: Test Issue Board
      lists:
        - assigneeId: ${exampleUser.id}
        - milestoneId: ${exampleProjectMilestone.milestoneId}
    options:
      dependson:
        - ${exampleProjectMembership}
  listSyntax:
    type: gitlab:ProjectIssueBoard
    name: list_syntax
    properties:
      project: ${example.id}
      name: Test Issue Board with list syntax
      lists:
        - assigneeId: ${exampleUser.id}
        - milestoneId: ${exampleProjectMilestone.milestoneId}
    options:
      dependson:
        - ${exampleProjectMembership}

    Create ProjectIssueBoard Resource

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

    Constructor syntax

    new ProjectIssueBoard(name: string, args: ProjectIssueBoardArgs, opts?: CustomResourceOptions);
    @overload
def ProjectIssueBoard(resource_name: str,
                      args: ProjectIssueBoardArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def ProjectIssueBoard(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      project: Optional[str] = None,
                      assignee_id: Optional[int] = None,
                      labels: Optional[Sequence[str]] = None,
                      lists: Optional[Sequence[ProjectIssueBoardListArgs]] = None,
                      milestone_id: Optional[int] = None,
                      name: Optional[str] = None,
                      weight: Optional[int] = None)
    func NewProjectIssueBoard(ctx *Context, name string, args ProjectIssueBoardArgs, opts ...ResourceOption) (*ProjectIssueBoard, error)
    public ProjectIssueBoard(string name, ProjectIssueBoardArgs args, CustomResourceOptions? opts = null)
    public ProjectIssueBoard(String name, ProjectIssueBoardArgs args)
public ProjectIssueBoard(String name, ProjectIssueBoardArgs args, CustomResourceOptions options)

    type: gitlab:ProjectIssueBoard
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 ProjectIssueBoardArgs
    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 ProjectIssueBoardArgs
    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 ProjectIssueBoardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectIssueBoardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectIssueBoardArgs
    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 projectIssueBoardResource = new GitLab.ProjectIssueBoard("projectIssueBoardResource", new()
{
    Project = "string",
    AssigneeId = 0,
    Labels = new[]
    {
        "string",
    },
    Lists = new[]
    {
        new GitLab.Inputs.ProjectIssueBoardListArgs
        {
            AssigneeId = 0,
            Id = 0,
            IterationId = 0,
            LabelId = 0,
            MilestoneId = 0,
            Position = 0,
        },
    },
    MilestoneId = 0,
    Name = "string",
    Weight = 0,
});

    example, err := gitlab.NewProjectIssueBoard(ctx, "projectIssueBoardResource", &gitlab.ProjectIssueBoardArgs{
	Project:    pulumi.String("string"),
	AssigneeId: pulumi.Int(0),
	Labels: pulumi.StringArray{
		pulumi.String("string"),
	},
	Lists: gitlab.ProjectIssueBoardListArray{
		&gitlab.ProjectIssueBoardListArgs{
			AssigneeId:  pulumi.Int(0),
			Id:          pulumi.Int(0),
			IterationId: pulumi.Int(0),
			LabelId:     pulumi.Int(0),
			MilestoneId: pulumi.Int(0),
			Position:    pulumi.Int(0),
		},
	},
	MilestoneId: pulumi.Int(0),
	Name:        pulumi.String("string"),
	Weight:      pulumi.Int(0),
})

    var projectIssueBoardResource = new ProjectIssueBoard("projectIssueBoardResource", ProjectIssueBoardArgs.builder()
    .project("string")
    .assigneeId(0)
    .labels("string")
    .lists(ProjectIssueBoardListArgs.builder()
        .assigneeId(0)
        .id(0)
        .iterationId(0)
        .labelId(0)
        .milestoneId(0)
        .position(0)
        .build())
    .milestoneId(0)
    .name("string")
    .weight(0)
    .build());

    project_issue_board_resource = gitlab.ProjectIssueBoard("projectIssueBoardResource",
    project="string",
    assignee_id=0,
    labels=["string"],
    lists=[{
        "assignee_id": 0,
        "id": 0,
        "iteration_id": 0,
        "label_id": 0,
        "milestone_id": 0,
        "position": 0,
    }],
    milestone_id=0,
    name="string",
    weight=0)

    const projectIssueBoardResource = new gitlab.ProjectIssueBoard("projectIssueBoardResource", {
    project: "string",
    assigneeId: 0,
    labels: ["string"],
    lists: [{
        assigneeId: 0,
        id: 0,
        iterationId: 0,
        labelId: 0,
        milestoneId: 0,
        position: 0,
    }],
    milestoneId: 0,
    name: "string",
    weight: 0,
});

    type: gitlab:ProjectIssueBoard
properties:
    assigneeId: 0
    labels:
        - string
    lists:
        - assigneeId: 0
          id: 0
          iterationId: 0
          labelId: 0
          milestoneId: 0
          position: 0
    milestoneId: 0
    name: string
    project: string
    weight: 0

    ProjectIssueBoard 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 ProjectIssueBoard resource accepts the following input properties:

    Project string
    The ID or full path of the project maintained by the authenticated user.
    AssigneeId int
    The assignee the board should be scoped to. Requires a GitLab EE license.
    Labels List<string>
    The list of label names which the board should be scoped to. Requires a GitLab EE license.
    Lists List<Pulumi.GitLab.Inputs.ProjectIssueBoardList>
    The list of issue board lists
    MilestoneId int
    The milestone the board should be scoped to. Requires a GitLab EE license.
    Name string
    The name of the board.
    Weight int
    The weight range from 0 to 9, to which the board should be scoped to. Requires a GitLab EE license.
    Project string
    The ID or full path of the project maintained by the authenticated user.
    AssigneeId int
    The assignee the board should be scoped to. Requires a GitLab EE license.
    Labels []string
    The list of label names which the board should be scoped to. Requires a GitLab EE license.
    Lists []ProjectIssueBoardListArgs
    The list of issue board lists
    MilestoneId int
    The milestone the board should be scoped to. Requires a GitLab EE license.
    Name string
    The name of the board.
    Weight int
    The weight range from 0 to 9, to which the board should be scoped to. Requires a GitLab EE license.
    project String
    The ID or full path of the project maintained by the authenticated user.
    assigneeId Integer
    The assignee the board should be scoped to. Requires a GitLab EE license.
    labels List<String>
    The list of label names which the board should be scoped to. Requires a GitLab EE license.
    lists List<ProjectIssueBoardList>
    The list of issue board lists
    milestoneId Integer
    The milestone the board should be scoped to. Requires a GitLab EE license.
    name String
    The name of the board.
    weight Integer
    The weight range from 0 to 9, to which the board should be scoped to. Requires a GitLab EE license.
    project string
    The ID or full path of the project maintained by the authenticated user.
    assigneeId number
    The assignee the board should be scoped to. Requires a GitLab EE license.
    labels string[]
    The list of label names which the board should be scoped to. Requires a GitLab EE license.
    lists ProjectIssueBoardList[]
    The list of issue board lists
    milestoneId number
    The milestone the board should be scoped to. Requires a GitLab EE license.
    name string
    The name of the board.
    weight number
    The weight range from 0 to 9, to which the board should be scoped to. Requires a GitLab EE license.
    project str
    The ID or full path of the project maintained by the authenticated user.
    assignee_id int
    The assignee the board should be scoped to. Requires a GitLab EE license.
    labels Sequence[str]
    The list of label names which the board should be scoped to. Requires a GitLab EE license.
    lists Sequence[ProjectIssueBoardListArgs]
    The list of issue board lists
    milestone_id int
    The milestone the board should be scoped to. Requires a GitLab EE license.
    name str
    The name of the board.
    weight int
    The weight range from 0 to 9, to which the board should be scoped to. Requires a GitLab EE license.
    project String
    The ID or full path of the project maintained by the authenticated user.
    assigneeId Number
    The assignee the board should be scoped to. Requires a GitLab EE license.
    labels List<String>
    The list of label names which the board should be scoped to. Requires a GitLab EE license.
    lists List<Property Map>
    The list of issue board lists
    milestoneId Number
    The milestone the board should be scoped to. Requires a GitLab EE license.
    name String
    The name of the board.
    weight Number
    The weight range from 0 to 9, to which the board should be scoped to. Requires a GitLab EE license.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ProjectIssueBoard 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 ProjectIssueBoard Resource

    Get an existing ProjectIssueBoard 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?: ProjectIssueBoardState, opts?: CustomResourceOptions): ProjectIssueBoard
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        assignee_id: Optional[int] = None,
        labels: Optional[Sequence[str]] = None,
        lists: Optional[Sequence[ProjectIssueBoardListArgs]] = None,
        milestone_id: Optional[int] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        weight: Optional[int] = None) -> ProjectIssueBoard
    func GetProjectIssueBoard(ctx *Context, name string, id IDInput, state *ProjectIssueBoardState, opts ...ResourceOption) (*ProjectIssueBoard, error)
    public static ProjectIssueBoard Get(string name, Input<string> id, ProjectIssueBoardState? state, CustomResourceOptions? opts = null)
    public static ProjectIssueBoard get(String name, Output<String> id, ProjectIssueBoardState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AssigneeId int
    The assignee the board should be scoped to. Requires a GitLab EE license.
    Labels List<string>
    The list of label names which the board should be scoped to. Requires a GitLab EE license.
    Lists List<Pulumi.GitLab.Inputs.ProjectIssueBoardList>
    The list of issue board lists
    MilestoneId int
    The milestone the board should be scoped to. Requires a GitLab EE license.
    Name string
    The name of the board.
    Project string
    The ID or full path of the project maintained by the authenticated user.
    Weight int
    The weight range from 0 to 9, to which the board should be scoped to. Requires a GitLab EE license.
    AssigneeId int
    The assignee the board should be scoped to. Requires a GitLab EE license.
    Labels []string
    The list of label names which the board should be scoped to. Requires a GitLab EE license.
    Lists []ProjectIssueBoardListArgs
    The list of issue board lists
    MilestoneId int
    The milestone the board should be scoped to. Requires a GitLab EE license.
    Name string
    The name of the board.
    Project string
    The ID or full path of the project maintained by the authenticated user.
    Weight int
    The weight range from 0 to 9, to which the board should be scoped to. Requires a GitLab EE license.
    assigneeId Integer
    The assignee the board should be scoped to. Requires a GitLab EE license.
    labels List<String>
    The list of label names which the board should be scoped to. Requires a GitLab EE license.
    lists List<ProjectIssueBoardList>
    The list of issue board lists
    milestoneId Integer
    The milestone the board should be scoped to. Requires a GitLab EE license.
    name String
    The name of the board.
    project String
    The ID or full path of the project maintained by the authenticated user.
    weight Integer
    The weight range from 0 to 9, to which the board should be scoped to. Requires a GitLab EE license.
    assigneeId number
    The assignee the board should be scoped to. Requires a GitLab EE license.
    labels string[]
    The list of label names which the board should be scoped to. Requires a GitLab EE license.
    lists ProjectIssueBoardList[]
    The list of issue board lists
    milestoneId number
    The milestone the board should be scoped to. Requires a GitLab EE license.
    name string
    The name of the board.
    project string
    The ID or full path of the project maintained by the authenticated user.
    weight number
    The weight range from 0 to 9, to which the board should be scoped to. Requires a GitLab EE license.
    assignee_id int
    The assignee the board should be scoped to. Requires a GitLab EE license.
    labels Sequence[str]
    The list of label names which the board should be scoped to. Requires a GitLab EE license.
    lists Sequence[ProjectIssueBoardListArgs]
    The list of issue board lists
    milestone_id int
    The milestone the board should be scoped to. Requires a GitLab EE license.
    name str
    The name of the board.
    project str
    The ID or full path of the project maintained by the authenticated user.
    weight int
    The weight range from 0 to 9, to which the board should be scoped to. Requires a GitLab EE license.
    assigneeId Number
    The assignee the board should be scoped to. Requires a GitLab EE license.
    labels List<String>
    The list of label names which the board should be scoped to. Requires a GitLab EE license.
    lists List<Property Map>
    The list of issue board lists
    milestoneId Number
    The milestone the board should be scoped to. Requires a GitLab EE license.
    name String
    The name of the board.
    project String
    The ID or full path of the project maintained by the authenticated user.
    weight Number
    The weight range from 0 to 9, to which the board should be scoped to. Requires a GitLab EE license.

    Supporting Types

    ProjectIssueBoardList, ProjectIssueBoardListArgs

    AssigneeId int
    The ID of the assignee the list should be scoped to. Requires a GitLab EE license.
    Id int
    The ID of the list
    IterationId int
    The ID of the iteration the list should be scoped to. Requires a GitLab EE license.
    LabelId int
    The ID of the label the list should be scoped to. Requires a GitLab EE license.
    MilestoneId int
    The ID of the milestone the list should be scoped to. Requires a GitLab EE license.
    Position int
    The position of the list within the board. The position for the list is based on the its position in the lists array.
    AssigneeId int
    The ID of the assignee the list should be scoped to. Requires a GitLab EE license.
    Id int
    The ID of the list
    IterationId int
    The ID of the iteration the list should be scoped to. Requires a GitLab EE license.
    LabelId int
    The ID of the label the list should be scoped to. Requires a GitLab EE license.
    MilestoneId int
    The ID of the milestone the list should be scoped to. Requires a GitLab EE license.
    Position int
    The position of the list within the board. The position for the list is based on the its position in the lists array.
    assigneeId Integer
    The ID of the assignee the list should be scoped to. Requires a GitLab EE license.
    id Integer
    The ID of the list
    iterationId Integer
    The ID of the iteration the list should be scoped to. Requires a GitLab EE license.
    labelId Integer
    The ID of the label the list should be scoped to. Requires a GitLab EE license.
    milestoneId Integer
    The ID of the milestone the list should be scoped to. Requires a GitLab EE license.
    position Integer
    The position of the list within the board. The position for the list is based on the its position in the lists array.
    assigneeId number
    The ID of the assignee the list should be scoped to. Requires a GitLab EE license.
    id number
    The ID of the list
    iterationId number
    The ID of the iteration the list should be scoped to. Requires a GitLab EE license.
    labelId number
    The ID of the label the list should be scoped to. Requires a GitLab EE license.
    milestoneId number
    The ID of the milestone the list should be scoped to. Requires a GitLab EE license.
    position number
    The position of the list within the board. The position for the list is based on the its position in the lists array.
    assignee_id int
    The ID of the assignee the list should be scoped to. Requires a GitLab EE license.
    id int
    The ID of the list
    iteration_id int
    The ID of the iteration the list should be scoped to. Requires a GitLab EE license.
    label_id int
    The ID of the label the list should be scoped to. Requires a GitLab EE license.
    milestone_id int
    The ID of the milestone the list should be scoped to. Requires a GitLab EE license.
    position int
    The position of the list within the board. The position for the list is based on the its position in the lists array.
    assigneeId Number
    The ID of the assignee the list should be scoped to. Requires a GitLab EE license.
    id Number
    The ID of the list
    iterationId Number
    The ID of the iteration the list should be scoped to. Requires a GitLab EE license.
    labelId Number
    The ID of the label the list should be scoped to. Requires a GitLab EE license.
    milestoneId Number
    The ID of the milestone the list should be scoped to. Requires a GitLab EE license.
    position Number
    The position of the list within the board. The position for the list is based on the its position in the lists array.

    Import

    You can import this resource with an id made up of {project-id}:{issue-board-id}, e.g.

    $ pulumi import gitlab:index/projectIssueBoard:ProjectIssueBoard kanban 42:1

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

    Package Details

    Repository
    GitLab pulumi/pulumi-gitlab
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the gitlab Terraform Provider.
    gitlab logo
    GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi
    pulumi/pulumi-gitlab