Google Cloud v9.3.0, Oct 7 25

Google Cloud v9.3.0 published on Tuesday, Oct 7, 2025 by Pulumi

gcp.discoveryengine.DataConnector

Google Cloud v9.3.0 published on Tuesday, Oct 7, 2025 by Pulumi

DataConnector manages the connection to external data sources for all data stores grouped under a Collection. It’s a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.

To get more information about DataConnector, see:

API documentation
How-to Guides
- Introduction

Example Usage

Discoveryengine Dataconnector Jira Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const jira_basic = new gcp.discoveryengine.DataConnector("jira-basic", {
    location: "global",
    collectionId: "collection-id",
    collectionDisplayName: "tf-test-dataconnector-jira",
    dataSource: "jira",
    params: {
        instance_id: "33db20a3-dc45-4305-a505-d70b68599840",
        instance_uri: "https://vaissptbots1.atlassian.net/",
        client_secret: "client-secret",
        client_id: "client-id",
        refresh_token: "fill-in-the-blank",
    },
    refreshInterval: "86400s",
    entities: [
        {
            entityName: "project",
        },
        {
            entityName: "issue",
        },
        {
            entityName: "attachment",
        },
        {
            entityName: "comment",
        },
        {
            entityName: "worklog",
        },
    ],
    staticIpEnabled: true,
});

import pulumi
import pulumi_gcp as gcp

