gcp_datafusion_instance

accelerators

Type: UNORDERED_LIST_STRUCT
Provider name: accelerators
Description: Output only. List of accelerators enabled for this CDF instance.

• accelerator_type
  Type: STRING
  Provider name: acceleratorType
  Description: Optional. The type of an accelator for a Cloud Data Fusion instance.
  Possible values:
  
  • ACCELERATOR_TYPE_UNSPECIFIED - Default value, if unspecified.
    
  • CDC - Change Data Capture accelerator for Cloud Data Fusion.
    
  • HEALTHCARE - Reserved for internal use.
    
  • CCAI_INSIGHTS - Contact Center AI Insights This accelerator is used to enable import and export pipelines custom built to streamline CCAI Insights processing.
    
  • CLOUDSEARCH - Reserved for internal use.
    
• state
  Type: STRING
  Provider name: state
  Description: Output only. The state of the accelerator.
  Possible values:
  
  • STATE_UNSPECIFIED - Default value, do not use.
    
  • ENABLED - Indicates that the accelerator is enabled and available to use.
    
  • DISABLED - Indicates that the accelerator is disabled and not available to use.
    
  • UNKNOWN - Indicates that accelerator state is currently unknown. Requests for enable, disable could be retried while in this state.
    

ancestors

Type: UNORDERED_LIST_STRING

api_endpoint

Type: STRING
Provider name: apiEndpoint
Description: Output only. Endpoint on which the REST APIs is accessible.

available_version

Type: UNORDERED_LIST_STRUCT
Provider name: availableVersion
Description: Output only. Available versions that the instance can be upgraded to using UpdateInstanceRequest.

• available_features
  Type: UNORDERED_LIST_STRING
  Provider name: availableFeatures
  Description: Represents a list of available feature names for a given version.
  
• default_version
  Type: BOOLEAN
  Provider name: defaultVersion
  Description: Whether this is currently the default version for Cloud Data Fusion
  
• type
  Type: STRING
  Provider name: type
  Description: Type represents the release availability of the version
  Possible values:
  
  • TYPE_UNSPECIFIED - Version does not have availability yet
    
  • TYPE_PREVIEW - Version is under development and not considered stable
    
  • TYPE_GENERAL_AVAILABILITY - Version is available for public use
    
  • TYPE_DEPRECATED - Version is no longer supported.
    
• version_number
  Type: STRING
  Provider name: versionNumber
  Description: The version number of the Data Fusion instance, such as ‘6.0.1.0’.
  

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. The time the instance was created.

crypto_key_config

Type: STRUCT
Provider name: cryptoKeyConfig
Description: Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.

