.TH "GCLOUD_LOGGING_BUCKETS_CREATE" 1



.SH "NAME"
.HP
gcloud logging buckets create \- create a bucket



.SH "SYNOPSIS"
.HP
\f5gcloud logging buckets create\fR \fIBUCKET_ID\fR \fB\-\-location\fR=\fILOCATION\fR [\fB\-\-async\fR] [\fB\-\-cmek\-kms\-key\-name\fR=\fICMEK_KMS_KEY_NAME\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-enable\-analytics\fR] [\fB\-\-index\fR=[\fIKEY\fR=\fIVALUE\fR,\ ...,...]] [\fB\-\-restricted\-fields\fR=[\fIRESTRICTED_FIELD\fR,...]] [\fB\-\-retention\-days\fR=\fIRETENTION_DAYS\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

After creating a bucket, use a log sink to route logs into the bucket.



.SH "EXAMPLES"

To create a bucket 'my\-bucket' in location 'global', run:

.RS 2m
$ gcloud logging buckets create my\-bucket \-\-location=global \e
    \-\-description="my custom bucket"
.RE

To create a bucket with extended retention, run:

.RS 2m
$ gcloud logging buckets create my\-bucket \-\-location=global \e
    \-\-retention\-days=365
.RE

To create a bucket in cloud region 'us\-central1', run:

.RS 2m
$ gcloud logging buckets create my\-bucket \-\-location=us\-central1
.RE

To create a bucket with custom index of 'jsonPayload.foo', run:

.RS 2m
$ gcloud logging buckets create my\-bucket \e
    \-\-index=fieldPath=jsonPayload.foo,type=INDEX_TYPE_STRING
.RE

To create a bucket with custom CMEK, run:

.RS 2m
$ gcloud logging buckets create my\-bucket \-\-location=us\-central1 \e
    \-\-cmek\-kms\-key\-name=CMEK_KMS_KEY_NAME
.RE

To asynchronously create a bucket enrolled into Log Analytics, run:

.RS 2m
$ gcloud logging buckets create my\-bucket \-\-location=global \e
    \-\-async \-\-enable\-analytics
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fIBUCKET_ID\fR

ID of the bucket to create.


.RE
.sp

.SH "REQUIRED FLAGS"

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

Location in which to create the bucket. Once the bucket is created, the location
cannot be changed.


.RE
.sp

.SH "OPTIONAL FLAGS"

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

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

.TP 2m
\fB\-\-cmek\-kms\-key\-name\fR=\fICMEK_KMS_KEY_NAME\fR

A valid \f5kms_key_name\fR will enable CMEK for the bucket.

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

A textual description for the bucket.

.TP 2m
\fB\-\-enable\-analytics\fR

Whether to opt the bucket into Log Analytics. Once opted in, the bucket cannot
be opted out of Log Analytics.

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

Specify an index to be added to the log bucket. This flag can be repeated. The
\f5\fIfieldPath\fR\fR and \f5\fItype\fR\fR attributes are required. For example:
\-\-index=fieldPath=jsonPayload.foo,type=INDEX_TYPE_STRING. The following keys
are accepted:

.RS 2m
.TP 2m
\fBfieldPath\fR
The LogEntry field path to index. For example: jsonPayload.request.status. Paths
are limited to 800 characters and can include only letters, digits, underscores,
hyphens, and periods.

.TP 2m
\fBtype\fR
The type of data in this index. For example: INDEX_TYPE_STRING Supported types
are INDEX_TYPE_STRING and INDEX_TYPE_INTEGER.

.RE
.sp
.TP 2m
\fB\-\-restricted\-fields\fR=[\fIRESTRICTED_FIELD\fR,...]

Comma\-separated list of field paths that require permission checks in this
bucket. The following fields and their children are eligible: textPayload,
jsonPayload, protoPayload, httpRequest, labels, sourceLocation.

.TP 2m
\fB\-\-retention\-days\fR=\fIRETENTION_DAYS\fR

The period logs will be retained, after which logs will automatically be
deleted. The default is 30 days.


.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"

These variants are also available:

.RS 2m
$ gcloud alpha logging buckets create
.RE

.RS 2m
$ gcloud beta logging buckets create
.RE