@pulumi/gcp/apphub/workload.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Workload represents a binary deployment (such as Managed Instance Groups (MIGs), GKE deployments, etc.) that performs the smallest logical subset of business functionality. It registers identified workload to the Application.
 *
 * ## Example Usage
 *
 * ## Import
 *
 * Workload can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/applications/{{application_id}}/workloads/{{workload_id}}`
 *
 * * `{{project}}/{{location}}/{{application_id}}/{{workload_id}}`
 *
 * * `{{location}}/{{application_id}}/{{workload_id}}`
 *
 * When using the `pulumi import` command, Workload can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:apphub/workload:Workload default projects/{{project}}/locations/{{location}}/applications/{{application_id}}/workloads/{{workload_id}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:apphub/workload:Workload default {{project}}/{{location}}/{{application_id}}/{{workload_id}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:apphub/workload:Workload default {{location}}/{{application_id}}/{{workload_id}}
 * ```
 */
export declare class Workload extends pulumi.CustomResource {
    /**
     * Get an existing Workload 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?: WorkloadState, opts?: pulumi.CustomResourceOptions): Workload;
    /**
     * Returns true if the given object is an instance of Workload.  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 Workload;
    /**
     * Part of `parent`.  Full resource name of a parent Application. Example: projects/{HOST_PROJECT_ID}/locations/{LOCATION}/applications/{APPLICATION_ID}
     */
    readonly applicationId: pulumi.Output<string>;
    /**
     * Consumer provided attributes.
     * Structure is documented below.
     */
    readonly attributes: pulumi.Output<outputs.apphub.WorkloadAttributes | undefined>;
    /**
     * Output only. Create time.
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * User-defined description of a Workload.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Immutable. The resource name of the original discovered workload.
     */
    readonly discoveredWorkload: pulumi.Output<string>;
    /**
     * User-defined name for the Workload.
     */
    readonly displayName: pulumi.Output<string | undefined>;
    /**
     * Part of `parent`.  Full resource name of a parent Application. Example: projects/{HOST_PROJECT_ID}/locations/{LOCATION}/applications/{APPLICATION_ID}
     */
    readonly location: pulumi.Output<string>;
    /**
     * Identifier. The resource name of the Workload. Format:"projects/{host-project-id}/locations/{location}/applications/{application-id}/workloads/{workload-id}"
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * Output only. Workload state. Possible values:  STATE_UNSPECIFIED CREATING ACTIVE DELETING DETACHED
     */
    readonly state: pulumi.Output<string>;
    /**
     * Output only. A universally unique identifier (UUID) for the `Workload` in the UUID4 format.
     */
    readonly uid: pulumi.Output<string>;
    /**
     * Output only. Update time.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * The Workload identifier.
     *
     *
     * - - -
     */
    readonly workloadId: pulumi.Output<string>;
    /**
     * Properties of an underlying compute resource represented by the Workload.
     * Structure is documented below.
     */
    readonly workloadProperties: pulumi.Output<outputs.apphub.WorkloadWorkloadProperty[]>;
    /**
     * Reference of an underlying compute resource represented by the Workload.
     * Structure is documented below.
     */
    readonly workloadReferences: pulumi.Output<outputs.apphub.WorkloadWorkloadReference[]>;
    /**
     * Create a Workload 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: WorkloadArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Workload resources.
 */
export interface WorkloadState {
    /**
     * Part of `parent`.  Full resource name of a parent Application. Example: projects/{HOST_PROJECT_ID}/locations/{LOCATION}/applications/{APPLICATION_ID}
     */
    applicationId?: pulumi.Input<string>;
    /**
     * Consumer provided attributes.
     * Structure is documented below.
     */
    attributes?: pulumi.Input<inputs.apphub.WorkloadAttributes>;
    /**
     * Output only. Create time.
     */
    createTime?: pulumi.Input<string>;
    /**
     * User-defined description of a Workload.
     */
    description?: pulumi.Input<string>;
    /**
     * Immutable. The resource name of the original discovered workload.
     */
    discoveredWorkload?: pulumi.Input<string>;
    /**
     * User-defined name for the Workload.
     */
    displayName?: pulumi.Input<string>;
    /**
     * Part of `parent`.  Full resource name of a parent Application. Example: projects/{HOST_PROJECT_ID}/locations/{LOCATION}/applications/{APPLICATION_ID}
     */
    location?: pulumi.Input<string>;
    /**
     * Identifier. The resource name of the Workload. Format:"projects/{host-project-id}/locations/{location}/applications/{application-id}/workloads/{workload-id}"
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * Output only. Workload state. Possible values:  STATE_UNSPECIFIED CREATING ACTIVE DELETING DETACHED
     */
    state?: pulumi.Input<string>;
    /**
     * Output only. A universally unique identifier (UUID) for the `Workload` in the UUID4 format.
     */
    uid?: pulumi.Input<string>;
    /**
     * Output only. Update time.
     */
    updateTime?: pulumi.Input<string>;
    /**
     * The Workload identifier.
     *
     *
     * - - -
     */
    workloadId?: pulumi.Input<string>;
    /**
     * Properties of an underlying compute resource represented by the Workload.
     * Structure is documented below.
     */
    workloadProperties?: pulumi.Input<pulumi.Input<inputs.apphub.WorkloadWorkloadProperty>[]>;
    /**
     * Reference of an underlying compute resource represented by the Workload.
     * Structure is documented below.
     */
    workloadReferences?: pulumi.Input<pulumi.Input<inputs.apphub.WorkloadWorkloadReference>[]>;
}
/**
 * The set of arguments for constructing a Workload resource.
 */
export interface WorkloadArgs {
    /**
     * Part of `parent`.  Full resource name of a parent Application. Example: projects/{HOST_PROJECT_ID}/locations/{LOCATION}/applications/{APPLICATION_ID}
     */
    applicationId: pulumi.Input<string>;
    /**
     * Consumer provided attributes.
     * Structure is documented below.
     */
    attributes?: pulumi.Input<inputs.apphub.WorkloadAttributes>;
    /**
     * User-defined description of a Workload.
     */
    description?: pulumi.Input<string>;
    /**
     * Immutable. The resource name of the original discovered workload.
     */
    discoveredWorkload: pulumi.Input<string>;
    /**
     * User-defined name for the Workload.
     */
    displayName?: pulumi.Input<string>;
    /**
     * Part of `parent`.  Full resource name of a parent Application. Example: projects/{HOST_PROJECT_ID}/locations/{LOCATION}/applications/{APPLICATION_ID}
     */
    location: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * The Workload identifier.
     *
     *
     * - - -
     */
    workloadId: pulumi.Input<string>;
}