instances

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

Overview

Name	instances
Type	Resource
Id	google.datafusion.instances

Fields

Name	Datatype	Description
name	string	Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.
description	string	A description of this instance.
accelerators	array	Output only. List of accelerators enabled for this CDF instance.
apiEndpoint	string	Output only. Endpoint on which the REST APIs is accessible.
availableVersion	array	Output only. Available versions that the instance can be upgraded to using UpdateInstanceRequest.
createTime	string	Output only. The time the instance was created.
cryptoKeyConfig	object	The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature.
dataplexDataLineageIntegrationEnabled	boolean	Optional. Option to enable the Dataplex Lineage Integration feature.
dataprocServiceAccount	string	User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources.
disabledReason	array	Output only. If the instance state is DISABLED, the reason for disabling the instance.
displayName	string	Display name for an instance.
enableRbac	boolean	Option to enable granular role-based access control.
enableStackdriverLogging	boolean	Option to enable Stackdriver Logging.
enableStackdriverMonitoring	boolean	Option to enable Stackdriver Monitoring.
enableZoneSeparation	boolean	Option to enable granular zone separation.
eventPublishConfig	object	Confirguration of PubSubEventWriter.
gcsBucket	string	Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
labels	object	The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels.
maintenancePolicy	object	Maintenance policy of the instance.
networkConfig	object	Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources.
options	object	Map of additional options used to configure the behavior of Data Fusion instance.
p4ServiceAccount	string	Output only. Service agent for the customer project.
patchRevision	string	Optional. Current patch revision of the Data Fusion.
privateInstance	boolean	Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet.
satisfiesPzs	boolean	Output only. Reserved for future use.
serviceAccount	string	Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.
serviceEndpoint	string	Output only. Endpoint on which the Data Fusion UI is accessible.
state	string	Output only. The current state of this Data Fusion instance.
stateMessage	string	Output only. Additional information about the current state of this Data Fusion instance if available.
tenantProjectId	string	Output only. The name of the tenant project.
type	string	Required. Instance type.
updateTime	string	Output only. The time the instance was last updated.
version	string	Current version of the Data Fusion. Only specifiable in Update.
workforceIdentityServiceEndpoint	string	Output only. Endpoint on which the Data Fusion UI is accessible to third-party users
zone	string	Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	instancesId, locationsId, projectsId	Gets details of a single Data Fusion instance.
list	SELECT	locationsId, projectsId	Lists Data Fusion instances in the specified project and location.
create	INSERT	locationsId, projectsId	Creates a new Data Fusion instance in the specified project and location.
delete	DELETE	instancesId, locationsId, projectsId	Deletes a single Date Fusion instance.
patch	UPDATE	instancesId, locationsId, projectsId	Updates a single Data Fusion instance.
restart	EXEC	instancesId, locationsId, projectsId	Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.

SELECT examples

Lists Data Fusion instances in the specified project and location.

