instances

Creates, updates, deletes, gets or lists a instances resource.

Overview

Name	instances
Type	Resource
Id	google.looker.instances

Fields

Name	Datatype	Description
name	string	Output only. Format: projects/{project}/locations/{location}/instances/{instance}.
adminSettings	object	Looker instance Admin settings fields.
consumerNetwork	string	Network name in the consumer project. Format: projects/{project}/global/networks/{network}. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance.
createTime	string	Output only. The time when the Looker instance provisioning was first requested.
customDomain	object	Custom domain information.
denyMaintenancePeriod	object	Specifies the maintenance denial period.
egressPublicIp	string	Output only. Public Egress IP (IPv4).
encryptionConfig	object	Encryption configuration (i.e. CMEK).
fipsEnabled	boolean	Optional. Whether FIPS is enabled on the Looker instance.
geminiEnabled	boolean	Optional. Whether Gemini feature is enabled on the Looker instance or not.
ingressPrivateIp	string	Output only. Private Ingress IP (IPv4).
ingressPublicIp	string	Output only. Public Ingress IP (IPv4).
lastDenyMaintenancePeriod	object	Specifies the maintenance denial period.
linkedLspProjectNumber	string	Optional. Linked Google Cloud Project Number for Looker Studio Pro.
lookerUri	string	Output only. Looker instance URI which can be used to access the Looker Instance UI.
lookerVersion	string	Output only. The Looker version that the instance is using.
maintenanceSchedule	object	Published upcoming future maintenance schedule.
maintenanceWindow	object	Specifies the recurring maintenance window.
oauthConfig	object	Looker instance OAuth login settings.
platformEdition	string	Platform edition.
privateIpEnabled	boolean	Whether private IP is enabled on the Looker instance.
pscConfig	object	Information for Private Service Connect (PSC) setup for a Looker instance.
pscEnabled	boolean	Optional. Whether to use Private Service Connect (PSC) for private IP connectivity. If true, neither public_ip_enabled nor private_ip_enabled can be true.
publicIpEnabled	boolean	Whether public IP is enabled on the Looker instance.
reservedRange	string	Name of a reserved IP address range within the Instance.consumer_network, to be used for private services access connection. May or may not be specified in a create request.
state	string	Output only. The state of the instance.
updateTime	string	Output only. The time when the Looker instance was last updated.
userMetadata	object	Metadata about users for a Looker instance.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	instancesId, locationsId, projectsId	Gets details of a single Instance.
list	SELECT	locationsId, projectsId	Lists Instances in a given project and location.
create	INSERT	locationsId, projectsId	Creates a new Instance in a given project and location.
delete	DELETE	instancesId, locationsId, projectsId	Delete instance.
patch	UPDATE	instancesId, locationsId, projectsId	Update Instance.
export	EXEC	instancesId, locationsId, projectsId	Export instance.
import	EXEC	instancesId, locationsId, projectsId	Import instance.
restart	EXEC	instancesId, locationsId, projectsId	Restart instance.

SELECT examples

Lists Instances in a given project and location.

SELECT
name,
adminSettings,
consumerNetwork,
createTime,
customDomain,
denyMaintenancePeriod,
egressPublicIp,
encryptionConfig,
fipsEnabled,
geminiEnabled,
ingressPrivateIp,
ingressPublicIp,
lastDenyMaintenancePeriod,
linkedLspProjectNumber,
lookerUri,
lookerVersion,
maintenanceSchedule,
maintenanceWindow,
oauthConfig,
platformEdition,
privateIpEnabled,
pscConfig,
pscEnabled,
publicIpEnabled,
reservedRange,
state,
updateTime,
userMetadata
FROM google.looker.instances
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new instances resource.

All Properties

