github.OrganizationProject
Explore with Pulumi AI
This resource allows you to create and manage projects for GitHub organization.
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 a organization project.",
});
import pulumi
import pulumi_github as github
project = github.OrganizationProject("project",
name="A Organization Project",
body="This is a organization project.")
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 {
_, err := github.NewOrganizationProject(ctx, "project", &github.OrganizationProjectArgs{
Name: pulumi.String("A Organization Project"),
Body: pulumi.String("This is a organization project."),
})
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 a organization project.",
});
});
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 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 a organization project.")
.build());
}
}
resources:
project:
type: github:OrganizationProject
properties:
name: A Organization Project
body: This is a organization project.
Create OrganizationProject Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OrganizationProject(name: string, args?: OrganizationProjectArgs, opts?: CustomResourceOptions);
@overload
def OrganizationProject(resource_name: str,
args: Optional[OrganizationProjectArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def OrganizationProject(resource_name: str,
opts: Optional[ResourceOptions] = None,
body: Optional[str] = None,
name: Optional[str] = None)
func NewOrganizationProject(ctx *Context, name string, args *OrganizationProjectArgs, opts ...ResourceOption) (*OrganizationProject, error)
public OrganizationProject(string name, OrganizationProjectArgs? args = null, CustomResourceOptions? opts = null)
public OrganizationProject(String name, OrganizationProjectArgs args)
public OrganizationProject(String name, OrganizationProjectArgs args, CustomResourceOptions options)
type: github:OrganizationProject
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 OrganizationProjectArgs
- 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 OrganizationProjectArgs
- 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 OrganizationProjectArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OrganizationProjectArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OrganizationProjectArgs
- 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 organizationProjectResource = new Github.OrganizationProject("organizationProjectResource", new()
{
Body = "string",
Name = "string",
});
example, err := github.NewOrganizationProject(ctx, "organizationProjectResource", &github.OrganizationProjectArgs{
Body: pulumi.String("string"),
Name: pulumi.String("string"),
})
var organizationProjectResource = new OrganizationProject("organizationProjectResource", OrganizationProjectArgs.builder()
.body("string")
.name("string")
.build());
organization_project_resource = github.OrganizationProject("organizationProjectResource",
body="string",
name="string")
const organizationProjectResource = new github.OrganizationProject("organizationProjectResource", {
body: "string",
name: "string",
});
type: github:OrganizationProject
properties:
body: string
name: string
OrganizationProject 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 OrganizationProject resource accepts the following input properties:
Outputs
All input properties are implicitly available as output properties. Additionally, the OrganizationProject resource produces the following output properties:
Look up Existing OrganizationProject Resource
Get an existing OrganizationProject 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?: OrganizationProjectState, opts?: CustomResourceOptions): OrganizationProject
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
body: Optional[str] = None,
etag: Optional[str] = None,
name: Optional[str] = None,
url: Optional[str] = None) -> OrganizationProject
func GetOrganizationProject(ctx *Context, name string, id IDInput, state *OrganizationProjectState, opts ...ResourceOption) (*OrganizationProject, error)
public static OrganizationProject Get(string name, Input<string> id, OrganizationProjectState? state, CustomResourceOptions? opts = null)
public static OrganizationProject get(String name, Output<String> id, OrganizationProjectState 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.
Package Details
- Repository
- GitHub pulumi/pulumi-github
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
github
Terraform Provider.