SELECT
name,
description,
accelerators,
apiEndpoint,
availableVersion,
createTime,
cryptoKeyConfig,
dataplexDataLineageIntegrationEnabled,
dataprocServiceAccount,
disabledReason,
displayName,
enableRbac,
enableStackdriverLogging,
enableStackdriverMonitoring,
enableZoneSeparation,
eventPublishConfig,
gcsBucket,
labels,
maintenancePolicy,
networkConfig,
options,
p4ServiceAccount,
patchRevision,
privateInstance,
satisfiesPzs,
serviceAccount,
serviceEndpoint,
state,
stateMessage,
tenantProjectId,
type,
updateTime,
version,
workforceIdentityServiceEndpoint,
zone
FROM google.datafusion.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.datafusion.instances (
locationsId,
projectsId,
description,
type,
enableStackdriverLogging,
enableStackdriverMonitoring,
privateInstance,
networkConfig,
labels,
options,
zone,
version,
displayName,
dataprocServiceAccount,
enableRbac,
cryptoKeyConfig,
eventPublishConfig,
enableZoneSeparation,
patchRevision,
dataplexDataLineageIntegrationEnabled,
maintenancePolicy
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ description }}',
'{{ type }}',
{{ enableStackdriverLogging }},
{{ enableStackdriverMonitoring }},
{{ privateInstance }},
'{{ networkConfig }}',
'{{ labels }}',
'{{ options }}',
'{{ zone }}',
'{{ version }}',
'{{ displayName }}',
'{{ dataprocServiceAccount }}',
{{ enableRbac }},
'{{ cryptoKeyConfig }}',
'{{ eventPublishConfig }}',
{{ enableZoneSeparation }},
'{{ patchRevision }}',
{{ dataplexDataLineageIntegrationEnabled }},
'{{ maintenancePolicy }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: description
      value: string
    - name: type
      value: string
    - name: enableStackdriverLogging
      value: boolean
    - name: enableStackdriverMonitoring
      value: boolean
    - name: privateInstance
      value: boolean
    - name: networkConfig
      value:
        - name: network
          value: string
        - name: ipAllocation
          value: string
        - name: connectionType
          value: string
        - name: privateServiceConnectConfig
          value:
            - name: networkAttachment
              value: string
            - name: unreachableCidrBlock
              value: string
            - name: effectiveUnreachableCidrBlock
              value: string
    - name: labels
      value: object
    - name: options
      value: object
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: state
      value: string
    - name: stateMessage
      value: string
    - name: serviceEndpoint
      value: string
    - name: zone
      value: string
    - name: version
      value: string
    - name: serviceAccount
      value: string
    - name: displayName
      value: string
    - name: availableVersion
      value:
        - - name: versionNumber
            value: string
          - name: defaultVersion
            value: boolean
          - name: availableFeatures
            value:
              - string
          - name: type
            value: string
    - name: apiEndpoint
      value: string
    - name: gcsBucket
      value: string
    - name: accelerators
      value:
        - - name: acceleratorType
            value: string
          - name: state
            value: string
    - name: p4ServiceAccount
      value: string
    - name: tenantProjectId
      value: string
    - name: dataprocServiceAccount
      value: string
    - name: enableRbac
      value: boolean
    - name: cryptoKeyConfig
      value:
        - name: keyReference
          value: string
    - name: disabledReason
      value:
        - string
    - name: eventPublishConfig
      value:
        - name: enabled
          value: boolean
        - name: topic
          value: string
    - name: enableZoneSeparation
      value: boolean
    - name: satisfiesPzs
      value: boolean
    - name: workforceIdentityServiceEndpoint
      value: string
    - name: patchRevision
      value: string
    - name: dataplexDataLineageIntegrationEnabled
      value: boolean
    - name: maintenancePolicy
      value:
        - name: maintenanceWindow
          value:
            - name: recurringTimeWindow
              value:
                - name: window
                  value:
                    - name: startTime
                      value: string
                    - name: endTime
                      value: string
                - name: recurrence
                  value: string

UPDATE example

Updates a instances resource.

/*+ update */
UPDATE google.datafusion.instances
SET 
description = '{{ description }}',
type = '{{ type }}',
enableStackdriverLogging = true|false,
enableStackdriverMonitoring = true|false,
privateInstance = true|false,
networkConfig = '{{ networkConfig }}',
labels = '{{ labels }}',
options = '{{ options }}',
zone = '{{ zone }}',
version = '{{ version }}',
displayName = '{{ displayName }}',
dataprocServiceAccount = '{{ dataprocServiceAccount }}',
enableRbac = true|false,
cryptoKeyConfig = '{{ cryptoKeyConfig }}',
eventPublishConfig = '{{ eventPublishConfig }}',
enableZoneSeparation = true|false,
patchRevision = '{{ patchRevision }}',
dataplexDataLineageIntegrationEnabled = true|false,
maintenancePolicy = '{{ maintenancePolicy }}'
WHERE 
instancesId = '{{ instancesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified instances resource.

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