HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/396/help/man/man1/gcloud_alpha_dataplex_lakes_create.1
.TH "GCLOUD_ALPHA_DATAPLEX_LAKES_CREATE" 1



.SH "NAME"
.HP
gcloud alpha dataplex lakes create \- create a Dataplex lake resource



.SH "SYNOPSIS"
.HP
\f5gcloud alpha dataplex lakes create\fR (\fILAKE\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-async\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-metastore\-service\fR=\fIMETASTORE_SERVICE\fR] [\fB\-\-validate\-only\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR A lake is a centralized repository for managing data across the
organization, where enterprise data is distributed across many cloud projects,
and stored in a variety of storage services, such as Google Cloud Storage and
BigQuery. A lake provides data admins with tools to organize, secure and manage
their data at scale, and provides data scientists and data engineers an
integrated experience to easily search, discover, analyze and transform data and
associated metadata.

The Lake ID will be used to generate names such as database and dataset names
when publishing metadata to Hive Metastore and BigQuery. The Lake id must follow
these rules:
.RS 2m
.IP "\(bu" 2m
Must contain only lowercase letters, numbers, and hyphens.
.IP "\(bu" 2m
Must start with a letter.
.IP "\(bu" 2m
Must end with a number or a letter.
.IP "\(bu" 2m
Must be between 1\-63 characters.
.IP "\(bu" 2m
Must be unique within the customer project / location.
.RE
.sp



.SH "EXAMPLES"

To create a Dataplex lake with name \f5my\-dataplex\-lake\fR in location
\f5us\-central1\fR, run:

.RS 2m
$ gcloud alpha dataplex lakes create my\-dataplex\-lake \e
    \-\-location=us\-central
.RE

To create a Dataplex lake with name \f5my\-dataplex\-lake\fR in location
\f5us\-central1\fR with metastore service \f5service\-123abc\fR attached, run:

.RS 2m
$ gcloud alpha dataplex lakes create my\-dataplex\-lake \e
    \-\-location=us\-central \e
    \-\-metastore\-service=projects/my\-project/services/service\-123abc
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Lakes resource \- Arguments and flags that define the Dataplex lake you want to
create. The arguments 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 in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5lake\fR on the command line with a fully specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fILAKE\fR

ID of the lakes or fully qualified identifier for the lakes.

To set the \f5lake\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5lake\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

The location of the Dataplex resource.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5lake\fR on the command line with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line;
.IP "\(bu" 2m
set the property \f5dataplex/location\fR.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR

Description of the lake.

.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

Display name of the lake.

.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to add.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m

Settings to manage metadata publishing to a Hive Metastore from a lake.


.RS 2m
.TP 2m
\fB\-\-metastore\-service\fR=\fIMETASTORE_SERVICE\fR

A relative reference to the Dataproc Metastore
(https://cloud.google.com/dataproc\-metastore/docs) service instance into which
metadata will be published. This is of the form:
\f5projects/{project_number}/locations/{location_id}/services/{service_id}\fR
where the location matches the location of the lake.

.RE
.sp
.TP 2m
\fB\-\-validate\-only\fR

Validate the create action, but don't actually perform it.


.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. This variant is also available:

.RS 2m
$ gcloud dataplex lakes create
.RE