gcloud dataplex environments create

NAME
gcloud dataplex environments create - create a Dataplex Environment
SYNOPSIS
gcloud dataplex environments create(ENVIRONMENT :--lake=LAKE--location=LOCATION)((--os-image-version=OS_IMAGE_VERSION :--os-image-java-libraries=[OS_IMAGE_JAVA_LIBRARIES,…]--os-image-properties=[OS_IMAGE_PROPERTIES,…]--os-image-python-packages=[OS_IMAGE_PYTHON_PACKAGES,…]) :--compute-disk-size-gb=COMPUTE_DISK_SIZE_GB; default=100--compute-max-node-count=COMPUTE_MAX_NODE_COUNT--compute-node-count=COMPUTE_NODE_COUNT)[--description=DESCRIPTION][--display-name=DISPLAY_NAME][--labels=[KEY=VALUE,…]][--async    |--validate-only][--session-enable-fast-startup--session-max-idle-duration=SESSION_MAX_IDLE_DURATION][GCLOUD_WIDE_FLAG]
DESCRIPTION
Create a Dataplex Environment.
EXAMPLES
To create a Dataplex Environmenttest-environment within laketest-lake in locationus-central1 inside projecttest-project , run:
gclouddataplexenvironmentscreatetest-environment--project=test-project--location=us-central1--lake=test-lake--os-image-version=1.0

To know about the other required arguments to create an environment run:

gclouddataplexenvironmentcreate--help
POSITIONAL ARGUMENTS
Environments resource - The Environment to create a Environment to. Thearguments in this group can be used to specify the attributes of this resource.(NOTE) Some attributes are not given arguments in this group but can be set inother ways.

To set theproject attribute:

  • provide the argumentenvironment on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

ENVIRONMENT
ID of the environments or fully qualified identifier for the environments.

To set theenvironment attribute:

  • provide the argumentenvironment on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--lake=LAKE
The identifier of the Dataplex lake resource.

To set thelake attribute:

  • provide the argumentenvironment on the command line with a fullyspecified name;
  • provide the argument--lake on the command line.
--location=LOCATION
The location of the Dataplex resource.

To set thelocation attribute:

  • provide the argumentenvironment on the command line with a fullyspecified name;
  • provide the argument--location on the command line;
  • set the propertydataplex/location.
REQUIRED FLAGS
Configuration for the underlying infrastructure used to run workloads.

This must be specified.

Software Runtime Configuration to run Analyze.

This must be specified.

--os-image-version=OS_IMAGE_VERSION
Dataplex Image version.

This flag argument must be specified if any of the other arguments in this groupare specified.

--os-image-java-libraries=[OS_IMAGE_JAVA_LIBRARIES,…]
List of Java jars to be included in the runtime environment. Valid inputincludes Cloud Storage URIs to Jar binaries. For example,gs://bucket-name/my/path/to/file.jar
--os-image-properties=[OS_IMAGE_PROPERTIES,…]
Override to common configuration of open source components installed on theDataproc cluster. The properties to set on daemon config files. Property keysare specified inprefix:property format.
--os-image-python-packages=[OS_IMAGE_PYTHON_PACKAGES,…]
A list of python packages to be installed. Valid formats include Cloud StorageURI to a PIP installable library. For example,gs://bucket-name/my/path/to/lib.tar.gz
Compute resources associated with the analyze interactive workloads.
--compute-disk-size-gb=COMPUTE_DISK_SIZE_GB; default=100
Size in GB of the disk. Default is 100 GB.
--compute-max-node-count=COMPUTE_MAX_NODE_COUNT
Maximum number of configurable nodes.
--compute-node-count=COMPUTE_NODE_COUNT
Total number of worker nodes in the cluster.
OPTIONAL FLAGS
--description=DESCRIPTION
Description of the Environment
--display-name=DISPLAY_NAME
Display Name of the Environment
--labels=[KEY=VALUE,…]
List of label KEY=VALUE pairs to add.

Keys must start with a lowercase character and contain only hyphens(-), underscores (_), lowercase characters, andnumbers. Values must contain only hyphens (-), underscores(_), lowercase characters, and numbers.

At most one of --async | --validate-only can be specified.

At most one of these can be specified:

--async
Return immediately, without waiting for the operation in progress to complete.
--validate-only
Validate the create action, but don't actually perform it.
Configuration for sessions created for the environment to be created.
--session-enable-fast-startup
Enables fast startup. This causes sessions to be pre-created and available forfaster startup to enable interactive exploration use-cases.
--session-max-idle-duration=SESSION_MAX_IDLE_DURATION
The idle time configuration of the session. The session will be auto-terminatedat the end of this period.
GCLOUD WIDE FLAGS
These flags are available to all commands:--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.

Run$gcloud help for details.

NOTES
This variant is also available:
gcloudalphadataplexenvironmentscreate

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-07 UTC.