Files
pulumi-incus/sdk/nodejs/project.ts

153 lines
5.2 KiB
TypeScript
Generated

// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
import * as pulumi from "@pulumi/pulumi";
import * as utilities from "./utilities";
export class Project extends pulumi.CustomResource {
/**
* Get an existing Project 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.
*/
public static get(
name: string,
id: pulumi.Input<pulumi.ID>,
state?: ProjectState,
opts?: pulumi.CustomResourceOptions,
): Project {
return new Project(name, <any>state, { ...opts, id: id });
}
/** @internal */
public static readonly __pulumiType = "incus:index/project:Project";
/**
* Returns true if the given object is an instance of Project. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
public static isInstance(obj: any): obj is Project {
if (obj === undefined || obj === null) {
return false;
}
return obj["__pulumiType"] === Project.__pulumiType;
}
/**
* *Optional* - Map of key/value pairs of [project config settings](https://linuxcontainers.org/incus/docs/main/reference/projects/).
*/
declare public readonly config: pulumi.Output<{ [key: string]: string }>;
/**
* *Optional* - Description of the project.
*/
declare public readonly description: pulumi.Output<string>;
/**
* *Optional* - Whether to delete everything the project contains on destroy so that it can be destroyed without any error.
*/
declare public readonly forceDestroy: pulumi.Output<boolean>;
/**
* **Required** - Name of the project.
*/
declare public readonly name: pulumi.Output<string>;
/**
* *Optional* - The remote in which the resource will be created. If
* not provided, the provider's default remote will be used.
*/
declare public readonly remote: pulumi.Output<string | undefined>;
/**
* Create a Project 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: ProjectArgs, opts?: pulumi.CustomResourceOptions);
constructor(
name: string,
argsOrState?: ProjectArgs | ProjectState,
opts?: pulumi.CustomResourceOptions,
) {
let resourceInputs: pulumi.Inputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState as ProjectState | undefined;
resourceInputs["config"] = state?.config;
resourceInputs["description"] = state?.description;
resourceInputs["forceDestroy"] = state?.forceDestroy;
resourceInputs["name"] = state?.name;
resourceInputs["remote"] = state?.remote;
} else {
const args = argsOrState as ProjectArgs | undefined;
if (args?.name === undefined && !opts.urn) {
throw new Error("Missing required property 'name'");
}
resourceInputs["config"] = args?.config;
resourceInputs["description"] = args?.description;
resourceInputs["forceDestroy"] = args?.forceDestroy;
resourceInputs["name"] = args?.name;
resourceInputs["remote"] = args?.remote;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Project.__pulumiType, name, resourceInputs, opts);
}
}
/**
* Input properties used for looking up and filtering Project resources.
*/
export interface ProjectState {
/**
* *Optional* - Map of key/value pairs of [project config settings](https://linuxcontainers.org/incus/docs/main/reference/projects/).
*/
config?: pulumi.Input<{ [key: string]: pulumi.Input<string> }>;
/**
* *Optional* - Description of the project.
*/
description?: pulumi.Input<string>;
/**
* *Optional* - Whether to delete everything the project contains on destroy so that it can be destroyed without any error.
*/
forceDestroy?: pulumi.Input<boolean>;
/**
* **Required** - Name of the project.
*/
name?: pulumi.Input<string>;
/**
* *Optional* - The remote in which the resource will be created. If
* not provided, the provider's default remote will be used.
*/
remote?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Project resource.
*/
export interface ProjectArgs {
/**
* *Optional* - Map of key/value pairs of [project config settings](https://linuxcontainers.org/incus/docs/main/reference/projects/).
*/
config?: pulumi.Input<{ [key: string]: pulumi.Input<string> }>;
/**
* *Optional* - Description of the project.
*/
description?: pulumi.Input<string>;
/**
* *Optional* - Whether to delete everything the project contains on destroy so that it can be destroyed without any error.
*/
forceDestroy?: pulumi.Input<boolean>;
/**
* **Required** - Name of the project.
*/
name: pulumi.Input<string>;
/**
* *Optional* - The remote in which the resource will be created. If
* not provided, the provider's default remote will be used.
*/
remote?: pulumi.Input<string>;
}