Console
Start free

gcloud logging buckets update

NAME
gcloud logging buckets update - update a bucket
SYNOPSIS
gcloud logging buckets update BUCKET_ID --location=LOCATION [--add-index=[KEY=VALUE, …,…]] [--async] [--clear-indexes] [--cmek-kms-key-name=CMEK_KMS_KEY_NAME] [--description=DESCRIPTION] [--enable-analytics] [--locked] [--remove-indexes=[FIELD PATH,…]] [--restricted-fields=[RESTRICTED_FIELD,…]] [--retention-days=RETENTION_DAYS] [--update-index=[KEY=VALUE, …,…]] [--billing-account=BILLING_ACCOUNT_ID     | --folder=FOLDER_ID     | --organization=ORGANIZATION_ID     | --project=PROJECT_ID] [GCLOUD_WIDE_FLAG …]
DESCRIPTION
Update the properties of a bucket.
EXAMPLES
To update a bucket in your project, run: 
gcloud logging buckets update my-bucket --location=global --description=my-new-description

To update a bucket in your project and remove all indexes, run: 

gcloud logging buckets update my-bucket --location=global --clear-indexes

To update a bucket in your project and remove an index, run: 

gcloud logging buckets update my-bucket --location=global --remove-indexes=jsonPayload.foo2

To update a bucket in your project and add an index, run: 

gcloud 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 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 logging buckets update my-bucket --location=global --cmek-kms-key-name=CMEK_KEY_NAME

To asynchronously enroll a bucket in your project into Log Analytics, run: 

gcloud logging buckets update my-bucket --location=global --async --enable-analytics
POSITIONAL ARGUMENTS
BUCKET_ID
The id of the bucket to update.
REQUIRED FLAGS
--location=LOCATION
Location of the bucket.
OPTIONAL FLAGS
--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.
--async
Return immediately, without waiting for the operation in progress to complete.
--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-analytics
Whether to opt the bucket into Log Analytics. Once opted in, the bucket cannot be opted out of Log Analytics.
--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.
At most one of these can be specified:
--billing-account=BILLING_ACCOUNT_ID
Billing account of the bucket to update.
--folder=FOLDER_ID
Folder of the bucket to update.
--organization=ORGANIZATION_ID
Organization of the bucket to update.
--project=PROJECT_ID
Project of the bucket to update.

The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be listed using gcloud config list --format='text(core.project)' and can be set using gcloud config set project PROJECTID.

--project and its fallback core/project property play two roles in the invocation. It specifies the project of the resource to operate on. It also specifies the project for API enablement check, quota, and billing. To specify a different project for quota and billing, use --billing-project or billing/quota_project property.
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
These variants are also available: 
gcloud alpha logging buckets update
 
gcloud beta logging buckets update