• key_reference
  Type: STRING
  Provider name: keyReference
  Description: Optional. The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of projects/*/locations/*/keyRings/*/cryptoKeys/*.
  

dataplex_data_lineage_integration_enabled

Type: BOOLEAN
Provider name: dataplexDataLineageIntegrationEnabled
Description: Optional. Option to enable the Dataplex Lineage Integration feature.

dataproc_service_account

Type: STRING
Provider name: dataprocServiceAccount
Description: Optional. 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.

description

Type: STRING
Provider name: description
Description: Optional. A description of this instance.

disabled_reason

Type: UNORDERED_LIST_STRING
Provider name: disabledReason
Description: Output only. If the instance state is DISABLED, the reason for disabling the instance.

enable_rbac

Type: BOOLEAN
Provider name: enableRbac
Description: Optional. Option to enable granular role-based access control.

enable_stackdriver_logging

Type: BOOLEAN
Provider name: enableStackdriverLogging
Description: Optional. Option to enable Dataproc Stackdriver Logging.

enable_stackdriver_monitoring

Type: BOOLEAN
Provider name: enableStackdriverMonitoring
Description: Optional. Option to enable Stackdriver Monitoring.

enable_zone_separation

Type: BOOLEAN
Provider name: enableZoneSeparation
Description: Output only. Option to enable granular zone separation.

event_publish_config

Type: STRUCT
Provider name: eventPublishConfig
Description: Optional. Option to enable and pass metadata for event publishing.

• enabled
  Type: BOOLEAN
  Provider name: enabled
  Description: Required. Option to enable Event Publishing.
  
• topic
  Type: STRING
  Provider name: topic
  Description: Required. The resource name of the Pub/Sub topic. Format: projects/{project_id}/topics/{topic_id}
  

gcp_display_name

Type: STRING
Provider name: displayName
Description: Optional. Display name for an instance.

gcs_bucket

Type: STRING
Provider name: gcsBucket
Description: Output only. Cloud Storage bucket generated by Data Fusion in the customer project.

labels

Type: UNORDERED_LIST_STRING

logging_config

Type: STRUCT
Provider name: loggingConfig
Description: Optional. The logging configuration for this instance. This field is supported only in CDF versions 6.11.0 and above.

• instance_cloud_logging_disabled
  Type: BOOLEAN
  Provider name: instanceCloudLoggingDisabled
  Description: Optional. Option to determine whether instance logs should be written to Cloud Logging. By default, instance logs are written to Cloud Logging.
  

maintenance_events

Type: UNORDERED_LIST_STRUCT
Provider name: maintenanceEvents
Description: Output only. The maintenance events for this instance.

• end_time
  Type: TIMESTAMP
  Provider name: endTime
  Description: Output only. The end time of the maintenance event provided in RFC 3339 format. Example: “2024-01-02T12:04:06-06:00” This field will be empty if the maintenance event is not yet complete.
  
• start_time
  Type: TIMESTAMP
  Provider name: startTime
  Description: Output only. The start time of the maintenance event provided in RFC 3339 format. Example: “2024-01-01T12:04:06-04:00”
  
• state
  Type: STRING
  Provider name: state
  Description: Output only. The state of the maintenance event.
  Possible values:
  
  • STATE_UNSPECIFIED - The state of the maintenance event is unspecified.
    
  • SCHEDULED - The maintenance is scheduled but has not started.
    
  • STARTED - The maintenance has been started.
    
  • COMPLETED - The maintenance has been completed.
    

maintenance_policy

Type: STRUCT
Provider name: maintenancePolicy
Description: Optional. Configure the maintenance policy for this instance.

• maintenance_exclusion_window
  Type: STRUCT
  Provider name: maintenanceExclusionWindow
  Description: Optional. The maintenance exclusion window of the instance.
  
  • end_time
    Type: TIMESTAMP
    Provider name: endTime
    Description: Required. The end time of the time window provided in RFC 3339 format. The end time should take place after the start time. Example: “2024-01-02T12:04:06-06:00”
    
  • start_time
    Type: TIMESTAMP
    Provider name: startTime
    Description: Required. The start time of the time window provided in RFC 3339 format. Example: “2024-01-01T12:04:06-04:00”
    
• maintenance_window
  Type: STRUCT
  Provider name: maintenanceWindow
  Description: Optional. The maintenance window of the instance.
  
  • recurring_time_window
    Type: STRUCT
    Provider name: recurringTimeWindow
    Description: Required. The recurring time window of the maintenance window.
    
    • recurrence
      Type: STRING
      Provider name: recurrence
      Description: Required. An RRULE with format RFC-5545 for how this window reccurs. They go on for the span of time between the start and end time. The only supported FREQ value is “WEEKLY”. To have something repeat every weekday, use: “FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR”. This specifies how frequently the window starts. To have a 9 am - 5 pm UTC-4 window every weekday, use something like: start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
      
    • window
      Type: STRUCT
      Provider name: window
      Description: Required. The window representing the start and end time of recurrences. This field ignores the date components of the provided timestamps. Only the time of day and duration between start and end time are relevant.
      
      • end_time
        Type: TIMESTAMP
        Provider name: endTime
        Description: Required. The end time of the time window provided in RFC 3339 format. The end time should take place after the start time. Example: “2024-01-02T12:04:06-06:00”
        
      • start_time
        Type: TIMESTAMP
        Provider name: startTime
        Description: Required. The start time of the time window provided in RFC 3339 format. Example: “2024-01-01T12:04:06-04:00”
        

name

Type: STRING
Provider name: name
Description: Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.

network_config

Type: STRUCT
Provider name: networkConfig
Description: Optional. Network configuration options. These are required when a private Data Fusion instance is to be created.

• connection_type
  Type: STRING
  Provider name: connectionType
  Description: Optional. Type of connection for establishing private IP connectivity between the Data Fusion customer project VPC and the corresponding tenant project from a predefined list of available connection modes. If this field is unspecified for a private instance, VPC peering is used.
  Possible values:
  
  • CONNECTION_TYPE_UNSPECIFIED - No specific connection type was requested, the default value of VPC_PEERING is chosen.
    
  • VPC_PEERING - Requests the use of VPC peerings for connecting the consumer and tenant projects.
    
  • PRIVATE_SERVICE_CONNECT_INTERFACES - Requests the use of Private Service Connect Interfaces for connecting the consumer and tenant projects.
    
• ip_allocation
  Type: STRING
  Provider name: ipAllocation
  Description: Optional. The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the Data Fusion instance network. This is required only when using connection type VPC_PEERING. Format: a.b.c.d/22 Example: 192.168.0.0/22
  
• network
  Type: STRING
  Provider name: network
  Description: Optional. Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network}. This is only required for connectivity type VPC_PEERING.
  
• private_service_connect_config
  Type: STRUCT
  Provider name: privateServiceConnectConfig
  Description: Optional. Configuration for Private Service Connect. This is required only when using connection type PRIVATE_SERVICE_CONNECT_INTERFACES.
  
  • effective_unreachable_cidr_block
    Type: STRING
    Provider name: effectiveUnreachableCidrBlock
    Description: Output only. The CIDR block to which the CDF instance can’t route traffic to in the consumer project VPC. The size of this block is /25. The format of this field is governed by RFC 4632. Example: 240.0.0.0/25
    
  • network_attachment
    Type: STRING
    Provider name: networkAttachment
    Description: Required. The reference to the network attachment used to establish private connectivity. It will be of the form projects/{project-id}/regions/{region}/networkAttachments/{network-attachment-id}.
    
  • unreachable_cidr_block
    Type: STRING
    Provider name: unreachableCidrBlock
    Description: Optional. Input only. The CIDR block to which the CDF instance can’t route traffic to in the consumer project VPC. The size of this block should be at least /25. This range should not overlap with the primary address range of any subnetwork used by the network attachment. This range can be used for other purposes in the consumer VPC as long as there is no requirement for CDF to reach destinations using these addresses. If this value is not provided, the server chooses a non RFC 1918 address range. The format of this field is governed by RFC 4632. Example: 192.168.0.0/25
    

organization_id

Type: STRING

p4_service_account

Type: STRING
Provider name: p4ServiceAccount
Description: Output only. Service agent for the customer project.

parent

Type: STRING

patch_revision

Type: STRING
Provider name: patchRevision
Description: Optional. Current patch revision of the Data Fusion.

private_instance

Type: BOOLEAN
Provider name: privateInstance
Description: Optional. 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.

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

satisfies_pzi

Type: BOOLEAN
Provider name: satisfiesPzi
Description: Output only. Reserved for future use.

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: Output only. Reserved for future use.

service_account

Type: STRING
Provider name: serviceAccount
Description: Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.

service_endpoint

Type: STRING
Provider name: serviceEndpoint
Description: Output only. Endpoint on which the Data Fusion UI is accessible.

state

Type: STRING
Provider name: state
Description: Output only. The current state of this Data Fusion instance.
Possible values:

• STATE_UNSPECIFIED - Instance does not have a state yet
  
• CREATING - Instance is being created
  
• ACTIVE - Instance is active and ready for requests. This corresponds to ‘RUNNING’ in datafusion.v1beta1.
  
• FAILED - Instance creation failed
  
• DELETING - Instance is being deleted
  
• UPGRADING - Instance is being upgraded
  
• RESTARTING - Instance is being restarted
  
• UPDATING - Instance is being updated on customer request
  
• AUTO_UPDATING - Instance is being auto-updated
  
• AUTO_UPGRADING - Instance is being auto-upgraded
  
• DISABLED - Instance is disabled
  

state_message

Type: STRING
Provider name: stateMessage
Description: Output only. Additional information about the current state of this Data Fusion instance if available.

tags

Type: UNORDERED_LIST_STRING

tenant_project_id

Type: STRING
Provider name: tenantProjectId
Description: Output only. The name of the tenant project.

type

Type: STRING
Provider name: type
Description: Required. Instance type.
Possible values:

• TYPE_UNSPECIFIED - No type specified. The instance creation will fail.
  
• BASIC - Basic Data Fusion instance. In Basic type, the user will be able to create data pipelines using point and click UI. However, there are certain limitations, such as fewer number of concurrent pipelines, no support for streaming pipelines, etc.
  
• ENTERPRISE - Enterprise Data Fusion instance. In Enterprise type, the user will have all features available, such as support for streaming pipelines, higher number of concurrent pipelines, etc.
  
• DEVELOPER - Developer Data Fusion instance. In Developer type, the user will have all features available but with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration pipelines at low cost.
  

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The time the instance was last updated.

version

Type: STRING
Provider name: version
Description: Optional. Current version of the Data Fusion. Only specifiable in Update.

workforce_identity_service_endpoint

Type: STRING
Provider name: workforceIdentityServiceEndpoint
Description: Output only. Endpoint on which the Data Fusion UI is accessible to third-party users

zone

Type: STRING
Provider name: zone
Description: Optional. Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.