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

gitlab.GroupEpicBoard

Explore with Pulumi AI

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

    The gitlab.GroupEpicBoard resource allows to manage the lifecycle of a epic board in a group.

    Multiple epic boards on one group requires a GitLab Premium or above License.

    Upstream API: GitLab REST API docs

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = new gitlab.Group("example", {
    name: "test_group",
    path: "test_group",
    description: "An example group",
});
const label1 = new gitlab.GroupLabel("label_1", {
    group: example.id,
    color: "#FF0000",
    name: "red-label",
});
const label3 = new gitlab.GroupLabel("label_3", {
    group: example.id,
    name: "label-3",
    color: "#003000",
});
const epicBoard = new gitlab.GroupEpicBoard("epic_board", {
    name: "epic board 6",
    group: example.path,
    lists: [{
        labelId: label1.labelId,
    }],
});

    import pulumi
import pulumi_gitlab as gitlab

example = gitlab.Group("example",
    name="test_group",
    path="test_group",
    description="An example group")
label1 = gitlab.GroupLabel("label_1",
    group=example.id,
    color="#FF0000",
    name="red-label")
label3 = gitlab.GroupLabel("label_3",
    group=example.id,
    name="label-3",
    color="#003000")
epic_board = gitlab.GroupEpicBoard("epic_board",
    name="epic board 6",
    group=example.path,
    lists=[{
        "label_id": label1.label_id,
    }])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := gitlab.NewGroup(ctx, "example", &gitlab.GroupArgs{
			Name:        pulumi.String("test_group"),
			Path:        pulumi.String("test_group"),
			Description: pulumi.String("An example group"),
		})
		if err != nil {
			return err
		}
		label1, err := gitlab.NewGroupLabel(ctx, "label_1", &gitlab.GroupLabelArgs{
			Group: example.ID(),
			Color: pulumi.String("#FF0000"),
			Name:  pulumi.String("red-label"),
		})
		if err != nil {
			return err
		}
		_, err = gitlab.NewGroupLabel(ctx, "label_3", &gitlab.GroupLabelArgs{
			Group: example.ID(),
			Name:  pulumi.String("label-3"),
			Color: pulumi.String("#003000"),
		})
		if err != nil {
			return err
		}
		_, err = gitlab.NewGroupEpicBoard(ctx, "epic_board", &gitlab.GroupEpicBoardArgs{
			Name:  pulumi.String("epic board 6"),
			Group: example.Path,
			Lists: gitlab.GroupEpicBoardListArray{
				&gitlab.GroupEpicBoardListArgs{
					LabelId: label1.LabelId,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;

return await Deployment.RunAsync(() => 
{
    var example = new GitLab.Group("example", new()
    {
        Name = "test_group",
        Path = "test_group",
        Description = "An example group",
    });

    var label1 = new GitLab.GroupLabel("label_1", new()
    {
        Group = example.Id,
        Color = "#FF0000",
        Name = "red-label",
    });

    var label3 = new GitLab.GroupLabel("label_3", new()
    {
        Group = example.Id,
        Name = "label-3",
        Color = "#003000",
    });

    var epicBoard = new GitLab.GroupEpicBoard("epic_board", new()
    {
        Name = "epic board 6",
        Group = example.Path,
        Lists = new[]
        {
            new GitLab.Inputs.GroupEpicBoardListArgs
            {
                LabelId = label1.LabelId,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.Group;
import com.pulumi.gitlab.GroupArgs;
import com.pulumi.gitlab.GroupLabel;
import com.pulumi.gitlab.GroupLabelArgs;
import com.pulumi.gitlab.GroupEpicBoard;
import com.pulumi.gitlab.GroupEpicBoardArgs;
import com.pulumi.gitlab.inputs.GroupEpicBoardListArgs;
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 example = new Group("example", GroupArgs.builder()
            .name("test_group")
            .path("test_group")
            .description("An example group")
            .build());

        var label1 = new GroupLabel("label1", GroupLabelArgs.builder()
            .group(example.id())
            .color("#FF0000")
            .name("red-label")
            .build());

        var label3 = new GroupLabel("label3", GroupLabelArgs.builder()
            .group(example.id())
            .name("label-3")
            .color("#003000")
            .build());

        var epicBoard = new GroupEpicBoard("epicBoard", GroupEpicBoardArgs.builder()
            .name("epic board 6")
            .group(example.path())
            .lists(GroupEpicBoardListArgs.builder()
                .labelId(label1.labelId())
                .build())
            .build());

    }
}

    resources:
  example:
    type: gitlab:Group
    properties:
      name: test_group
      path: test_group
      description: An example group
  label1:
    type: gitlab:GroupLabel
    name: label_1
    properties:
      group: ${example.id}
      color: '#FF0000'
      name: red-label
  label3:
    type: gitlab:GroupLabel
    name: label_3
    properties:
      group: ${example.id}
      name: label-3
      color: '#003000'
  epicBoard:
    type: gitlab:GroupEpicBoard
    name: epic_board
    properties:
      name: epic board 6
      group: ${example.path}
      lists:
        - labelId: ${label1.labelId}

    Create GroupEpicBoard Resource

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

    Constructor syntax

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

@overload
def GroupEpicBoard(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   group: Optional[str] = None,
                   lists: Optional[Sequence[GroupEpicBoardListArgs]] = None,
                   name: Optional[str] = None)
    func NewGroupEpicBoard(ctx *Context, name string, args GroupEpicBoardArgs, opts ...ResourceOption) (*GroupEpicBoard, error)
    public GroupEpicBoard(string name, GroupEpicBoardArgs args, CustomResourceOptions? opts = null)
    public GroupEpicBoard(String name, GroupEpicBoardArgs args)
public GroupEpicBoard(String name, GroupEpicBoardArgs args, CustomResourceOptions options)

    type: gitlab:GroupEpicBoard
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 GroupEpicBoardArgs
    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 GroupEpicBoardArgs
    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 GroupEpicBoardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupEpicBoardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupEpicBoardArgs
    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 groupEpicBoardResource = new GitLab.GroupEpicBoard("groupEpicBoardResource", new()
{
    Group = "string",
    Lists = new[]
    {
        new GitLab.Inputs.GroupEpicBoardListArgs
        {
            Id = 0,
            LabelId = 0,
            Position = 0,
        },
    },
    Name = "string",
});

    example, err := gitlab.NewGroupEpicBoard(ctx, "groupEpicBoardResource", &gitlab.GroupEpicBoardArgs{
	Group: pulumi.String("string"),
	Lists: gitlab.GroupEpicBoardListArray{
		&gitlab.GroupEpicBoardListArgs{
			Id:       pulumi.Int(0),
			LabelId:  pulumi.Int(0),
			Position: pulumi.Int(0),
		},
	},
	Name: pulumi.String("string"),
})

    var groupEpicBoardResource = new GroupEpicBoard("groupEpicBoardResource", GroupEpicBoardArgs.builder()
    .group("string")
    .lists(GroupEpicBoardListArgs.builder()
        .id(0)
        .labelId(0)
        .position(0)
        .build())
    .name("string")
    .build());

    group_epic_board_resource = gitlab.GroupEpicBoard("groupEpicBoardResource",
    group="string",
    lists=[{
        "id": 0,
        "label_id": 0,
        "position": 0,
    }],
    name="string")

    const groupEpicBoardResource = new gitlab.GroupEpicBoard("groupEpicBoardResource", {
    group: "string",
    lists: [{
        id: 0,
        labelId: 0,
        position: 0,
    }],
    name: "string",
});

    type: gitlab:GroupEpicBoard
properties:
    group: string
    lists:
        - id: 0
          labelId: 0
          position: 0
    name: string

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

    Group string
    The ID or URL-encoded path of the group owned by the authenticated user.
    Lists List<Pulumi.GitLab.Inputs.GroupEpicBoardList>
    The list of epic board lists.
    Name string
    The name of the board.
    Group string
    The ID or URL-encoded path of the group owned by the authenticated user.
    Lists []GroupEpicBoardListArgs
    The list of epic board lists.
    Name string
    The name of the board.
    group String
    The ID or URL-encoded path of the group owned by the authenticated user.
    lists List<GroupEpicBoardList>
    The list of epic board lists.
    name String
    The name of the board.
    group string
    The ID or URL-encoded path of the group owned by the authenticated user.
    lists GroupEpicBoardList[]
    The list of epic board lists.
    name string
    The name of the board.
    group str
    The ID or URL-encoded path of the group owned by the authenticated user.
    lists Sequence[GroupEpicBoardListArgs]
    The list of epic board lists.
    name str
    The name of the board.
    group String
    The ID or URL-encoded path of the group owned by the authenticated user.
    lists List<Property Map>
    The list of epic board lists.
    name String
    The name of the board.

    Outputs

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

    Get an existing GroupEpicBoard 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?: GroupEpicBoardState, opts?: CustomResourceOptions): GroupEpicBoard
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        group: Optional[str] = None,
        lists: Optional[Sequence[GroupEpicBoardListArgs]] = None,
        name: Optional[str] = None) -> GroupEpicBoard
    func GetGroupEpicBoard(ctx *Context, name string, id IDInput, state *GroupEpicBoardState, opts ...ResourceOption) (*GroupEpicBoard, error)
    public static GroupEpicBoard Get(string name, Input<string> id, GroupEpicBoardState? state, CustomResourceOptions? opts = null)
    public static GroupEpicBoard get(String name, Output<String> id, GroupEpicBoardState 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:
    Group string
    The ID or URL-encoded path of the group owned by the authenticated user.
    Lists List<Pulumi.GitLab.Inputs.GroupEpicBoardList>
    The list of epic board lists.
    Name string
    The name of the board.
    Group string
    The ID or URL-encoded path of the group owned by the authenticated user.
    Lists []GroupEpicBoardListArgs
    The list of epic board lists.
    Name string
    The name of the board.
    group String
    The ID or URL-encoded path of the group owned by the authenticated user.
    lists List<GroupEpicBoardList>
    The list of epic board lists.
    name String
    The name of the board.
    group string
    The ID or URL-encoded path of the group owned by the authenticated user.
    lists GroupEpicBoardList[]
    The list of epic board lists.
    name string
    The name of the board.
    group str
    The ID or URL-encoded path of the group owned by the authenticated user.
    lists Sequence[GroupEpicBoardListArgs]
    The list of epic board lists.
    name str
    The name of the board.
    group String
    The ID or URL-encoded path of the group owned by the authenticated user.
    lists List<Property Map>
    The list of epic board lists.
    name String
    The name of the board.

    Supporting Types

    GroupEpicBoardList, GroupEpicBoardListArgs

    Id int
    The ID of the list.
    LabelId int
    The ID of the label the list should be scoped to.
    Position int
    The position of the list within the board. The position for the list is sed on the its position in the lists array.
    Id int
    The ID of the list.
    LabelId int
    The ID of the label the list should be scoped to.
    Position int
    The position of the list within the board. The position for the list is sed on the its position in the lists array.
    id Integer
    The ID of the list.
    labelId Integer
    The ID of the label the list should be scoped to.
    position Integer
    The position of the list within the board. The position for the list is sed on the its position in the lists array.
    id number
    The ID of the list.
    labelId number
    The ID of the label the list should be scoped to.
    position number
    The position of the list within the board. The position for the list is sed on the its position in the lists array.
    id int
    The ID of the list.
    label_id int
    The ID of the label the list should be scoped to.
    position int
    The position of the list within the board. The position for the list is sed on the its position in the lists array.
    id Number
    The ID of the list.
    labelId Number
    The ID of the label the list should be scoped to.
    position Number
    The position of the list within the board. The position for the list is sed on the its position in the lists array.

    Import

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

    $ pulumi import gitlab:index/groupEpicBoard:GroupEpicBoard agile 70:156

    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