Environment

Creates a new Environment. Auto-naming is currently not supported for this resource.

Create Environment Resource

new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);
@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                container_image: Optional[ContainerImageArgs] = None,
                description: Optional[str] = None,
                display_name: Optional[str] = None,
                environment_id: Optional[str] = None,
                location: Optional[str] = None,
                post_startup_script: Optional[str] = None,
                project: Optional[str] = None,
                vm_image: Optional[VmImageArgs] = None)
@overload
def Environment(resource_name: str,
                args: EnvironmentArgs,
                opts: Optional[ResourceOptions] = None)
func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)
type: google-native:notebooks/v1:Environment
properties: # The arguments to resource properties.
options: # 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.
resource_name str
The unique name of the resource.
args EnvironmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control 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.
name String
The unique name of the resource.
args EnvironmentArgs
The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The Environment resource accepts the following input properties:

EnvironmentId string

Required. User-defined unique ID of this environment. The environment_id must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.

ContainerImage Pulumi.GoogleNative.Notebooks.V1.Inputs.ContainerImageArgs

Use a container image to start the notebook instance.

Description string

A brief description of this environment.

DisplayName string

Display name of this environment for the UI.

Location string
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
VmImage Pulumi.GoogleNative.Notebooks.V1.Inputs.VmImageArgs

Use a Compute Engine VM image to start the notebook instance.

EnvironmentId string

Required. User-defined unique ID of this environment. The environment_id must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.

ContainerImage ContainerImageArgs

Use a container image to start the notebook instance.

Description string

A brief description of this environment.

DisplayName string

Display name of this environment for the UI.

Location string
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
VmImage VmImageArgs

Use a Compute Engine VM image to start the notebook instance.

environmentId String

Required. User-defined unique ID of this environment. The environment_id must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.

containerImage ContainerImageArgs

Use a container image to start the notebook instance.

description String

A brief description of this environment.

displayName String

Display name of this environment for the UI.

location String
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
vmImage VmImageArgs

Use a Compute Engine VM image to start the notebook instance.

environmentId string

Required. User-defined unique ID of this environment. The environment_id must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.

containerImage ContainerImageArgs

Use a container image to start the notebook instance.

description string

A brief description of this environment.

displayName string

Display name of this environment for the UI.

location string
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
vmImage VmImageArgs

Use a Compute Engine VM image to start the notebook instance.

environment_id str

Required. User-defined unique ID of this environment. The environment_id must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.

container_image ContainerImageArgs

Use a container image to start the notebook instance.

description str

A brief description of this environment.

display_name str

Display name of this environment for the UI.

location str
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
vm_image VmImageArgs

Use a Compute Engine VM image to start the notebook instance.

environmentId String

Required. User-defined unique ID of this environment. The environment_id must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.

containerImage Property Map

Use a container image to start the notebook instance.

description String

A brief description of this environment.

displayName String

Display name of this environment for the UI.

location String
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
vmImage Property Map

Use a Compute Engine VM image to start the notebook instance.

Outputs

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

CreateTime string

The time at which this environment was created.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

CreateTime string

The time at which this environment was created.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

createTime String

The time at which this environment was created.

id String

The provider-assigned unique ID for this managed resource.

name String

Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

createTime string

The time at which this environment was created.

id string

The provider-assigned unique ID for this managed resource.

name string

Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

create_time str

The time at which this environment was created.

id str

The provider-assigned unique ID for this managed resource.

name str

Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

createTime String

The time at which this environment was created.

id String

The provider-assigned unique ID for this managed resource.

name String

Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

Supporting Types

ContainerImage

Repository string

The path to the container image repository. For example: gcr.io/{project_id}/{image_name}

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}/{image_name}

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}/{image_name}

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}/{image_name}

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}/{image_name}

tag str

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}/{image_name}

tag String

The tag of the container image. If not specified, this defaults to the latest tag.

ContainerImageResponse

Repository string

The path to the container image repository. For example: gcr.io/{project_id}/{image_name}

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}/{image_name}

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}/{image_name}

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}/{image_name}

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}/{image_name}

tag str

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}/{image_name}

tag String

The tag of the container image. If not specified, this defaults to the latest tag.

VmImage

Project string

The name of the Google Cloud project that this VM image belongs to. Format: {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: {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: {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: {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: {project_id}

image_family str

Use this VM image family to find the image; the newest image in this family will be used.

image_name str

Use VM image name to find the image.

project String

The name of the Google Cloud project that this VM image belongs to. Format: {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.

VmImageResponse

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: {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: {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: {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: {project_id}

image_family str

Use this VM image family to find the image; the newest image in this family will be used.

image_name str

Use VM image name to find the image.

project str

The name of the Google Cloud project that this VM image belongs to. Format: {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: {project_id}

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0