import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * A Cloud AI Platform Notebook environment. * * To get more information about Environment, see: * * * [API documentation](https://cloud.google.com/ai-platform/notebooks/docs/reference/rest) * * How-to Guides * * [Official Documentation](https://cloud.google.com/ai-platform-notebooks) * * ## Example Usage * * ### Notebook Environment Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const environment = new gcp.notebooks.Environment("environment", { * name: "notebooks-environment", * location: "us-west1-a", * containerImage: { * repository: "gcr.io/deeplearning-platform-release/base-cpu", * }, * }); * ``` * * ## Import * * Environment can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/environments/{{name}}` * * `{{project}}/{{location}}/{{name}}` * * `{{location}}/{{name}}` * * When using the `pulumi import` command, Environment can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:notebooks/environment:Environment default projects/{{project}}/locations/{{location}}/environments/{{name}} * $ pulumi import gcp:notebooks/environment:Environment default {{project}}/{{location}}/{{name}} * $ pulumi import gcp:notebooks/environment:Environment default {{location}}/{{name}} * ``` */ export declare class Environment extends pulumi.CustomResource { /** * Get an existing Environment 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, state?: EnvironmentState, opts?: pulumi.CustomResourceOptions): Environment; /** * Returns true if the given object is an instance of Environment. 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 Environment; /** * Use a container image to start the notebook instance. * Structure is documented below. */ readonly containerImage: pulumi.Output; /** * Instance creation time */ readonly createTime: pulumi.Output; /** * A brief description of this environment. */ readonly description: pulumi.Output; /** * Display name of this environment for the UI. */ readonly displayName: pulumi.Output; /** * A reference to the zone where the machine resides. */ readonly location: pulumi.Output; /** * The name specified for the Environment instance. * Format: projects/{project_id}/locations/{location}/environments/{environmentId} */ readonly name: pulumi.Output; /** * Path to a Bash script that automatically runs after a notebook instance fully boots up. * The path must be a URL or Cloud Storage path. Example: "gs://path-to-file/file-name" */ readonly postStartupScript: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * Use a Compute Engine VM image to start the notebook instance. * Structure is documented below. */ readonly vmImage: pulumi.Output; /** * Create a Environment 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: EnvironmentArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Environment resources. */ export interface EnvironmentState { /** * Use a container image to start the notebook instance. * Structure is documented below. */ containerImage?: pulumi.Input; /** * Instance creation time */ createTime?: pulumi.Input; /** * A brief description of this environment. */ description?: pulumi.Input; /** * Display name of this environment for the UI. */ displayName?: pulumi.Input; /** * A reference to the zone where the machine resides. */ location?: pulumi.Input; /** * The name specified for the Environment instance. * Format: projects/{project_id}/locations/{location}/environments/{environmentId} */ name?: pulumi.Input; /** * Path to a Bash script that automatically runs after a notebook instance fully boots up. * The path must be a URL or Cloud Storage path. Example: "gs://path-to-file/file-name" */ postStartupScript?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * Use a Compute Engine VM image to start the notebook instance. * Structure is documented below. */ vmImage?: pulumi.Input; } /** * The set of arguments for constructing a Environment resource. */ export interface EnvironmentArgs { /** * Use a container image to start the notebook instance. * Structure is documented below. */ containerImage?: pulumi.Input; /** * A brief description of this environment. */ description?: pulumi.Input; /** * Display name of this environment for the UI. */ displayName?: pulumi.Input; /** * A reference to the zone where the machine resides. */ location: pulumi.Input; /** * The name specified for the Environment instance. * Format: projects/{project_id}/locations/{location}/environments/{environmentId} */ name?: pulumi.Input; /** * Path to a Bash script that automatically runs after a notebook instance fully boots up. * The path must be a URL or Cloud Storage path. Example: "gs://path-to-file/file-name" */ postStartupScript?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * Use a Compute Engine VM image to start the notebook instance. * Structure is documented below. */ vmImage?: pulumi.Input; }