gcloud alpha logging buckets update - update a bucket
gcloud alpha logging buckets update BUCKET_ID --location=LOCATION [--add-index=[KEY=VALUE, ...,...]] [--clear-indexes] [--cmek-kms-key-name=CMEK_KMS_KEY_NAME] [--description=DESCRIPTION] [--enable-loglink] [--locked] [--remove-indexes=[FIELD PATH,...]] [--restricted-fields=[RESTRICTED_FIELD,...]] [--retention-days=RETENTION_DAYS] [--update-index=[KEY=VALUE, ...,...]] [GCLOUD_WIDE_FLAG ...]
(ALPHA) Update the properties of a bucket.
To update a bucket in your project, run:
$ gcloud alpha logging buckets update my-bucket --location=global \ --description=my-new-description
To update a bucket in your project and remove all indexes, run:
$ gcloud alpha logging buckets update my-bucket --location=global \ --clear-indexes
To update a bucket in your project and remove an index, run:
$ gcloud alpha logging buckets update my-bucket --location=global \ --remove-indexes=jsonPayload.foo2
To update a bucket in your project and add an index, run:
$ gcloud alpha logging buckets update my-bucket --location=global \ --add-index=fieldPath=jsonPayload.foo2,type=INDEX_TYPE_STRING
To update a bucket in your project and update an existing index, run:
$ gcloud alpha logging buckets update my-bucket --location=global \ --update-index=fieldPath=jsonPayload.foo,type=INDEX_TYPE_INTEGER
To update a bucket in your project and update existing cmek, run:
$ gcloud alpha logging buckets update my-bucket --location=global \ --cmek-kms-key-name=CMEK_KEY_NAME
- BUCKET_ID
The id of the bucket to update.
- --location=LOCATION
Location of the bucket.
- --add-index=[KEY=VALUE, ...,...]
Add an index to be added to the log bucket. This flag can be repeated. The fieldPath and type attributes are required. For example: --index=fieldPath=jsonPayload.foo,type=INDEX_TYPE_STRING. The following keys are accepted:
- fieldPath
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.
- type
The type of data in this index. For example: INDEX_TYPE_STRING Supported types are strings and integers.
- --clear-indexes
Remove all logging indexes from the bucket.
- --cmek-kms-key-name=CMEK_KMS_KEY_NAME
A valid kms_key_name will enable CMEK for the bucket.
- --description=DESCRIPTION
A new description for the bucket.
- --enable-loglink
Enables a linked dataset in BigQuery corresponding to this log bucket. The linked dataset contains authorized views which give a ready-only access to logs in BigQuery. This option can only be enabled in a log bucket with advanced log analytics enabled. Use --no-enable-loglink to disable the linked dataset.
- --locked
Lock the bucket and prevent it from being modified or deleted (unless it is empty).
- --remove-indexes=[FIELD PATH,...]
Specify the field path of the logging index(es) to delete.
- --restricted-fields=[RESTRICTED_FIELD,...]
A new set of restricted fields for the bucket.
- --retention-days=RETENTION_DAYS
A new retention period for the bucket.
- --update-index=[KEY=VALUE, ...,...]
Update an index to be added to the log bucket. This will update the type of the index, and also update its createTime to the new update time. This flag can be repeated. The fieldPath and type attributes are required. For example: --index=fieldPath=jsonPayload.foo,type=INDEX_TYPE_STRING. The following keys are accepted:
- fieldPath
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.
- type
The type of data in this index. For example: INDEX_TYPE_STRING Supported types are strings and integers.
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.
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:
$ gcloud logging buckets update
$ gcloud beta logging buckets update