.TH "GCLOUD_ALPHA_LOGGING_SETTINGS_UPDATE" 1



.SH "NAME"
.HP
gcloud alpha logging settings update \- update the settings for the Cloud Logging Logs Router



.SH "SYNOPSIS"
.HP
\f5gcloud alpha logging settings update\fR (\fB\-\-folder\fR=\fIFOLDER_ID\fR\ |\ \fB\-\-organization\fR=\fIORGANIZATION_ID\fR) [\fB\-\-disable\-default\-sink\fR] [\fB\-\-storage\-location\fR=\fISTORAGE_LOCATION\fR] [\fB\-\-clear\-kms\-key\fR\ |\ [\fB\-\-kms\-key\-name\fR=\fIKMS_KEY_NAME\fR\ :\ \fB\-\-kms\-keyring\fR=\fIKMS_KEYRING\fR\ \fB\-\-kms\-location\fR=\fIKMS_LOCATION\fR\ \fB\-\-kms\-project\fR=\fIKMS_PROJECT\fR]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Use this command to update the \fB\-\-kms\-key\-name,
\-\-storage\-location, \-\-disable\-default\-sink\fR and \-\-analytics\-mode
associated with the Cloud Logging Logs Router.

The Cloud KMS key must already exist and Cloud Logging must have permission to
access it.

The storage location must be allowed by Org Policy.

Customer\-managed encryption keys (CMEK) for the Logs Router can currently only
be configured at the organization\-level and will apply to all projects in the
organization.



.SH "EXAMPLES"

To enable CMEK for the Logs Router for an organization, run:

.RS 2m
$ gcloud alpha logging settings update \e
    \-\-organization=[ORGANIZATION_ID] \e
    \-\-kms\-key\-name='projects/my\-project/locations/my\-location/keyRin\e
gs/my\-keyring/cryptoKeys/key'
.RE

To disable CMEK for the Logs Router for an organization, run:

.RS 2m
$ gcloud alpha logging settings update \e
    \-\-organization=[ORGANIZATION_ID] \-\-clear\-kms\-key
.RE

To update storage location for the Logs Router for an organization, run:

.RS 2m
$ gcloud alpha logging settings update \e
    \-\-organization=[ORGANIZATION_ID] \e
    \-\-storage\-location=[LOCATION_ID]
.RE

To update storage location for the Logs Router for a folder, run:

.RS 2m
$ gcloud alpha logging settings update \-\-folder=[FOLDER_ID] \e
    \-\-storage\-location=[LOCATION_ID]
.RE

To disable default sink for the Logs Router for an organization, run:

.RS 2m
$ gcloud alpha logging settings update \e
    \-\-organization=[ORGANIZATION_ID] \-\-disable\-default\-sink=true
.RE

To enable default sink for the Logs Router for an organization, run:

.RS 2m
$ gcloud alpha logging settings update \e
    \-\-organization=[ORGANIZATION_ID] \-\-disable\-default\-sink=false
.RE

To enable analytics for the log buckets under an organization, run:

.RS 2m
$ gcloud alpha logging settings update \e
    \-\-organization=[ORGANIZATION_ID] \-\-disable\-default\-sink=false \e
    \-\-analytics\-mode=required
.RE



.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-folder\fR=\fIFOLDER_ID\fR

Folder to update Logs Router settings for.

.TP 2m
\fB\-\-organization\fR=\fIORGANIZATION_ID\fR

Organization to update Logs Router settings for.


.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-disable\-default\-sink\fR

Enable or disable \f5_Default\fR sink for the \f5_Default\fR bucket. Specify
\-\-no\-disable\-default\-sink to enable a disabled \f5_Default\fR sink. Note:
It only applies to the newly created projects and will not affect the projects
created before.

.TP 2m
\fB\-\-storage\-location\fR=\fISTORAGE_LOCATION\fR

Update the storage location for \f5_Default\fR bucket and \f5_Required\fR
bucket. Note: It only applies to the newly created projects and will not affect
the projects created before.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-kms\-key\fR

Disable CMEK for the Logs Router by clearing out Cloud KMS cryptokey in the
organization's CMEK settings.

.TP 2m

Key resource \- The Cloud KMS (Key Management Service) cryptokey that will be
used to protect the logs being processed by the Cloud Logging Logs Router. The
Cloud KMS CryptoKey Encrypter/Decryper role must be assigned to the Cloud
Logging Logs Router service account. The arguments in this group can be used to
specify the attributes of this resource.


.RS 2m
.TP 2m
\fB\-\-kms\-key\-name\fR=\fIKMS_KEY_NAME\fR

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

To set the \f5kms\-key\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-kms\-key\-name\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-kms\-keyring\fR=\fIKMS_KEYRING\fR

The KMS keyring of the key.

To set the \f5kms\-keyring\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-kms\-key\-name\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-kms\-keyring\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-kms\-location\fR=\fIKMS_LOCATION\fR

The Google Cloud location for the key.

To set the \f5kms\-location\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-kms\-key\-name\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-kms\-location\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-kms\-project\fR=\fIKMS_PROJECT\fR

The Google Cloud project for the key.

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


.RE
.RE
.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. These variants are also available:

.RS 2m
$ gcloud logging settings update
.RE

.RS 2m
$ gcloud beta logging settings update
.RE