/*+ create */
INSERT INTO google.looker.instances (
locationsId,
projectsId,
platformEdition,
publicIpEnabled,
privateIpEnabled,
pscEnabled,
pscConfig,
consumerNetwork,
reservedRange,
maintenanceWindow,
denyMaintenancePeriod,
maintenanceSchedule,
userMetadata,
customDomain,
encryptionConfig,
adminSettings,
oauthConfig,
linkedLspProjectNumber,
fipsEnabled,
geminiEnabled
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ platformEdition }}',
{{ publicIpEnabled }},
{{ privateIpEnabled }},
{{ pscEnabled }},
'{{ pscConfig }}',
'{{ consumerNetwork }}',
'{{ reservedRange }}',
'{{ maintenanceWindow }}',
'{{ denyMaintenancePeriod }}',
'{{ maintenanceSchedule }}',
'{{ userMetadata }}',
'{{ customDomain }}',
'{{ encryptionConfig }}',
'{{ adminSettings }}',
'{{ oauthConfig }}',
'{{ linkedLspProjectNumber }}',
{{ fipsEnabled }},
{{ geminiEnabled }}
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: state
      value: string
    - name: platformEdition
      value: string
    - name: publicIpEnabled
      value: boolean
    - name: privateIpEnabled
      value: boolean
    - name: lookerVersion
      value: string
    - name: egressPublicIp
      value: string
    - name: ingressPrivateIp
      value: string
    - name: ingressPublicIp
      value: string
    - name: lookerUri
      value: string
    - name: pscEnabled
      value: boolean
    - name: pscConfig
      value:
        - name: allowedVpcs
          value:
            - string
        - name: serviceAttachments
          value:
            - - name: localFqdn
                value: string
              - name: targetServiceAttachmentUri
                value: string
              - name: connectionStatus
                value: string
        - name: lookerServiceAttachmentUri
          value: string
    - name: consumerNetwork
      value: string
    - name: reservedRange
      value: string
    - name: maintenanceWindow
      value:
        - name: dayOfWeek
          value: string
        - name: startTime
          value:
            - name: hours
              value: integer
            - name: minutes
              value: integer
            - name: seconds
              value: integer
            - name: nanos
              value: integer
    - name: denyMaintenancePeriod
      value:
        - name: startDate
          value:
            - name: year
              value: integer
            - name: month
              value: integer
            - name: day
              value: integer
    - name: maintenanceSchedule
      value:
        - name: startTime
          value: string
        - name: endTime
          value: string
    - name: userMetadata
      value:
        - name: additionalViewerUserCount
          value: integer
        - name: additionalStandardUserCount
          value: integer
        - name: additionalDeveloperUserCount
          value: integer
    - name: customDomain
      value:
        - name: domain
          value: string
        - name: state
          value: string
    - name: encryptionConfig
      value:
        - name: kmsKeyName
          value: string
        - name: kmsKeyState
          value: string
        - name: kmsKeyNameVersion
          value: string
    - name: adminSettings
      value:
        - name: allowedEmailDomains
          value:
            - string
    - name: oauthConfig
      value:
        - name: clientId
          value: string
        - name: clientSecret
          value: string
    - name: linkedLspProjectNumber
      value: string
    - name: fipsEnabled
      value: boolean
    - name: geminiEnabled
      value: boolean

UPDATE example

Updates a instances resource.

/*+ update */
UPDATE google.looker.instances
SET 
platformEdition = '{{ platformEdition }}',
publicIpEnabled = true|false,
privateIpEnabled = true|false,
pscEnabled = true|false,
pscConfig = '{{ pscConfig }}',
consumerNetwork = '{{ consumerNetwork }}',
reservedRange = '{{ reservedRange }}',
maintenanceWindow = '{{ maintenanceWindow }}',
denyMaintenancePeriod = '{{ denyMaintenancePeriod }}',
maintenanceSchedule = '{{ maintenanceSchedule }}',
userMetadata = '{{ userMetadata }}',
customDomain = '{{ customDomain }}',
encryptionConfig = '{{ encryptionConfig }}',
adminSettings = '{{ adminSettings }}',
oauthConfig = '{{ oauthConfig }}',
linkedLspProjectNumber = '{{ linkedLspProjectNumber }}',
fipsEnabled = true|false,
geminiEnabled = true|false
WHERE 
instancesId = '{{ instancesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified instances resource.

/*+ delete */
DELETE FROM google.looker.instances
WHERE instancesId = '{{ instancesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';