@pulumi/digitalocean/getProject.d.ts

A Pulumi package for creating and managing DigitalOcean cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Get information on a single DigitalOcean project. If neither the `id` nor `name` attributes are provided,
 * then this data source returns the default project.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as digitalocean from "@pulumi/digitalocean";
 *
 * const _default = digitalocean.getProject({});
 * const staging = digitalocean.getProject({
 *     name: "My Staging Project",
 * });
 * ```
 */
export declare function getProject(args?: GetProjectArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectResult>;
/**
 * A collection of arguments for invoking getProject.
 */
export interface GetProjectArgs {
    /**
     * the ID of the project to retrieve
     */
    id?: string;
    /**
     * the name of the project to retrieve. The data source will raise an error if more than
     * one project has the provided name or if no project has that name.
     */
    name?: string;
}
/**
 * A collection of values returned by getProject.
 */
export interface GetProjectResult {
    /**
     * The date and time when the project was created, (ISO8601)
     */
    readonly createdAt: string;
    /**
     * The description of the project
     */
    readonly description: string;
    /**
     * The environment of the project's resources. The possible values are: `Development`, `Staging`, `Production`.
     */
    readonly environment: string;
    readonly id: string;
    readonly isDefault: boolean;
    readonly name: string;
    /**
     * The ID of the project owner.
     */
    readonly ownerId: number;
    /**
     * The unique universal identifier of the project owner.
     */
    readonly ownerUuid: string;
    /**
     * The purpose of the project, (Default: "Web Application")
     */
    readonly purpose: string;
    /**
     * A set of uniform resource names (URNs) for the resources associated with the project
     */
    readonly resources: string[];
    /**
     * The date and time when the project was last updated, (ISO8601)
     */
    readonly updatedAt: string;
}
/**
 * Get information on a single DigitalOcean project. If neither the `id` nor `name` attributes are provided,
 * then this data source returns the default project.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as digitalocean from "@pulumi/digitalocean";
 *
 * const _default = digitalocean.getProject({});
 * const staging = digitalocean.getProject({
 *     name: "My Staging Project",
 * });
 * ```
 */
export declare function getProjectOutput(args?: GetProjectOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetProjectResult>;
/**
 * A collection of arguments for invoking getProject.
 */
export interface GetProjectOutputArgs {
    /**
     * the ID of the project to retrieve
     */
    id?: pulumi.Input<string>;
    /**
     * the name of the project to retrieve. The data source will raise an error if more than
     * one project has the provided name or if no project has that name.
     */
    name?: pulumi.Input<string>;
}