github.ProjectColumn
Explore with Pulumi AI
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ProjectColumn resource accepts the following input properties:
- project_
id str - The ID of an existing project that the column will be created in.
- name str
- The name of the column.
Outputs
All input properties are implicitly available as output properties. Additionally, the ProjectColumn resource produces the following output properties:
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.
- 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.
Package Details
- Repository
- GitHub pulumi/pulumi-github
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
github
Terraform Provider.