@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
131 lines • 4.72 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The `scaleway.account.Project` resource allows you to create and manage the Projects of a Scaleway Organization.
*
* Refer to the Organizations and Projects [documentation](https://www.scaleway.com/en/docs/organizations-and-projects/) and [API documentation](https://www.scaleway.com/en/developers/api/account/project-api/) for more information.
*
* ## Example Usage
*
* ### Create a Scaleway Project
*
* The following command allows you to create a project named `project`.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const project = new scaleway.account.Project("project", {name: "project"});
* ```
*
* ### Use a project in provider configuration
*
* If you want to use as default a project created in terraform you can use a temporary provider alias.
* This project can then be used to configure your default provider.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const project = new scaleway.account.Project("project", {name: "my_project"});
* const server = new scaleway.instance.Server("server", {
* image: "ubuntu_jammy",
* type: "PRO2-XXS",
* });
* ```
*
* ## Import
*
* Projects can be imported using the `id` argument, as shown below:
*
* ```sh
* $ pulumi import scaleway:account/project:Project project 11111111-1111-1111-1111-111111111111
* ```
*/
export declare 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.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectState, opts?: pulumi.CustomResourceOptions): 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.
*/
static isInstance(obj: any): obj is Project;
/**
* The creation time of the Project.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The description of the Project.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The name of the Project.
*/
readonly name: pulumi.Output<string>;
/**
* `organizationId`)The organization ID the Project is associated with. Any change made to the `organizationId` will recreate the resource.
*/
readonly organizationId: pulumi.Output<string>;
/**
* The last update time of the Project.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* 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);
}
/**
* Input properties used for looking up and filtering Project resources.
*/
export interface ProjectState {
/**
* The creation time of the Project.
*/
createdAt?: pulumi.Input<string | undefined>;
/**
* The description of the Project.
*/
description?: pulumi.Input<string | undefined>;
/**
* The name of the Project.
*/
name?: pulumi.Input<string | undefined>;
/**
* `organizationId`)The organization ID the Project is associated with. Any change made to the `organizationId` will recreate the resource.
*/
organizationId?: pulumi.Input<string | undefined>;
/**
* The last update time of the Project.
*/
updatedAt?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Project resource.
*/
export interface ProjectArgs {
/**
* The description of the Project.
*/
description?: pulumi.Input<string | undefined>;
/**
* The name of the Project.
*/
name?: pulumi.Input<string | undefined>;
/**
* `organizationId`)The organization ID the Project is associated with. Any change made to the `organizationId` will recreate the resource.
*/
organizationId?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=project.d.ts.map