gcloud looker instances update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud looker instances update - update a Looker instance
- SYNOPSIS
gcloud looker instances update(INSTANCE:--region=REGION)[--allowed-email-domains=[ALLOWED_EMAIL_DOMAINS,…]][--async][--class-type=CLASS_TYPE][--custom-domain=CUSTOM_DOMAIN][--linked-lsp-project-number=LINKED_LSP_PROJECT_NUMBER][--public-ip-enabled][--add-developer-users=ADD_DEVELOPER_USERS--add-standard-users=ADD_STANDARD_USERS--add-viewer-users=ADD_VIEWER_USERS][--clear-periodic-export-config|--periodic-export-gcs-uri=PERIODIC_EXPORT_GCS_URI--periodic-export-kms-key=PERIODIC_EXPORT_KMS_KEY--periodic-export-start-time=PERIODIC_EXPORT_START_TIME][--clear-psc-allowed-vpcs|--psc-allowed-vpcs=[PSC_ALLOWED_VPCS,…]--clear-psc-service-attachments|--psc-service-attachment=[attachment=ATTACHMENT],[domain=DOMAIN],[multiple-domains=MULTIPLE-DOMAINS]][--deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE--deny-maintenance-period-start-date=DENY_MAINTENANCE_PERIOD_START_DATE--deny-maintenance-period-time=DENY_MAINTENANCE_PERIOD_TIME][--egress-enabled--egress-fqdns=[EGRESS_FQDNS,…]--marketplace-enabled][--maintenance-window-day=MAINTENANCE_WINDOW_DAY--maintenance-window-time=MAINTENANCE_WINDOW_TIME][--oauth-client-id=OAUTH_CLIENT_ID--oauth-client-secret=OAUTH_CLIENT_SECRET][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Update the metadata and/or configuration parameters of a Looker instance.
This command can fail for the following reasons:
- The instance specified does not exist.
- The active account does not have permission to update the given instance.
- EXAMPLES
- To update the maintenance window to Sunday at 11:00 PM for a Looker instancewith the name
my-looker-instance, run:gcloudlookerinstancesupdatemy-looker-instance--maintenance-window-day=sunday--maintenance-window-time='23:00'--async - POSITIONAL ARGUMENTS
- Instance resource - Arguments and flags that specify the Looker instance youwant to update. The arguments in this group can be used to specify theattributes of this resource. (NOTE) Some attributes are not given arguments inthis group but can be set in other ways.
To set the
projectattribute:- provide the argument
instanceon the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
INSTANCE- ID of the instance or fully qualified identifier for the instance.
To set the
instanceattribute:- provide the argument
instanceon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--region=REGION- The name of the Looker region of the instance. Overrides the defaultlooker/region property value for this command invocation.To set the
regionattribute:- provide the argument
instanceon the command line with a fullyspecified name; - provide the argument
--regionon the command line; - set the property
looker/region.
- provide the argument
- provide the argument
- Instance resource - Arguments and flags that specify the Looker instance youwant to update. The arguments in this group can be used to specify theattributes of this resource. (NOTE) Some attributes are not given arguments inthis group but can be set in other ways.
- FLAGS
- Email Domain Allowlist for Scheduled Content - Define the email domains to whichyour users can deliver Looker (Google Cloud core) content.
--allowed-email-domains=[ALLOWED_EMAIL_DOMAINS,…]- This specifies the entire allowed email domain list.
--async- Return immediately, without waiting for the operation in progress to complete.
--class-type=CLASS_TYPE- The class type of the Looker instance.
CLASS_TYPEmustbe one of:p1,r1. - Custom Domains - Looker (Google Cloud core) lets you serve your applicationthrough a custom domain. If you use a custom domain, Google will provide amanaged auto-renewing SSL certificate for security.
DNS changes can take up to 24 hours to take effect. Your SSL certificate willtake several minutes to activate. Note that you must get the Type A DNS Recordfrom the Google Cloud Console and update with your domain registrar for yourcustom domain to work properly.
--custom-domain=CUSTOM_DOMAIN- Domain name wanted to serve the Looker instance.
--linked-lsp-project-number=LINKED_LSP_PROJECT_NUMBER- The Looker Studio Pro project number to be linked.
--public-ip-enabled- This specifies whether public IP is enabled on the Looker instance.
- User Allocations - There are ten Standard and two Developer users included inthe cost of the product. You can allocate additional Standard, Viewer, andDeveloper users for this instance. It is an optional step and can be modifiedlater.
With the Standard edition of Looker (Google Cloud core), you can provision up to50 total users, distributed across Viewer, Standard, and Developer.
--add-developer-users=ADD_DEVELOPER_USERS- Number of additional Developer Users to allocate to the Looker Instance.
--add-standard-users=ADD_STANDARD_USERS- Number of additional Standard Users to allocate to the Looker Instance.
--add-viewer-users=ADD_VIEWER_USERS- Number of additional Viewer Users to allocate to the Looker Instance.
- At most one of these can be specified:
--clear-periodic-export-config- Clears all periodic export configuration from the instance.
- Configuration for periodic export. All flags in this group must be provided toenable or update the configuration.
--periodic-export-gcs-uri=PERIODIC_EXPORT_GCS_URI- Cloud Storage bucket URI for periodic export. Format: gs://{bucket_name}
--periodic-export-kms-key=PERIODIC_EXPORT_KMS_KEY- Name of the CMEK key in KMS. Format:projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
--periodic-export-start-time=PERIODIC_EXPORT_START_TIME- Time in UTC when the periodic export job starts. A valid time of day must bespecified in 24hr format (ex: 13:00, 17:30, 23:45).
- Private Service Connect - Private Service Connect allows the Looker Instance tobe reached via a private connection from inside a VPC network, and for theLooker Instance to connect to managed services via private connections.
- At most one of these can be specified:
--clear-psc-allowed-vpcs- Remove all service attachments from the PSC config of the instance.
--psc-allowed-vpcs=[PSC_ALLOWED_VPCS,…]- List of VPCs that are allowed ingress into the Looker instance.
- At most one of these can be specified:
--clear-psc-service-attachments- Remove all allowed VPCs from the PSC config of the instance.
--psc-service-attachment=[attachment=ATTACHMENT],[domain=DOMAIN],[multiple-domains=MULTIPLE-DOMAINS]- Service attachments representing egress connections for the Looker instance.This flag can be repeated. (Example: --psc-service-attachmentdomain="mydomain.com",attachment="projects/my-project/regions/us-east1/serviceAttachments/sa"--psc-service-attachmentsdomain="mydomain2.com",attachment="projects/my-project/regions/us-east1/serviceAttachments/sa2")
You can also assign multiple domains to a single service attachment. (Example:--psc-service-attachmentmultiple-domains="mydomain.com;mydomain2.com",attachment="projects/my-project/regions/us-east1/serviceAttachments/sa")
- At most one of these can be specified:
- Deny Maintanence Period - You must allow at least 48 hours of maintenanceavailability in a 60-day rolling window. Only contiguous availability windows ofat least two hours are considered. When setting a maintenance exclusion pleasebe aware that excluding application upgrades cannot exceed 60-days and excludinginfrastructure upgrades cannot exceed 90-days.
--deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE- End date of the deny maintenance period in format: YYYY-MM-DD
This flag argument must be specified if any of the other arguments in this groupare specified.
--deny-maintenance-period-start-date=DENY_MAINTENANCE_PERIOD_START_DATE- Start date of the deny maintenance period in format: YYYY-MM-DD
This flag argument must be specified if any of the other arguments in this groupare specified.
--deny-maintenance-period-time=DENY_MAINTENANCE_PERIOD_TIME- Time in UTC when the period starts and ends. A valid time of day must bespecified in 24hr format (ex: 13:00, 17:30, 23:45).
This flag argument must be specified if any of the other arguments in this groupare specified.
- Controlled Egress - Controlled egress allows you to egress data from a Looker(Google Cloud core) instance to a third party service provider.
--egress-enabled- This specifies whether controlled egress is enabled on the Looker instance. Todisable controlled egress, use the
--no-egress-enabledflag. --egress-fqdns=[EGRESS_FQDNS,…]- List of FQDNs that are allowed to egress from the Looker instance. Example:
--egress-fqdns="github.com,my.salesforce.com". To clear all egressFQDNs, use--egress-fqdns="". --marketplace-enabled- This specifies whether marketplace is enabled for controlled egress on theLooker instance. To disable marketplace for controlled egress, use the
--no-marketplace-enabledflag.
- Maintenance Window - Maintenance typically only takes place once every fewmonths, and requires your instance to be restarted while updates are made, whichdisrupts service briefly.
--maintenance-window-day=MAINTENANCE_WINDOW_DAY- Day of the week for the maintenance window, in UTC time zone.
MAINTENANCE_WINDOW_DAYmust be one of:friday,monday,saturday,sunday,thursday,tuesday,wednesday.This flag argument must be specified if any of the other arguments in this groupare specified.
--maintenance-window-time=MAINTENANCE_WINDOW_TIME- Hour of day for maintenance window, in UTC time zone. A valid time of day mustbe specified in 24hr format (ex: 13:00, 17:30, 23:45). Maintenance will bescheduled within 60 minutes. To set the maintenance-window-time
attribute:--maintenance-window-time- provide the argument
on the command line.This flag argument must be specified if any of the other arguments in this groupare specified.
- OAuth Application Credentials - Looker Instance OAuth login settings. Setup anOAuth app that will allow users to authenticate and access the instance. Formore information see:https://developers.google.com/identity/protocols/oauth2/web-server#creatingcred
- --oauth-client-id
=OAUTH_CLIENT_ID - The client ID from an external OAuth application.
This flag argument must be specified if any of the other arguments in this groupare specified.
- --oauth-client-secret
=OAUTH_CLIENT_SECRET - The client secret from an external OAuth application.
This flag argument must be specified if any of the other arguments in this groupare specified.
- --oauth-client-id
- Email Domain Allowlist for Scheduled Content - Define the email domains to whichyour users can deliver Looker (Google Cloud core) content.
- 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 helpfor details. - API REFERENCE
- This command uses the
looker/v1API. The full documentation forthis API can be found at:https://cloud.google.com/looker/docs/reference/rest/ - NOTES
- This variant is also available:
gcloudalphalookerinstancesupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-09 UTC.