@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
250 lines • 8.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Manages a Scaleway Datalab instance.
*
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.network.Vpc("main", {name: "my-vpc"});
* const mainPrivateNetwork = new scaleway.network.PrivateNetwork("main", {
* vpcId: main.id,
* region: "fr-par",
* });
* const mainDatalab = new scaleway.datalab.Datalab("main", {
* name: "my-datalab",
* sparkVersion: "4.0.0",
* privateNetworkId: mainPrivateNetwork.id,
* region: "fr-par",
* main: {
* nodeType: "DATALAB-SHARED-4C-8G",
* },
* worker: {
* nodeType: "DATALAB-DEDICATED2-2C-8G",
* nodeCount: 1,
* },
* });
* ```
*
* ## Import
*
* Datalab instances can be imported using the `{region}/{id}`, e.g.
*
* ```sh
* $ pulumi import scaleway:datalab/datalab:Datalab main fr-par/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class Datalab extends pulumi.CustomResource {
/**
* Get an existing Datalab 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?: DatalabState, opts?: pulumi.CustomResourceOptions): Datalab;
/**
* Returns true if the given object is an instance of Datalab. 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 Datalab;
/**
* The creation timestamp of the Datalab instance.
*/
readonly createdAt: pulumi.Output<string>;
/**
* A description for the Datalab instance.
*/
readonly description: pulumi.Output<string>;
/**
* Whether a JupyterLab notebook is associated with the Datalab.
*/
readonly hasNotebook: pulumi.Output<boolean>;
/**
* The Spark main node configuration.
*/
readonly main: pulumi.Output<outputs.datalab.DatalabMain>;
/**
* The name of the Datalab instance. If not provided, a random name is generated.
*/
readonly name: pulumi.Output<string>;
/**
* The URL used to reach the cluster from the notebook.
*/
readonly notebookMasterUrl: pulumi.Output<string>;
/**
* The URL of the JupyterLab notebook, if available.
*/
readonly notebookUrl: pulumi.Output<string>;
/**
* The ID of the private network to attach the Datalab to.
*/
readonly privateNetworkId: pulumi.Output<string>;
/**
* `projectId`) The project ID the Datalab belongs to.
*/
readonly projectId: pulumi.Output<string>;
/**
* `region`) The region the Datalab is in. Only `fr-par` is currently supported.
*/
readonly region: pulumi.Output<string>;
/**
* The Spark version to use for the Datalab instance. Available versions can be retrieved from `ListClusterVersions`.
*/
readonly sparkVersion: pulumi.Output<string>;
/**
* The current status of the Datalab instance.
*/
readonly status: pulumi.Output<string>;
/**
* Tags associated with the Datalab instance.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* Persistent volume storage configuration.
*/
readonly totalStorage: pulumi.Output<outputs.datalab.DatalabTotalStorage>;
/**
* The last update timestamp of the Datalab instance.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* The Spark worker nodes configuration.
*/
readonly worker: pulumi.Output<outputs.datalab.DatalabWorker>;
/**
* Create a Datalab 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: DatalabArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Datalab resources.
*/
export interface DatalabState {
/**
* The creation timestamp of the Datalab instance.
*/
createdAt?: pulumi.Input<string | undefined>;
/**
* A description for the Datalab instance.
*/
description?: pulumi.Input<string | undefined>;
/**
* Whether a JupyterLab notebook is associated with the Datalab.
*/
hasNotebook?: pulumi.Input<boolean | undefined>;
/**
* The Spark main node configuration.
*/
main?: pulumi.Input<inputs.datalab.DatalabMain | undefined>;
/**
* The name of the Datalab instance. If not provided, a random name is generated.
*/
name?: pulumi.Input<string | undefined>;
/**
* The URL used to reach the cluster from the notebook.
*/
notebookMasterUrl?: pulumi.Input<string | undefined>;
/**
* The URL of the JupyterLab notebook, if available.
*/
notebookUrl?: pulumi.Input<string | undefined>;
/**
* The ID of the private network to attach the Datalab to.
*/
privateNetworkId?: pulumi.Input<string | undefined>;
/**
* `projectId`) The project ID the Datalab belongs to.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* `region`) The region the Datalab is in. Only `fr-par` is currently supported.
*/
region?: pulumi.Input<string | undefined>;
/**
* The Spark version to use for the Datalab instance. Available versions can be retrieved from `ListClusterVersions`.
*/
sparkVersion?: pulumi.Input<string | undefined>;
/**
* The current status of the Datalab instance.
*/
status?: pulumi.Input<string | undefined>;
/**
* Tags associated with the Datalab instance.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Persistent volume storage configuration.
*/
totalStorage?: pulumi.Input<inputs.datalab.DatalabTotalStorage | undefined>;
/**
* The last update timestamp of the Datalab instance.
*/
updatedAt?: pulumi.Input<string | undefined>;
/**
* The Spark worker nodes configuration.
*/
worker?: pulumi.Input<inputs.datalab.DatalabWorker | undefined>;
}
/**
* The set of arguments for constructing a Datalab resource.
*/
export interface DatalabArgs {
/**
* A description for the Datalab instance.
*/
description?: pulumi.Input<string | undefined>;
/**
* Whether a JupyterLab notebook is associated with the Datalab.
*/
hasNotebook?: pulumi.Input<boolean | undefined>;
/**
* The Spark main node configuration.
*/
main?: pulumi.Input<inputs.datalab.DatalabMain | undefined>;
/**
* The name of the Datalab instance. If not provided, a random name is generated.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the private network to attach the Datalab to.
*/
privateNetworkId: pulumi.Input<string>;
/**
* `projectId`) The project ID the Datalab belongs to.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* `region`) The region the Datalab is in. Only `fr-par` is currently supported.
*/
region?: pulumi.Input<string | undefined>;
/**
* The Spark version to use for the Datalab instance. Available versions can be retrieved from `ListClusterVersions`.
*/
sparkVersion: pulumi.Input<string>;
/**
* Tags associated with the Datalab instance.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Persistent volume storage configuration.
*/
totalStorage?: pulumi.Input<inputs.datalab.DatalabTotalStorage | undefined>;
/**
* The Spark worker nodes configuration.
*/
worker?: pulumi.Input<inputs.datalab.DatalabWorker | undefined>;
}
//# sourceMappingURL=datalab.d.ts.map