jira_basic = gcp.discoveryengine.DataConnector("jira-basic",
    location="global",
    collection_id="collection-id",
    collection_display_name="tf-test-dataconnector-jira",
    data_source="jira",
    params={
        "instance_id": "33db20a3-dc45-4305-a505-d70b68599840",
        "instance_uri": "https://vaissptbots1.atlassian.net/",
        "client_secret": "client-secret",
        "client_id": "client-id",
        "refresh_token": "fill-in-the-blank",
    },
    refresh_interval="86400s",
    entities=[
        {
            "entity_name": "project",
        },
        {
            "entity_name": "issue",
        },
        {
            "entity_name": "attachment",
        },
        {
            "entity_name": "comment",
        },
        {
            "entity_name": "worklog",
        },
    ],
    static_ip_enabled=True)

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/discoveryengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := discoveryengine.NewDataConnector(ctx, "jira-basic", &discoveryengine.DataConnectorArgs{
			Location:              pulumi.String("global"),
			CollectionId:          pulumi.String("collection-id"),
			CollectionDisplayName: pulumi.String("tf-test-dataconnector-jira"),
			DataSource:            pulumi.String("jira"),
			Params: pulumi.StringMap{
				"instance_id":   pulumi.String("33db20a3-dc45-4305-a505-d70b68599840"),
				"instance_uri":  pulumi.String("https://vaissptbots1.atlassian.net/"),
				"client_secret": pulumi.String("client-secret"),
				"client_id":     pulumi.String("client-id"),
				"refresh_token": pulumi.String("fill-in-the-blank"),
			},
			RefreshInterval: pulumi.String("86400s"),
			Entities: discoveryengine.DataConnectorEntityArray{
				&discoveryengine.DataConnectorEntityArgs{
					EntityName: pulumi.String("project"),
				},
				&discoveryengine.DataConnectorEntityArgs{
					EntityName: pulumi.String("issue"),
				},
				&discoveryengine.DataConnectorEntityArgs{
					EntityName: pulumi.String("attachment"),
				},
				&discoveryengine.DataConnectorEntityArgs{
					EntityName: pulumi.String("comment"),
				},
				&discoveryengine.DataConnectorEntityArgs{
					EntityName: pulumi.String("worklog"),
				},
			},
			StaticIpEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var jira_basic = new Gcp.DiscoveryEngine.DataConnector("jira-basic", new()
    {
        Location = "global",
        CollectionId = "collection-id",
        CollectionDisplayName = "tf-test-dataconnector-jira",
        DataSource = "jira",
        Params = 
        {
            { "instance_id", "33db20a3-dc45-4305-a505-d70b68599840" },
            { "instance_uri", "https://vaissptbots1.atlassian.net/" },
            { "client_secret", "client-secret" },
            { "client_id", "client-id" },
            { "refresh_token", "fill-in-the-blank" },
        },
        RefreshInterval = "86400s",
        Entities = new[]
        {
            new Gcp.DiscoveryEngine.Inputs.DataConnectorEntityArgs
            {
                EntityName = "project",
            },
            new Gcp.DiscoveryEngine.Inputs.DataConnectorEntityArgs
            {
                EntityName = "issue",
            },
            new Gcp.DiscoveryEngine.Inputs.DataConnectorEntityArgs
            {
                EntityName = "attachment",
            },
            new Gcp.DiscoveryEngine.Inputs.DataConnectorEntityArgs
            {
                EntityName = "comment",
            },
            new Gcp.DiscoveryEngine.Inputs.DataConnectorEntityArgs
            {
                EntityName = "worklog",
            },
        },
        StaticIpEnabled = true,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.discoveryengine.DataConnector;
import com.pulumi.gcp.discoveryengine.DataConnectorArgs;
import com.pulumi.gcp.discoveryengine.inputs.DataConnectorEntityArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var jira_basic = new DataConnector("jira-basic", DataConnectorArgs.builder()
            .location("global")
            .collectionId("collection-id")
            .collectionDisplayName("tf-test-dataconnector-jira")
            .dataSource("jira")
            .params(Map.ofEntries(
                Map.entry("instance_id", "33db20a3-dc45-4305-a505-d70b68599840"),
                Map.entry("instance_uri", "https://vaissptbots1.atlassian.net/"),
                Map.entry("client_secret", "client-secret"),
                Map.entry("client_id", "client-id"),
                Map.entry("refresh_token", "fill-in-the-blank")
            ))
            .refreshInterval("86400s")
            .entities(            
                DataConnectorEntityArgs.builder()
                    .entityName("project")
                    .build(),
                DataConnectorEntityArgs.builder()
                    .entityName("issue")
                    .build(),
                DataConnectorEntityArgs.builder()
                    .entityName("attachment")
                    .build(),
                DataConnectorEntityArgs.builder()
                    .entityName("comment")
                    .build(),
                DataConnectorEntityArgs.builder()
                    .entityName("worklog")
                    .build())
            .staticIpEnabled(true)
            .build());

    }
}

resources:
  jira-basic:
    type: gcp:discoveryengine:DataConnector
    properties:
      location: global
      collectionId: collection-id
      collectionDisplayName: tf-test-dataconnector-jira
      dataSource: jira
      params:
        instance_id: 33db20a3-dc45-4305-a505-d70b68599840
        instance_uri: https://vaissptbots1.atlassian.net/
        client_secret: client-secret
        client_id: client-id
        refresh_token: fill-in-the-blank
      refreshInterval: 86400s
      entities:
        - entityName: project
        - entityName: issue
        - entityName: attachment
        - entityName: comment
        - entityName: worklog
      staticIpEnabled: true

Create DataConnector Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DataConnector(name: string, args: DataConnectorArgs, opts?: CustomResourceOptions);

@overload
def DataConnector(resource_name: str,
                  args: DataConnectorArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def DataConnector(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  collection_display_name: Optional[str] = None,
                  collection_id: Optional[str] = None,
                  data_source: Optional[str] = None,
                  location: Optional[str] = None,
                  refresh_interval: Optional[str] = None,
                  entities: Optional[Sequence[DataConnectorEntityArgs]] = None,
                  json_params: Optional[str] = None,
                  kms_key_name: Optional[str] = None,
                  params: Optional[Mapping[str, str]] = None,
                  project: Optional[str] = None,
                  static_ip_enabled: Optional[bool] = None)

func NewDataConnector(ctx *Context, name string, args DataConnectorArgs, opts ...ResourceOption) (*DataConnector, error)

public DataConnector(string name, DataConnectorArgs args, CustomResourceOptions? opts = null)

public DataConnector(String name, DataConnectorArgs args)
public DataConnector(String name, DataConnectorArgs args, CustomResourceOptions options)

type: gcp:discoveryengine:DataConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args DataConnectorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DataConnectorArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DataConnectorArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DataConnectorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DataConnectorArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var dataConnectorResource = new Gcp.DiscoveryEngine.DataConnector("dataConnectorResource", new()
{
    CollectionDisplayName = "string",
    CollectionId = "string",
    DataSource = "string",
    Location = "string",
    RefreshInterval = "string",
    Entities = new[]
    {
        new Gcp.DiscoveryEngine.Inputs.DataConnectorEntityArgs
        {
            DataStore = "string",
            EntityName = "string",
            KeyPropertyMappings = 
            {
                { "string", "string" },
            },
            Params = 
            {
                { "string", "string" },
            },
        },
    },
    JsonParams = "string",
    KmsKeyName = "string",
    Params = 
    {
        { "string", "string" },
    },
    Project = "string",
    StaticIpEnabled = false,
});

example, err := discoveryengine.NewDataConnector(ctx, "dataConnectorResource", &discoveryengine.DataConnectorArgs{
	CollectionDisplayName: pulumi.String("string"),
	CollectionId:          pulumi.String("string"),
	DataSource:            pulumi.String("string"),
	Location:              pulumi.String("string"),
	RefreshInterval:       pulumi.String("string"),
	Entities: discoveryengine.DataConnectorEntityArray{
		&discoveryengine.DataConnectorEntityArgs{
			DataStore:  pulumi.String("string"),
			EntityName: pulumi.String("string"),
			KeyPropertyMappings: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Params: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
	},
	JsonParams: pulumi.String("string"),
	KmsKeyName: pulumi.String("string"),
	Params: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project:         pulumi.String("string"),
	StaticIpEnabled: pulumi.Bool(false),
})

var dataConnectorResource = new DataConnector("dataConnectorResource", DataConnectorArgs.builder()
    .collectionDisplayName("string")
    .collectionId("string")
    .dataSource("string")
    .location("string")
    .refreshInterval("string")
    .entities(DataConnectorEntityArgs.builder()
        .dataStore("string")
        .entityName("string")
        .keyPropertyMappings(Map.of("string", "string"))
        .params(Map.of("string", "string"))
        .build())
    .jsonParams("string")
    .kmsKeyName("string")
    .params(Map.of("string", "string"))
    .project("string")
    .staticIpEnabled(false)
    .build());

data_connector_resource = gcp.discoveryengine.DataConnector("dataConnectorResource",
    collection_display_name="string",
    collection_id="string",
    data_source="string",
    location="string",
    refresh_interval="string",
    entities=[{
        "data_store": "string",
        "entity_name": "string",
        "key_property_mappings": {
            "string": "string",
        },
        "params": {
            "string": "string",
        },
    }],
    json_params="string",
    kms_key_name="string",
    params={
        "string": "string",
    },
    project="string",
    static_ip_enabled=False)

const dataConnectorResource = new gcp.discoveryengine.DataConnector("dataConnectorResource", {
    collectionDisplayName: "string",
    collectionId: "string",
    dataSource: "string",
    location: "string",
    refreshInterval: "string",
    entities: [{
        dataStore: "string",
        entityName: "string",
        keyPropertyMappings: {
            string: "string",
        },
        params: {
            string: "string",
        },
    }],
    jsonParams: "string",
    kmsKeyName: "string",
    params: {
        string: "string",
    },
    project: "string",
    staticIpEnabled: false,
});

type: gcp:discoveryengine:DataConnector
properties:
    collectionDisplayName: string
    collectionId: string
    dataSource: string
    entities:
        - dataStore: string
          entityName: string
          keyPropertyMappings:
            string: string
          params:
            string: string
    jsonParams: string
    kmsKeyName: string
    location: string
    params:
        string: string
    project: string
    refreshInterval: string
    staticIpEnabled: false

DataConnector Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DataConnector resource accepts the following input properties:

CollectionDisplayName string: The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
CollectionId string: The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
DataSource string: The name of the data source. Supported values: salesforce, jira, confluence, bigquery.
Location string: The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
RefreshInterval string: The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
Entities List<DataConnectorEntity>: List of entities from the connected data source to ingest. Structure is documented below.
JsonParams string: Params needed to access the source in the format of json string.
KmsKeyName string: The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
Params Dictionary<string, string>: Params needed to access the source in the format of String-to-String (Key, Value) pairs.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
StaticIpEnabled bool: Whether customer has enabled static IP addresses for this connector.

CollectionDisplayName string: The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
CollectionId string: The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
DataSource string: The name of the data source. Supported values: salesforce, jira, confluence, bigquery.
Location string: The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
RefreshInterval string: The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
Entities []DataConnectorEntityArgs: List of entities from the connected data source to ingest. Structure is documented below.
JsonParams string: Params needed to access the source in the format of json string.
KmsKeyName string: The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
Params map[string]string: Params needed to access the source in the format of String-to-String (Key, Value) pairs.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
StaticIpEnabled bool: Whether customer has enabled static IP addresses for this connector.

collectionDisplayName String: The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
collectionId String: The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
dataSource String: The name of the data source. Supported values: salesforce, jira, confluence, bigquery.
location String: The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
refreshInterval String: The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
entities List<DataConnectorEntity>: List of entities from the connected data source to ingest. Structure is documented below.
jsonParams String: Params needed to access the source in the format of json string.
kmsKeyName String: The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
params Map<String,String>: Params needed to access the source in the format of String-to-String (Key, Value) pairs.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
staticIpEnabled Boolean: Whether customer has enabled static IP addresses for this connector.

collectionDisplayName string: The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
collectionId string: The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
dataSource string: The name of the data source. Supported values: salesforce, jira, confluence, bigquery.
location string: The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
refreshInterval string: The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
entities DataConnectorEntity[]: List of entities from the connected data source to ingest. Structure is documented below.
jsonParams string: Params needed to access the source in the format of json string.
kmsKeyName string: The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
params {[key: string]: string}: Params needed to access the source in the format of String-to-String (Key, Value) pairs.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
staticIpEnabled boolean: Whether customer has enabled static IP addresses for this connector.

collection_display_name str: The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
collection_id str: The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
data_source str: The name of the data source. Supported values: salesforce, jira, confluence, bigquery.
location str: The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
refresh_interval str: The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
entities Sequence[DataConnectorEntityArgs]: List of entities from the connected data source to ingest. Structure is documented below.
json_params str: Params needed to access the source in the format of json string.
kms_key_name str: The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
params Mapping[str, str]: Params needed to access the source in the format of String-to-String (Key, Value) pairs.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
static_ip_enabled bool: Whether customer has enabled static IP addresses for this connector.

collectionDisplayName String: The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
collectionId String: The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
dataSource String: The name of the data source. Supported values: salesforce, jira, confluence, bigquery.
location String: The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
refreshInterval String: The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
entities List<Property Map>: List of entities from the connected data source to ingest. Structure is documented below.
jsonParams String: Params needed to access the source in the format of json string.
kmsKeyName String: The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
params Map<String>: Params needed to access the source in the format of String-to-String (Key, Value) pairs.
project String: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
staticIpEnabled Boolean: Whether customer has enabled static IP addresses for this connector.

Outputs

All input properties are implicitly available as output properties. Additionally, the DataConnector resource produces the following output properties:

ActionState string

State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors. The possible value can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

BlockingReasons List<string>

User actions that must be completed before the connector can start syncing data. The possible values can be: 'ALLOWLIST_STATIC_IP', 'ALLOWLIST_IN_SERVICE_ATTACHMENT'.

ConnectorType string

The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. The possible value can be: 'CONNECTOR_TYPE_UNSPECIFIED', 'THIRD_PARTY', 'GCP_FHIR', 'BIG_QUERY', 'GCS', 'GOOGLE_MAIL', 'GOOGLE_CALENDAR', 'GOOGLE_DRIVE', 'NATIVE_CLOUD_IDENTITY', 'THIRD_PARTY_FEDERATED', 'THIRD_PARTY_EUA', 'GCNV'.

CreateTime string

Timestamp when the DataConnector was created.

Errors List<DataConnectorError>

The errors from initialization or from the latest connector run. Structure is documented below.

Id string

The provider-assigned unique ID for this managed resource.

LastSyncTime string

For periodic connectors only, the last time a data sync was completed.

LatestPauseTime string

The most recent timestamp when this [DataConnector][] was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

All functionalities, including data synchronization, are halted.
Any ongoing data synchronization job will be canceled.
No future data synchronization runs will be scheduled nor can be triggered.

Name string

The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

PrivateConnectivityProjectId string

The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

RealtimeState string

The real-time sync state. The possible values can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

State string

The state of connector. The possible value can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

StaticIpAddresses List<string>

The static IP addresses used by this connector.

UpdateTime string

Timestamp when the DataConnector was updated.

ActionState string

BlockingReasons []string

User actions that must be completed before the connector can start syncing data. The possible values can be: 'ALLOWLIST_STATIC_IP', 'ALLOWLIST_IN_SERVICE_ATTACHMENT'.

ConnectorType string

CreateTime string

Timestamp when the DataConnector was created.

Errors []DataConnectorError

The errors from initialization or from the latest connector run. Structure is documented below.

Id string

The provider-assigned unique ID for this managed resource.

LastSyncTime string

For periodic connectors only, the last time a data sync was completed.

LatestPauseTime string

The most recent timestamp when this [DataConnector][] was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

All functionalities, including data synchronization, are halted.
Any ongoing data synchronization job will be canceled.
No future data synchronization runs will be scheduled nor can be triggered.

Name string

The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

PrivateConnectivityProjectId string

The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

RealtimeState string

The real-time sync state. The possible values can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

State string

The state of connector. The possible value can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

StaticIpAddresses []string

The static IP addresses used by this connector.

UpdateTime string

Timestamp when the DataConnector was updated.

actionState String

blockingReasons List<String>

User actions that must be completed before the connector can start syncing data. The possible values can be: 'ALLOWLIST_STATIC_IP', 'ALLOWLIST_IN_SERVICE_ATTACHMENT'.

connectorType String

createTime String

Timestamp when the DataConnector was created.

errors List<DataConnectorError>

The errors from initialization or from the latest connector run. Structure is documented below.

id String

The provider-assigned unique ID for this managed resource.

lastSyncTime String

For periodic connectors only, the last time a data sync was completed.

latestPauseTime String

The most recent timestamp when this [DataConnector][] was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

All functionalities, including data synchronization, are halted.
Any ongoing data synchronization job will be canceled.
No future data synchronization runs will be scheduled nor can be triggered.

name String

The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

privateConnectivityProjectId String

The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

realtimeState String

The real-time sync state. The possible values can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

state String

The state of connector. The possible value can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

staticIpAddresses List<String>

The static IP addresses used by this connector.

updateTime String

Timestamp when the DataConnector was updated.

actionState string

blockingReasons string[]

User actions that must be completed before the connector can start syncing data. The possible values can be: 'ALLOWLIST_STATIC_IP', 'ALLOWLIST_IN_SERVICE_ATTACHMENT'.

connectorType string

createTime string

Timestamp when the DataConnector was created.

errors DataConnectorError[]

The errors from initialization or from the latest connector run. Structure is documented below.

id string

The provider-assigned unique ID for this managed resource.

lastSyncTime string

For periodic connectors only, the last time a data sync was completed.

latestPauseTime string

The most recent timestamp when this [DataConnector][] was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

All functionalities, including data synchronization, are halted.
Any ongoing data synchronization job will be canceled.
No future data synchronization runs will be scheduled nor can be triggered.

name string

The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

privateConnectivityProjectId string

The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

realtimeState string

The real-time sync state. The possible values can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

state string

The state of connector. The possible value can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

staticIpAddresses string[]

The static IP addresses used by this connector.

updateTime string

Timestamp when the DataConnector was updated.

action_state str

blocking_reasons Sequence[str]

User actions that must be completed before the connector can start syncing data. The possible values can be: 'ALLOWLIST_STATIC_IP', 'ALLOWLIST_IN_SERVICE_ATTACHMENT'.

connector_type str

create_time str

Timestamp when the DataConnector was created.

errors Sequence[DataConnectorError]

The errors from initialization or from the latest connector run. Structure is documented below.

id str

The provider-assigned unique ID for this managed resource.

last_sync_time str

For periodic connectors only, the last time a data sync was completed.

latest_pause_time str

The most recent timestamp when this [DataConnector][] was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

All functionalities, including data synchronization, are halted.
Any ongoing data synchronization job will be canceled.
No future data synchronization runs will be scheduled nor can be triggered.

name str

The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

private_connectivity_project_id str

The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

realtime_state str

The real-time sync state. The possible values can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

state str

The state of connector. The possible value can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

static_ip_addresses Sequence[str]

The static IP addresses used by this connector.

update_time str

Timestamp when the DataConnector was updated.

actionState String

blockingReasons List<String>

User actions that must be completed before the connector can start syncing data. The possible values can be: 'ALLOWLIST_STATIC_IP', 'ALLOWLIST_IN_SERVICE_ATTACHMENT'.

connectorType String

createTime String

Timestamp when the DataConnector was created.

errors List<Property Map>

The errors from initialization or from the latest connector run. Structure is documented below.

id String

The provider-assigned unique ID for this managed resource.

lastSyncTime String

For periodic connectors only, the last time a data sync was completed.

latestPauseTime String

The most recent timestamp when this [DataConnector][] was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

All functionalities, including data synchronization, are halted.
Any ongoing data synchronization job will be canceled.
No future data synchronization runs will be scheduled nor can be triggered.

name String

The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

privateConnectivityProjectId String

The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

realtimeState String

The real-time sync state. The possible values can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

state String

The state of connector. The possible value can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

staticIpAddresses List<String>

The static IP addresses used by this connector.

updateTime String

Timestamp when the DataConnector was updated.

Look up Existing DataConnector Resource

Get an existing DataConnector resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DataConnectorState, opts?: CustomResourceOptions): DataConnector

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action_state: Optional[str] = None,
        blocking_reasons: Optional[Sequence[str]] = None,
        collection_display_name: Optional[str] = None,
        collection_id: Optional[str] = None,
        connector_type: Optional[str] = None,
        create_time: Optional[str] = None,
        data_source: Optional[str] = None,
        entities: Optional[Sequence[DataConnectorEntityArgs]] = None,
        errors: Optional[Sequence[DataConnectorErrorArgs]] = None,
        json_params: Optional[str] = None,
        kms_key_name: Optional[str] = None,
        last_sync_time: Optional[str] = None,
        latest_pause_time: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        params: Optional[Mapping[str, str]] = None,
        private_connectivity_project_id: Optional[str] = None,
        project: Optional[str] = None,
        realtime_state: Optional[str] = None,
        refresh_interval: Optional[str] = None,
        state: Optional[str] = None,
        static_ip_addresses: Optional[Sequence[str]] = None,
        static_ip_enabled: Optional[bool] = None,
        update_time: Optional[str] = None) -> DataConnector

func GetDataConnector(ctx *Context, name string, id IDInput, state *DataConnectorState, opts ...ResourceOption) (*DataConnector, error)

public static DataConnector Get(string name, Input<string> id, DataConnectorState? state, CustomResourceOptions? opts = null)

public static DataConnector get(String name, Output<String> id, DataConnectorState state, CustomResourceOptions options)

resources:  _:    type: gcp:discoveryengine:DataConnector    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ActionState string

BlockingReasons List<string>

User actions that must be completed before the connector can start syncing data. The possible values can be: 'ALLOWLIST_STATIC_IP', 'ALLOWLIST_IN_SERVICE_ATTACHMENT'.

CollectionDisplayName string

The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.

CollectionId string

The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

ConnectorType string

CreateTime string

Timestamp when the DataConnector was created.

DataSource string

The name of the data source. Supported values: salesforce, jira, confluence, bigquery.

Entities List<DataConnectorEntity>

List of entities from the connected data source to ingest. Structure is documented below.

Errors List<DataConnectorError>

The errors from initialization or from the latest connector run. Structure is documented below.

JsonParams string

Params needed to access the source in the format of json string.

KmsKeyName string

The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.

LastSyncTime string

For periodic connectors only, the last time a data sync was completed.

LatestPauseTime string

The most recent timestamp when this [DataConnector][] was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

All functionalities, including data synchronization, are halted.
Any ongoing data synchronization job will be canceled.
No future data synchronization runs will be scheduled nor can be triggered.

Location string

The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".

Name string

The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

Params Dictionary<string, string>

Params needed to access the source in the format of String-to-String (Key, Value) pairs.

PrivateConnectivityProjectId string

The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

RealtimeState string

The real-time sync state. The possible values can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

RefreshInterval string

The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.

State string

The state of connector. The possible value can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

StaticIpAddresses List<string>

The static IP addresses used by this connector.

StaticIpEnabled bool

Whether customer has enabled static IP addresses for this connector.

UpdateTime string

Timestamp when the DataConnector was updated.

ActionState string

BlockingReasons []string

User actions that must be completed before the connector can start syncing data. The possible values can be: 'ALLOWLIST_STATIC_IP', 'ALLOWLIST_IN_SERVICE_ATTACHMENT'.

CollectionDisplayName string

The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.

CollectionId string

ConnectorType string

CreateTime string

Timestamp when the DataConnector was created.

DataSource string

The name of the data source. Supported values: salesforce, jira, confluence, bigquery.

Entities []DataConnectorEntityArgs

List of entities from the connected data source to ingest. Structure is documented below.

Errors []DataConnectorErrorArgs

The errors from initialization or from the latest connector run. Structure is documented below.

JsonParams string

Params needed to access the source in the format of json string.

KmsKeyName string

LastSyncTime string

For periodic connectors only, the last time a data sync was completed.

LatestPauseTime string

The most recent timestamp when this [DataConnector][] was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

All functionalities, including data synchronization, are halted.
Any ongoing data synchronization job will be canceled.
No future data synchronization runs will be scheduled nor can be triggered.

Location string

The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".

Name string

The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

Params map[string]string

Params needed to access the source in the format of String-to-String (Key, Value) pairs.

PrivateConnectivityProjectId string

The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

RealtimeState string

The real-time sync state. The possible values can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

RefreshInterval string

State string

The state of connector. The possible value can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

StaticIpAddresses []string

The static IP addresses used by this connector.

StaticIpEnabled bool

Whether customer has enabled static IP addresses for this connector.

UpdateTime string

Timestamp when the DataConnector was updated.

actionState String

blockingReasons List<String>

User actions that must be completed before the connector can start syncing data. The possible values can be: 'ALLOWLIST_STATIC_IP', 'ALLOWLIST_IN_SERVICE_ATTACHMENT'.

collectionDisplayName String

The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.

collectionId String

connectorType String

createTime String

Timestamp when the DataConnector was created.

dataSource String

The name of the data source. Supported values: salesforce, jira, confluence, bigquery.

entities List<DataConnectorEntity>

List of entities from the connected data source to ingest. Structure is documented below.

errors List<DataConnectorError>

The errors from initialization or from the latest connector run. Structure is documented below.

jsonParams String

Params needed to access the source in the format of json string.

kmsKeyName String

lastSyncTime String

For periodic connectors only, the last time a data sync was completed.

latestPauseTime String

The most recent timestamp when this [DataConnector][] was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

All functionalities, including data synchronization, are halted.
Any ongoing data synchronization job will be canceled.
No future data synchronization runs will be scheduled nor can be triggered.

location String

The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".

name String

The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

params Map<String,String>

Params needed to access the source in the format of String-to-String (Key, Value) pairs.

privateConnectivityProjectId String

The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

realtimeState String

The real-time sync state. The possible values can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

refreshInterval String

state String

The state of connector. The possible value can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

staticIpAddresses List<String>

The static IP addresses used by this connector.

staticIpEnabled Boolean

Whether customer has enabled static IP addresses for this connector.

updateTime String

Timestamp when the DataConnector was updated.

actionState string

blockingReasons string[]

User actions that must be completed before the connector can start syncing data. The possible values can be: 'ALLOWLIST_STATIC_IP', 'ALLOWLIST_IN_SERVICE_ATTACHMENT'.

collectionDisplayName string

The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.

collectionId string

connectorType string

createTime string

Timestamp when the DataConnector was created.

dataSource string

The name of the data source. Supported values: salesforce, jira, confluence, bigquery.

entities DataConnectorEntity[]

List of entities from the connected data source to ingest. Structure is documented below.

errors DataConnectorError[]

The errors from initialization or from the latest connector run. Structure is documented below.

jsonParams string

Params needed to access the source in the format of json string.

kmsKeyName string

lastSyncTime string

For periodic connectors only, the last time a data sync was completed.

latestPauseTime string

The most recent timestamp when this [DataConnector][] was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

All functionalities, including data synchronization, are halted.
Any ongoing data synchronization job will be canceled.
No future data synchronization runs will be scheduled nor can be triggered.

location string

The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".

name string

The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

params {[key: string]: string}

Params needed to access the source in the format of String-to-String (Key, Value) pairs.

privateConnectivityProjectId string

The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

realtimeState string

The real-time sync state. The possible values can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

refreshInterval string

state string

The state of connector. The possible value can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

staticIpAddresses string[]

The static IP addresses used by this connector.

staticIpEnabled boolean

Whether customer has enabled static IP addresses for this connector.

updateTime string

Timestamp when the DataConnector was updated.

action_state str

blocking_reasons Sequence[str]

User actions that must be completed before the connector can start syncing data. The possible values can be: 'ALLOWLIST_STATIC_IP', 'ALLOWLIST_IN_SERVICE_ATTACHMENT'.

collection_display_name str

The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.

collection_id str

connector_type str

create_time str

Timestamp when the DataConnector was created.

data_source str

The name of the data source. Supported values: salesforce, jira, confluence, bigquery.

entities Sequence[DataConnectorEntityArgs]

List of entities from the connected data source to ingest. Structure is documented below.

errors Sequence[DataConnectorErrorArgs]

The errors from initialization or from the latest connector run. Structure is documented below.

json_params str

Params needed to access the source in the format of json string.

kms_key_name str

last_sync_time str

For periodic connectors only, the last time a data sync was completed.

latest_pause_time str

The most recent timestamp when this [DataConnector][] was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

All functionalities, including data synchronization, are halted.
Any ongoing data synchronization job will be canceled.
No future data synchronization runs will be scheduled nor can be triggered.

location str

The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".

name str

The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

params Mapping[str, str]

Params needed to access the source in the format of String-to-String (Key, Value) pairs.

private_connectivity_project_id str

The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

realtime_state str

The real-time sync state. The possible values can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

refresh_interval str

state str

The state of connector. The possible value can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

static_ip_addresses Sequence[str]

The static IP addresses used by this connector.

static_ip_enabled bool

Whether customer has enabled static IP addresses for this connector.

update_time str

Timestamp when the DataConnector was updated.

actionState String

blockingReasons List<String>

User actions that must be completed before the connector can start syncing data. The possible values can be: 'ALLOWLIST_STATIC_IP', 'ALLOWLIST_IN_SERVICE_ATTACHMENT'.

collectionDisplayName String

The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.

collectionId String

connectorType String

createTime String

Timestamp when the DataConnector was created.

dataSource String

The name of the data source. Supported values: salesforce, jira, confluence, bigquery.

entities List<Property Map>

List of entities from the connected data source to ingest. Structure is documented below.

errors List<Property Map>

The errors from initialization or from the latest connector run. Structure is documented below.

jsonParams String

Params needed to access the source in the format of json string.

kmsKeyName String

lastSyncTime String

For periodic connectors only, the last time a data sync was completed.

latestPauseTime String

The most recent timestamp when this [DataConnector][] was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects:

All functionalities, including data synchronization, are halted.
Any ongoing data synchronization job will be canceled.
No future data synchronization runs will be scheduled nor can be triggered.

location String

The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".

name String

The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

params Map<String>

Params needed to access the source in the format of String-to-String (Key, Value) pairs.

privateConnectivityProjectId String

The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

realtimeState String

The real-time sync state. The possible values can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

refreshInterval String

state String

The state of connector. The possible value can be: 'STATE_UNSPECIFIED', 'CREATING', 'ACTIVE', 'FAILED', 'RUNNING', 'WARNING', 'INITIALIZATION_FAILED', 'UPDATING'.

staticIpAddresses List<String>

The static IP addresses used by this connector.

staticIpEnabled Boolean

Whether customer has enabled static IP addresses for this connector.

updateTime String

Timestamp when the DataConnector was updated.

Supporting Types

DataConnectorEntity, DataConnectorEntityArgs

DataStore string

(Output) The full resource name of the associated data store for the source entity. Format: projects/*/locations/*/collections/*/dataStores/*. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.

EntityName string

The name of the entity. Supported values by data source:

Salesforce: Lead, Opportunity, Contact, Account, Case, Contract, Campaign
Jira: project, issue, attachment, comment, worklog
Confluence: Content, Space

KeyPropertyMappings Dictionary<string, string>

Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as title, and description. Supported key properties:

Params Dictionary<string, string>

The parameters for the entity to facilitate data ingestion.

DataStore string

EntityName string

The name of the entity. Supported values by data source:

Salesforce: Lead, Opportunity, Contact, Account, Case, Contract, Campaign
Jira: project, issue, attachment, comment, worklog
Confluence: Content, Space

KeyPropertyMappings map[string]string

Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as title, and description. Supported key properties:

Params map[string]string

The parameters for the entity to facilitate data ingestion.

dataStore String

entityName String

The name of the entity. Supported values by data source:

Salesforce: Lead, Opportunity, Contact, Account, Case, Contract, Campaign
Jira: project, issue, attachment, comment, worklog
Confluence: Content, Space

keyPropertyMappings Map<String,String>

Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as title, and description. Supported key properties:

params Map<String,String>

The parameters for the entity to facilitate data ingestion.

dataStore string

entityName string

The name of the entity. Supported values by data source:

Salesforce: Lead, Opportunity, Contact, Account, Case, Contract, Campaign
Jira: project, issue, attachment, comment, worklog
Confluence: Content, Space

keyPropertyMappings {[key: string]: string}

Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as title, and description. Supported key properties:

params {[key: string]: string}

The parameters for the entity to facilitate data ingestion.

data_store str

entity_name str

The name of the entity. Supported values by data source:

Salesforce: Lead, Opportunity, Contact, Account, Case, Contract, Campaign
Jira: project, issue, attachment, comment, worklog
Confluence: Content, Space

key_property_mappings Mapping[str, str]

Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as title, and description. Supported key properties:

params Mapping[str, str]

The parameters for the entity to facilitate data ingestion.

dataStore String

entityName String

The name of the entity. Supported values by data source:

Salesforce: Lead, Opportunity, Contact, Account, Case, Contract, Campaign
Jira: project, issue, attachment, comment, worklog
Confluence: Content, Space

keyPropertyMappings Map<String>

Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as title, and description. Supported key properties:

params Map<String>

The parameters for the entity to facilitate data ingestion.

DataConnectorError, DataConnectorErrorArgs

Code int: (Output) The status code, which should be an enum value of google.rpc.Code.
Message string: (Output) A developer-facing error message, which should be in English.

Code int: (Output) The status code, which should be an enum value of google.rpc.Code.
Message string: (Output) A developer-facing error message, which should be in English.

code Integer: (Output) The status code, which should be an enum value of google.rpc.Code.
message String: (Output) A developer-facing error message, which should be in English.

code number: (Output) The status code, which should be an enum value of google.rpc.Code.
message string: (Output) A developer-facing error message, which should be in English.

code int: (Output) The status code, which should be an enum value of google.rpc.Code.
message str: (Output) A developer-facing error message, which should be in English.

code Number: (Output) The status code, which should be an enum value of google.rpc.Code.
message String: (Output) A developer-facing error message, which should be in English.

Import

DataConnector can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/dataConnector
{{project}}/{{location}}/{{collection_id}}
{{location}}/{{collection_id}}

When using the pulumi import command, DataConnector can be imported using one of the formats above. For example:

$ pulumi import gcp:discoveryengine/dataConnector:DataConnector default projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/dataConnector

$ pulumi import gcp:discoveryengine/dataConnector:DataConnector default {{project}}/{{location}}/{{collection_id}}

$ pulumi import gcp:discoveryengine/dataConnector:DataConnector default {{location}}/{{collection_id}}

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud v9.3.0 published on Tuesday, Oct 7, 2025 by Pulumi

pulumi/pulumi-gcp

gcp.discoveryengine.DataConnector

On this page

On this page

Example Usage

Discoveryengine Dataconnector Jira Basic

Create DataConnector Resource

Constructor syntax

Parameters

Constructor example

DataConnector Resource Properties

Inputs

Outputs

Look up Existing DataConnector Resource

Supporting Types

DataConnectorEntity, DataConnectorEntityArgs

DataConnectorError, DataConnectorErrorArgs

Import

Package Details

On this page

On this page