1. Packages
  2. Gitlab Provider
  3. API Docs
  4. GroupIssueBoard
GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi

gitlab.GroupIssueBoard

Explore with Pulumi AI

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

    The gitlab.GroupIssueBoard resource allows to manage the lifecycle of a issue board in a group.

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

    Upstream API: GitLab REST API docs

    Create GroupIssueBoard Resource

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

    Constructor syntax

    new GroupIssueBoard(name: string, args: GroupIssueBoardArgs, opts?: CustomResourceOptions);
    @overload
    def GroupIssueBoard(resource_name: str,
                        args: GroupIssueBoardArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def GroupIssueBoard(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        group: Optional[str] = None,
                        labels: Optional[Sequence[str]] = None,
                        lists: Optional[Sequence[GroupIssueBoardListArgs]] = None,
                        milestone_id: Optional[int] = None,
                        name: Optional[str] = None)
    func NewGroupIssueBoard(ctx *Context, name string, args GroupIssueBoardArgs, opts ...ResourceOption) (*GroupIssueBoard, error)
    public GroupIssueBoard(string name, GroupIssueBoardArgs args, CustomResourceOptions? opts = null)
    public GroupIssueBoard(String name, GroupIssueBoardArgs args)
    public GroupIssueBoard(String name, GroupIssueBoardArgs args, CustomResourceOptions options)
    
    type: gitlab:GroupIssueBoard
    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 GroupIssueBoardArgs
    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 GroupIssueBoardArgs
    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 GroupIssueBoardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupIssueBoardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupIssueBoardArgs
    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 groupIssueBoardResource = new GitLab.GroupIssueBoard("groupIssueBoardResource", new()
    {
        Group = "string",
        Labels = new[]
        {
            "string",
        },
        Lists = new[]
        {
            new GitLab.Inputs.GroupIssueBoardListArgs
            {
                Id = 0,
                LabelId = 0,
                Position = 0,
            },
        },
        MilestoneId = 0,
        Name = "string",
    });
    
    example, err := gitlab.NewGroupIssueBoard(ctx, "groupIssueBoardResource", &gitlab.GroupIssueBoardArgs{
    	Group: pulumi.String("string"),
    	Labels: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Lists: gitlab.GroupIssueBoardListArray{
    		&gitlab.GroupIssueBoardListArgs{
    			Id:       pulumi.Int(0),
    			LabelId:  pulumi.Int(0),
    			Position: pulumi.Int(0),
    		},
    	},
    	MilestoneId: pulumi.Int(0),
    	Name:        pulumi.String("string"),
    })
    
    var groupIssueBoardResource = new GroupIssueBoard("groupIssueBoardResource", GroupIssueBoardArgs.builder()
        .group("string")
        .labels("string")
        .lists(GroupIssueBoardListArgs.builder()
            .id(0)
            .labelId(0)
            .position(0)
            .build())
        .milestoneId(0)
        .name("string")
        .build());
    
    group_issue_board_resource = gitlab.GroupIssueBoard("groupIssueBoardResource",
        group="string",
        labels=["string"],
        lists=[{
            "id": 0,
            "label_id": 0,
            "position": 0,
        }],
        milestone_id=0,
        name="string")
    
    const groupIssueBoardResource = new gitlab.GroupIssueBoard("groupIssueBoardResource", {
        group: "string",
        labels: ["string"],
        lists: [{
            id: 0,
            labelId: 0,
            position: 0,
        }],
        milestoneId: 0,
        name: "string",
    });
    
    type: gitlab:GroupIssueBoard
    properties:
        group: string
        labels:
            - string
        lists:
            - id: 0
              labelId: 0
              position: 0
        milestoneId: 0
        name: string
    

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

    Group string
    The ID or URL-encoded path of the group owned by the authenticated user.
    Labels List<string>
    The list of label names which the board should be scoped to.
    Lists List<Pulumi.GitLab.Inputs.GroupIssueBoardList>
    The list of issue board lists.
    MilestoneId int
    The milestone the board should be scoped to.
    Name string
    The name of the board.
    Group string
    The ID or URL-encoded path of the group owned by the authenticated user.
    Labels []string
    The list of label names which the board should be scoped to.
    Lists []GroupIssueBoardListArgs
    The list of issue board lists.
    MilestoneId int
    The milestone the board should be scoped to.
    Name string
    The name of the board.
    group String
    The ID or URL-encoded path of the group owned by the authenticated user.
    labels List<String>
    The list of label names which the board should be scoped to.
    lists List<GroupIssueBoardList>
    The list of issue board lists.
    milestoneId Integer
    The milestone the board should be scoped to.
    name String
    The name of the board.
    group string
    The ID or URL-encoded path of the group owned by the authenticated user.
    labels string[]
    The list of label names which the board should be scoped to.
    lists GroupIssueBoardList[]
    The list of issue board lists.
    milestoneId number
    The milestone the board should be scoped to.
    name string
    The name of the board.
    group str
    The ID or URL-encoded path of the group owned by the authenticated user.
    labels Sequence[str]
    The list of label names which the board should be scoped to.
    lists Sequence[GroupIssueBoardListArgs]
    The list of issue board lists.
    milestone_id int
    The milestone the board should be scoped to.
    name str
    The name of the board.
    group String
    The ID or URL-encoded path of the group owned by the authenticated user.
    labels List<String>
    The list of label names which the board should be scoped to.
    lists List<Property Map>
    The list of issue board lists.
    milestoneId Number
    The milestone the board should be scoped to.
    name String
    The name of the board.

    Outputs

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

    Get an existing GroupIssueBoard 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?: GroupIssueBoardState, opts?: CustomResourceOptions): GroupIssueBoard
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            group: Optional[str] = None,
            labels: Optional[Sequence[str]] = None,
            lists: Optional[Sequence[GroupIssueBoardListArgs]] = None,
            milestone_id: Optional[int] = None,
            name: Optional[str] = None) -> GroupIssueBoard
    func GetGroupIssueBoard(ctx *Context, name string, id IDInput, state *GroupIssueBoardState, opts ...ResourceOption) (*GroupIssueBoard, error)
    public static GroupIssueBoard Get(string name, Input<string> id, GroupIssueBoardState? state, CustomResourceOptions? opts = null)
    public static GroupIssueBoard get(String name, Output<String> id, GroupIssueBoardState 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.
    Labels List<string>
    The list of label names which the board should be scoped to.
    Lists List<Pulumi.GitLab.Inputs.GroupIssueBoardList>
    The list of issue board lists.
    MilestoneId int
    The milestone the board should be scoped to.
    Name string
    The name of the board.
    Group string
    The ID or URL-encoded path of the group owned by the authenticated user.
    Labels []string
    The list of label names which the board should be scoped to.
    Lists []GroupIssueBoardListArgs
    The list of issue board lists.
    MilestoneId int
    The milestone the board should be scoped to.
    Name string
    The name of the board.
    group String
    The ID or URL-encoded path of the group owned by the authenticated user.
    labels List<String>
    The list of label names which the board should be scoped to.
    lists List<GroupIssueBoardList>
    The list of issue board lists.
    milestoneId Integer
    The milestone the board should be scoped to.
    name String
    The name of the board.
    group string
    The ID or URL-encoded path of the group owned by the authenticated user.
    labels string[]
    The list of label names which the board should be scoped to.
    lists GroupIssueBoardList[]
    The list of issue board lists.
    milestoneId number
    The milestone the board should be scoped to.
    name string
    The name of the board.
    group str
    The ID or URL-encoded path of the group owned by the authenticated user.
    labels Sequence[str]
    The list of label names which the board should be scoped to.
    lists Sequence[GroupIssueBoardListArgs]
    The list of issue board lists.
    milestone_id int
    The milestone the board should be scoped to.
    name str
    The name of the board.
    group String
    The ID or URL-encoded path of the group owned by the authenticated user.
    labels List<String>
    The list of label names which the board should be scoped to.
    lists List<Property Map>
    The list of issue board lists.
    milestoneId Number
    The milestone the board should be scoped to.
    name String
    The name of the board.

    Supporting Types

    GroupIssueBoardList, GroupIssueBoardListArgs

    Id int
    The ID of the list.
    LabelId int
    The ID of the label the list should be scoped to.
    Position int
    The explicit position of the list within the board, zero based.
    Id int
    The ID of the list.
    LabelId int
    The ID of the label the list should be scoped to.
    Position int
    The explicit position of the list within the board, zero based.
    id Integer
    The ID of the list.
    labelId Integer
    The ID of the label the list should be scoped to.
    position Integer
    The explicit position of the list within the board, zero based.
    id number
    The ID of the list.
    labelId number
    The ID of the label the list should be scoped to.
    position number
    The explicit position of the list within the board, zero based.
    id int
    The ID of the list.
    label_id int
    The ID of the label the list should be scoped to.
    position int
    The explicit position of the list within the board, zero based.
    id Number
    The ID of the list.
    labelId Number
    The ID of the label the list should be scoped to.
    position Number
    The explicit position of the list within the board, zero based.

    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