Environment

Create a Environment Resource

new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);

def Environment(resource_name, opts=None, container_image=None, description=None, display_name=None, location=None, name=None, post_startup_script=None, project=None, vm_image=None, __props__=None);

func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)

public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args EnvironmentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EnvironmentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EnvironmentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Environment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Environment resource accepts the following input properties:

Location string: A reference to the zone where the machine resides.
ContainerImage EnvironmentContainerImageArgs: Use a container image to start the notebook instance. Structure is documented below.
Description string: A brief description of this environment.
DisplayName string: Display name of this environment for the UI.
Name string: The name specified for the Environment instance. Format: projects/{project_id}/locations/{location}/environments/{environmentId}
PostStartupScript string: 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”
Project string: The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
VmImage EnvironmentVmImageArgs: Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

Location string: A reference to the zone where the machine resides.
ContainerImage EnvironmentContainerImage: Use a container image to start the notebook instance. Structure is documented below.
Description string: A brief description of this environment.
DisplayName string: Display name of this environment for the UI.
Name string: The name specified for the Environment instance. Format: projects/{project_id}/locations/{location}/environments/{environmentId}
PostStartupScript string: 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”
Project string: The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
VmImage EnvironmentVmImage: Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

location string: A reference to the zone where the machine resides.
containerImage EnvironmentContainerImage: Use a container image to start the notebook instance. Structure is documented below.
description string: A brief description of this environment.
displayName string: Display name of this environment for the UI.
name string: The name specified for the Environment instance. Format: projects/{project_id}/locations/{location}/environments/{environmentId}
postStartupScript string: 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”
project string: The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
vmImage EnvironmentVmImage: Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

location str: A reference to the zone where the machine resides.
container_image Dict[EnvironmentContainerImage]: Use a container image to start the notebook instance. Structure is documented below.
description str: A brief description of this environment.
display_name str: Display name of this environment for the UI.
name str: The name specified for the Environment instance. Format: projects/{project_id}/locations/{location}/environments/{environmentId}
post_startup_script str: 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”
project str: The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
vm_image Dict[EnvironmentVmImage]: Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

Outputs

All input properties are implicitly available as output properties. Additionally, the Environment resource produces the following output properties:

CreateTime string: Instance creation time
Id string: The provider-assigned unique ID for this managed resource.

CreateTime string: Instance creation time
Id string: The provider-assigned unique ID for this managed resource.

createTime string: Instance creation time
id string: The provider-assigned unique ID for this managed resource.

create_time str: Instance creation time
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Environment Resource

Get an existing Environment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EnvironmentState, opts?: CustomResourceOptions): Environment

static get(resource_name, id, opts=None, container_image=None, create_time=None, description=None, display_name=None, location=None, name=None, post_startup_script=None, project=None, vm_image=None, __props__=None);

func GetEnvironment(ctx *Context, name string, id IDInput, state *EnvironmentState, opts ...ResourceOption) (*Environment, error)

public static Environment Get(string name, Input<string> id, EnvironmentState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ContainerImage EnvironmentContainerImageArgs: Use a container image to start the notebook instance. Structure is documented below.
CreateTime string: Instance creation time
Description string: A brief description of this environment.
DisplayName string: Display name of this environment for the UI.
Location string: A reference to the zone where the machine resides.
Name string: The name specified for the Environment instance. Format: projects/{project_id}/locations/{location}/environments/{environmentId}
PostStartupScript string: 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”
Project string: The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
VmImage EnvironmentVmImageArgs: Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

ContainerImage EnvironmentContainerImage: Use a container image to start the notebook instance. Structure is documented below.
CreateTime string: Instance creation time
Description string: A brief description of this environment.
DisplayName string: Display name of this environment for the UI.
Location string: A reference to the zone where the machine resides.
Name string: The name specified for the Environment instance. Format: projects/{project_id}/locations/{location}/environments/{environmentId}
PostStartupScript string: 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”
Project string: The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
VmImage EnvironmentVmImage: Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

containerImage EnvironmentContainerImage: Use a container image to start the notebook instance. Structure is documented below.
createTime string: Instance creation time
description string: A brief description of this environment.
displayName string: Display name of this environment for the UI.
location string: A reference to the zone where the machine resides.
name string: The name specified for the Environment instance. Format: projects/{project_id}/locations/{location}/environments/{environmentId}
postStartupScript string: 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”
project string: The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
vmImage EnvironmentVmImage: Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

container_image Dict[EnvironmentContainerImage]: Use a container image to start the notebook instance. Structure is documented below.
create_time str: Instance creation time
description str: A brief description of this environment.
display_name str: Display name of this environment for the UI.
location str: A reference to the zone where the machine resides.
name str: The name specified for the Environment instance. Format: projects/{project_id}/locations/{location}/environments/{environmentId}
post_startup_script str: 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”
project str: The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
vm_image Dict[EnvironmentVmImage]: Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

Supporting Types

EnvironmentContainerImage

See the input and output API doc for this type.

Repository string: The path to the container image repository. For example: gcr.io/{project_id}/{imageName}
Tag string: The tag of the container image. If not specified, this defaults to the latest tag.

Repository string: The path to the container image repository. For example: gcr.io/{project_id}/{imageName}
Tag string: The tag of the container image. If not specified, this defaults to the latest tag.

repository string: The path to the container image repository. For example: gcr.io/{project_id}/{imageName}
tag string: The tag of the container image. If not specified, this defaults to the latest tag.

repository str: The path to the container image repository. For example: gcr.io/{project_id}/{imageName}
tag str: The tag of the container image. If not specified, this defaults to the latest tag.

EnvironmentVmImage

See the input and output API doc for this type.

Project string: The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
ImageFamily string: Use this VM image family to find the image; the newest image in this family will be used.
ImageName string: Use VM image name to find the image.

Project string: The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
ImageFamily string: Use this VM image family to find the image; the newest image in this family will be used.
ImageName string: Use VM image name to find the image.

project string: The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
imageFamily string: Use this VM image family to find the image; the newest image in this family will be used.
imageName string: Use VM image name to find the image.

project str: The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}
imageFamily str: Use this VM image family to find the image; the newest image in this family will be used.
imageName str: Use VM image name to find the image.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud