1. Packages
  2. GitHub
  3. API Docs
  4. ProjectColumn
GitHub v6.3.0 published on Monday, Sep 16, 2024 by Pulumi

github.ProjectColumn

Explore with Pulumi AI

github logo
GitHub v6.3.0 published on Monday, Sep 16, 2024 by Pulumi

    This resource allows you to create and manage columns for GitHub projects.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as github from "@pulumi/github";
    
    const project = new github.OrganizationProject("project", {
        name: "A Organization Project",
        body: "This is an organization project.",
    });
    const column = new github.ProjectColumn("column", {
        projectId: project.id,
        name: "a column",
    });
    
    import pulumi
    import pulumi_github as github
    
    project = github.OrganizationProject("project",
        name="A Organization Project",
        body="This is an organization project.")
    column = github.ProjectColumn("column",
        project_id=project.id,
        name="a column")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-github/sdk/v6/go/github"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		project, err := github.NewOrganizationProject(ctx, "project", &github.OrganizationProjectArgs{
    			Name: pulumi.String("A Organization Project"),
    			Body: pulumi.String("This is an organization project."),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = github.NewProjectColumn(ctx, "column", &github.ProjectColumnArgs{
    			ProjectId: project.ID(),
    			Name:      pulumi.String("a column"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Github = Pulumi.Github;
    
    return await Deployment.RunAsync(() => 
    {
        var project = new Github.OrganizationProject("project", new()
        {
            Name = "A Organization Project",
            Body = "This is an organization project.",
        });
    
        var column = new Github.ProjectColumn("column", new()
        {
            ProjectId = project.Id,
            Name = "a column",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.github.OrganizationProject;
    import com.pulumi.github.OrganizationProjectArgs;
    import com.pulumi.github.ProjectColumn;
    import com.pulumi.github.ProjectColumnArgs;
    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 project = new OrganizationProject("project", OrganizationProjectArgs.builder()
                .name("A Organization Project")
                .body("This is an organization project.")
                .build());
    
            var column = new ProjectColumn("column", ProjectColumnArgs.builder()
                .projectId(project.id())
                .name("a column")
                .build());
    
        }
    }
    
    resources:
      project:
        type: github:OrganizationProject
        properties:
          name: A Organization Project
          body: This is an organization project.
      column:
        type: github:ProjectColumn
        properties:
          projectId: ${project.id}
          name: a column
    

    Create ProjectColumn Resource

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

    Constructor syntax

    new ProjectColumn(name: string, args: ProjectColumnArgs, opts?: CustomResourceOptions);
    @overload
    def ProjectColumn(resource_name: str,
                      args: ProjectColumnArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def ProjectColumn(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      project_id: Optional[str] = None,
                      name: Optional[str] = None)
    func NewProjectColumn(ctx *Context, name string, args ProjectColumnArgs, opts ...ResourceOption) (*ProjectColumn, error)
    public ProjectColumn(string name, ProjectColumnArgs args, CustomResourceOptions? opts = null)
    public ProjectColumn(String name, ProjectColumnArgs args)
    public ProjectColumn(String name, ProjectColumnArgs args, CustomResourceOptions options)
    
    type: github:ProjectColumn
    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 ProjectColumnArgs
    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 ProjectColumnArgs
    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 ProjectColumnArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectColumnArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectColumnArgs
    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 projectColumnResource = new Github.ProjectColumn("projectColumnResource", new()
    {
        ProjectId = "string",
        Name = "string",
    });
    
    example, err := github.NewProjectColumn(ctx, "projectColumnResource", &github.ProjectColumnArgs{
    	ProjectId: pulumi.String("string"),
    	Name:      pulumi.String("string"),
    })
    
    var projectColumnResource = new ProjectColumn("projectColumnResource", ProjectColumnArgs.builder()
        .projectId("string")
        .name("string")
        .build());
    
    project_column_resource = github.ProjectColumn("projectColumnResource",
        project_id="string",
        name="string")
    
    const projectColumnResource = new github.ProjectColumn("projectColumnResource", {
        projectId: "string",
        name: "string",
    });
    
    type: github:ProjectColumn
    properties:
        name: string
        projectId: string
    

    ProjectColumn Resource Properties

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

    Inputs

    The ProjectColumn resource accepts the following input properties:

    ProjectId string
    The ID of an existing project that the column will be created in.
    Name string
    The name of the column.
    ProjectId string
    The ID of an existing project that the column will be created in.
    Name string
    The name of the column.
    projectId String
    The ID of an existing project that the column will be created in.
    name String
    The name of the column.
    projectId string
    The ID of an existing project that the column will be created in.
    name string
    The name of the column.
    project_id str
    The ID of an existing project that the column will be created in.
    name str
    The name of the column.
    projectId String
    The ID of an existing project that the column will be created in.
    name String
    The name of the column.

    Outputs

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

    ColumnId int
    The ID of the column.
    Etag string
    Id string
    The provider-assigned unique ID for this managed resource.
    ColumnId int
    The ID of the column.
    Etag string
    Id string
    The provider-assigned unique ID for this managed resource.
    columnId Integer
    The ID of the column.
    etag String
    id String
    The provider-assigned unique ID for this managed resource.
    columnId number
    The ID of the column.
    etag string
    id string
    The provider-assigned unique ID for this managed resource.
    column_id int
    The ID of the column.
    etag str
    id str
    The provider-assigned unique ID for this managed resource.
    columnId Number
    The ID of the column.
    etag String
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ProjectColumn Resource

    Get an existing ProjectColumn 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?: ProjectColumnState, opts?: CustomResourceOptions): ProjectColumn
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            column_id: Optional[int] = None,
            etag: Optional[str] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None) -> ProjectColumn
    func GetProjectColumn(ctx *Context, name string, id IDInput, state *ProjectColumnState, opts ...ResourceOption) (*ProjectColumn, error)
    public static ProjectColumn Get(string name, Input<string> id, ProjectColumnState? state, CustomResourceOptions? opts = null)
    public static ProjectColumn get(String name, Output<String> id, ProjectColumnState 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:
    ColumnId int
    The ID of the column.
    Etag string
    Name string
    The name of the column.
    ProjectId string
    The ID of an existing project that the column will be created in.
    ColumnId int
    The ID of the column.
    Etag string
    Name string
    The name of the column.
    ProjectId string
    The ID of an existing project that the column will be created in.
    columnId Integer
    The ID of the column.
    etag String
    name String
    The name of the column.
    projectId String
    The ID of an existing project that the column will be created in.
    columnId number
    The ID of the column.
    etag string
    name string
    The name of the column.
    projectId string
    The ID of an existing project that the column will be created in.
    column_id int
    The ID of the column.
    etag str
    name str
    The name of the column.
    project_id str
    The ID of an existing project that the column will be created in.
    columnId Number
    The ID of the column.
    etag String
    name String
    The name of the column.
    projectId String
    The ID of an existing project that the column will be created in.

    Package Details

    Repository
    GitHub pulumi/pulumi-github
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the github Terraform Provider.
    github logo
    GitHub v6.3.0 published on Monday, Sep 16, 2024 by Pulumi