@pulumi/github
Version:
A Pulumi package for creating and managing github cloud resources.
104 lines (103 loc) • 3.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* This resource allows you to create and manage projects for GitHub repository.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as github from "@pulumi/github";
*
* const example = new github.Repository("example", {
* name: "example",
* description: "My awesome codebase",
* hasProjects: true,
* });
* const project = new github.RepositoryProject("project", {
* name: "A Repository Project",
* repository: example.name,
* body: "This is a repository project.",
* });
* ```
*/
export declare class RepositoryProject extends pulumi.CustomResource {
/**
* Get an existing RepositoryProject resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RepositoryProjectState, opts?: pulumi.CustomResourceOptions): RepositoryProject;
/**
* Returns true if the given object is an instance of RepositoryProject. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is RepositoryProject;
/**
* The body of the project.
*/
readonly body: pulumi.Output<string | undefined>;
readonly etag: pulumi.Output<string>;
/**
* The name of the project.
*/
readonly name: pulumi.Output<string>;
/**
* The repository of the project.
*/
readonly repository: pulumi.Output<string>;
/**
* URL of the project
*/
readonly url: pulumi.Output<string>;
/**
* Create a RepositoryProject resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: RepositoryProjectArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RepositoryProject resources.
*/
export interface RepositoryProjectState {
/**
* The body of the project.
*/
body?: pulumi.Input<string>;
etag?: pulumi.Input<string>;
/**
* The name of the project.
*/
name?: pulumi.Input<string>;
/**
* The repository of the project.
*/
repository?: pulumi.Input<string>;
/**
* URL of the project
*/
url?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a RepositoryProject resource.
*/
export interface RepositoryProjectArgs {
/**
* The body of the project.
*/
body?: pulumi.Input<string>;
/**
* The name of the project.
*/
name?: pulumi.Input<string>;
/**
* The repository of the project.
*/
repository: pulumi.Input<string>;
}