@equinix-labs/pulumi-equinix/metal/getProject.d.ts

A Pulumi package for creating and managing equinix cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this datasource to retrieve attributes of the Project API resource.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as equinix from "@equinix-labs/pulumi-equinix";
 *
 * const tfProject1 = equinix.metal.getProject({
 *     name: "Terraform Fun",
 * });
 * export const usersOfTerraformFun = tfProject1.then(tfProject1 => tfProject1.userIds);
 * ```
 */
export declare function getProject(args?: GetProjectArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectResult>;
/**
 * A collection of arguments for invoking getProject.
 */
export interface GetProjectArgs {
    /**
     * The name which is used to look up the project.
     */
    name?: string;
    /**
     * The UUID by which to look up the project.
     */
    projectId?: string;
}
/**
 * A collection of values returned by getProject.
 */
export interface GetProjectResult {
    /**
     * Whether Backend Transfer is enabled for this project.
     */
    readonly backendTransfer: boolean;
    /**
     * Optional BGP settings. Refer to [Equinix Metal guide for BGP](https://metal.equinix.com/developers/docs/networking/local-global-bgp/).
     */
    readonly bgpConfig: outputs.metal.GetProjectBgpConfig;
    /**
     * The timestamp for when the project was created.
     */
    readonly created: string;
    readonly id: string;
    readonly name: string;
    /**
     * The UUID of this project's parent organization.
     */
    readonly organizationId: string;
    /**
     * The UUID of payment method for this project.
     */
    readonly paymentMethodId: string;
    readonly projectId: string;
    /**
     * The timestamp for the last time the project was updated.
     */
    readonly updated: string;
    /**
     * List of UUIDs of user accounts which belong to this project.
     */
    readonly userIds: string[];
}
/**
 * Use this datasource to retrieve attributes of the Project API resource.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as equinix from "@equinix-labs/pulumi-equinix";
 *
 * const tfProject1 = equinix.metal.getProject({
 *     name: "Terraform Fun",
 * });
 * export const usersOfTerraformFun = tfProject1.then(tfProject1 => tfProject1.userIds);
 * ```
 */
export declare function getProjectOutput(args?: GetProjectOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetProjectResult>;
/**
 * A collection of arguments for invoking getProject.
 */
export interface GetProjectOutputArgs {
    /**
     * The name which is used to look up the project.
     */
    name?: pulumi.Input<string>;
    /**
     * The UUID by which to look up the project.
     */
    projectId?: pulumi.Input<string>;
}