1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. discoveryengine
  5. DataConnector
Viewing docs for Google Cloud v9.15.0
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.discoveryengine.DataConnector

gcp logo
Viewing docs for Google Cloud v9.15.0
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    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:

    Example Usage

    Discoveryengine Dataconnector Servicenow Basic

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

const servicenow_basic = new gcp.discoveryengine.DataConnector("servicenow-basic", {
    location: "global",
    collectionId: "collection-id",
    collectionDisplayName: "tf-test-dataconnector-servicenow",
    dataSource: "servicenow",
    params: {
        auth_type: "OAUTH_PASSWORD_GRANT",
        instance_uri: "https://gcpconnector1.service-now.com/",
        client_id: "SECRET_MANAGER_RESOURCE_NAME",
        client_secret: "SECRET_MANAGER_RESOURCE_NAME",
        static_ip_enabled: "false",
        user_account: "connectorsuserqa@google.com",
        password: "SECRET_MANAGER_RESOURCE_NAME",
    },
    refreshInterval: "86400s",
    incrementalRefreshInterval: "21600s",
    entities: [
        {
            entityName: "catalog",
            params: JSON.stringify({
                inclusion_filters: {
                    knowledgeBaseSysId: ["123"],
                },
            }),
        },
        {
            entityName: "incident",
            params: JSON.stringify({
                inclusion_filters: {
                    knowledgeBaseSysId: ["123"],
                },
            }),
        },
        {
            entityName: "knowledge_base",
            params: JSON.stringify({
                inclusion_filters: {
                    knowledgeBaseSysId: ["123"],
                },
            }),
        },
    ],
    staticIpEnabled: false,
    connectorModes: ["DATA_INGESTION"],
    syncMode: "PERIODIC",
});

    import pulumi
import json
import pulumi_gcp as gcp

servicenow_basic = gcp.discoveryengine.DataConnector("servicenow-basic",
    location="global",
    collection_id="collection-id",
    collection_display_name="tf-test-dataconnector-servicenow",
    data_source="servicenow",
    params={
        "auth_type": "OAUTH_PASSWORD_GRANT",
        "instance_uri": "https://gcpconnector1.service-now.com/",
        "client_id": "SECRET_MANAGER_RESOURCE_NAME",
        "client_secret": "SECRET_MANAGER_RESOURCE_NAME",
        "static_ip_enabled": "false",
        "user_account": "connectorsuserqa@google.com",
        "password": "SECRET_MANAGER_RESOURCE_NAME",
    },
    refresh_interval="86400s",
    incremental_refresh_interval="21600s",
    entities=[
        {
            "entity_name": "catalog",
            "params": json.dumps({
                "inclusion_filters": {
                    "knowledgeBaseSysId": ["123"],
                },
            }),
        },
        {
            "entity_name": "incident",
            "params": json.dumps({
                "inclusion_filters": {
                    "knowledgeBaseSysId": ["123"],
                },
            }),
        },
        {
            "entity_name": "knowledge_base",
            "params": json.dumps({
                "inclusion_filters": {
                    "knowledgeBaseSysId": ["123"],
                },
            }),
        },
    ],
    static_ip_enabled=False,
    connector_modes=["DATA_INGESTION"],
    sync_mode="PERIODIC")

    package main

import (
	"encoding/json"

	"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 {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"inclusion_filters": map[string]interface{}{
				"knowledgeBaseSysId": []string{
					"123",
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		tmpJSON1, err := json.Marshal(map[string]interface{}{
			"inclusion_filters": map[string]interface{}{
				"knowledgeBaseSysId": []string{
					"123",
				},
			},
		})
		if err != nil {
			return err
		}
		json1 := string(tmpJSON1)
		tmpJSON2, err := json.Marshal(map[string]interface{}{
			"inclusion_filters": map[string]interface{}{
				"knowledgeBaseSysId": []string{
					"123",
				},
			},
		})
		if err != nil {
			return err
		}
		json2 := string(tmpJSON2)
		_, err = discoveryengine.NewDataConnector(ctx, "servicenow-basic", &discoveryengine.DataConnectorArgs{
			Location:              pulumi.String("global"),
			CollectionId:          pulumi.String("collection-id"),
			CollectionDisplayName: pulumi.String("tf-test-dataconnector-servicenow"),
			DataSource:            pulumi.String("servicenow"),
			Params: pulumi.StringMap{
				"auth_type":         pulumi.String("OAUTH_PASSWORD_GRANT"),
				"instance_uri":      pulumi.String("https://gcpconnector1.service-now.com/"),
				"client_id":         pulumi.String("SECRET_MANAGER_RESOURCE_NAME"),
				"client_secret":     pulumi.String("SECRET_MANAGER_RESOURCE_NAME"),
				"static_ip_enabled": pulumi.String("false"),
				"user_account":      pulumi.String("connectorsuserqa@google.com"),
				"password":          pulumi.String("SECRET_MANAGER_RESOURCE_NAME"),
			},
			RefreshInterval:            pulumi.String("86400s"),
			IncrementalRefreshInterval: pulumi.String("21600s"),
			Entities: discoveryengine.DataConnectorEntityArray{
				&discoveryengine.DataConnectorEntityArgs{
					EntityName: pulumi.String("catalog"),
					Params:     pulumi.String(json0),
				},
				&discoveryengine.DataConnectorEntityArgs{
					EntityName: pulumi.String("incident"),
					Params:     pulumi.String(json1),
				},
				&discoveryengine.DataConnectorEntityArgs{
					EntityName: pulumi.String("knowledge_base"),
					Params:     pulumi.String(json2),
				},
			},
			StaticIpEnabled: pulumi.Bool(false),
			ConnectorModes: pulumi.StringArray{
				pulumi.String("DATA_INGESTION"),
			},
			SyncMode: pulumi.String("PERIODIC"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var servicenow_basic = new Gcp.DiscoveryEngine.DataConnector("servicenow-basic", new()
    {
        Location = "global",
        CollectionId = "collection-id",
        CollectionDisplayName = "tf-test-dataconnector-servicenow",
        DataSource = "servicenow",
        Params = 
        {
            { "auth_type", "OAUTH_PASSWORD_GRANT" },
            { "instance_uri", "https://gcpconnector1.service-now.com/" },
            { "client_id", "SECRET_MANAGER_RESOURCE_NAME" },
            { "client_secret", "SECRET_MANAGER_RESOURCE_NAME" },
            { "static_ip_enabled", "false" },
            { "user_account", "connectorsuserqa@google.com" },
            { "password", "SECRET_MANAGER_RESOURCE_NAME" },
        },
        RefreshInterval = "86400s",
        IncrementalRefreshInterval = "21600s",
        Entities = new[]
        {
            new Gcp.DiscoveryEngine.Inputs.DataConnectorEntityArgs
            {
                EntityName = "catalog",
                Params = JsonSerializer.Serialize(new Dictionary<string, object?>
                {
                    ["inclusion_filters"] = new Dictionary<string, object?>
                    {
                        ["knowledgeBaseSysId"] = new[]
                        {
                            "123",
                        },
                    },
                }),
            },
            new Gcp.DiscoveryEngine.Inputs.DataConnectorEntityArgs
            {
                EntityName = "incident",
                Params = JsonSerializer.Serialize(new Dictionary<string, object?>
                {
                    ["inclusion_filters"] = new Dictionary<string, object?>
                    {
                        ["knowledgeBaseSysId"] = new[]
                        {
                            "123",
                        },
                    },
                }),
            },
            new Gcp.DiscoveryEngine.Inputs.DataConnectorEntityArgs
            {
                EntityName = "knowledge_base",
                Params = JsonSerializer.Serialize(new Dictionary<string, object?>
                {
                    ["inclusion_filters"] = new Dictionary<string, object?>
                    {
                        ["knowledgeBaseSysId"] = new[]
                        {
                            "123",
                        },
                    },
                }),
            },
        },
        StaticIpEnabled = false,
        ConnectorModes = new[]
        {
            "DATA_INGESTION",
        },
        SyncMode = "PERIODIC",
    });

});

    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 static com.pulumi.codegen.internal.Serialization.*;
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 servicenow_basic = new DataConnector("servicenow-basic", DataConnectorArgs.builder()
            .location("global")
            .collectionId("collection-id")
            .collectionDisplayName("tf-test-dataconnector-servicenow")
            .dataSource("servicenow")
            .params(Map.ofEntries(
                Map.entry("auth_type", "OAUTH_PASSWORD_GRANT"),
                Map.entry("instance_uri", "https://gcpconnector1.service-now.com/"),
                Map.entry("client_id", "SECRET_MANAGER_RESOURCE_NAME"),
                Map.entry("client_secret", "SECRET_MANAGER_RESOURCE_NAME"),
                Map.entry("static_ip_enabled", "false"),
                Map.entry("user_account", "connectorsuserqa@google.com"),
                Map.entry("password", "SECRET_MANAGER_RESOURCE_NAME")
            ))
            .refreshInterval("86400s")
            .incrementalRefreshInterval("21600s")
            .entities(            
                DataConnectorEntityArgs.builder()
                    .entityName("catalog")
                    .params(serializeJson(
                        jsonObject(
                            jsonProperty("inclusion_filters", jsonObject(
                                jsonProperty("knowledgeBaseSysId", jsonArray("123"))
                            ))
                        )))
                    .build(),
                DataConnectorEntityArgs.builder()
                    .entityName("incident")
                    .params(serializeJson(
                        jsonObject(
                            jsonProperty("inclusion_filters", jsonObject(
                                jsonProperty("knowledgeBaseSysId", jsonArray("123"))
                            ))
                        )))
                    .build(),
                DataConnectorEntityArgs.builder()
                    .entityName("knowledge_base")
                    .params(serializeJson(
                        jsonObject(
                            jsonProperty("inclusion_filters", jsonObject(
                                jsonProperty("knowledgeBaseSysId", jsonArray("123"))
                            ))
                        )))
                    .build())
            .staticIpEnabled(false)
            .connectorModes("DATA_INGESTION")
            .syncMode("PERIODIC")
            .build());

    }
}

    resources:
  servicenow-basic:
    type: gcp:discoveryengine:DataConnector
    properties:
      location: global
      collectionId: collection-id
      collectionDisplayName: tf-test-dataconnector-servicenow
      dataSource: servicenow
      params:
        auth_type: OAUTH_PASSWORD_GRANT
        instance_uri: https://gcpconnector1.service-now.com/
        client_id: SECRET_MANAGER_RESOURCE_NAME
        client_secret: SECRET_MANAGER_RESOURCE_NAME
        static_ip_enabled: 'false'
        user_account: connectorsuserqa@google.com
        password: SECRET_MANAGER_RESOURCE_NAME
      refreshInterval: 86400s
      incrementalRefreshInterval: 21600s
      entities:
        - entityName: catalog
          params:
            fn::toJSON:
              inclusion_filters:
                knowledgeBaseSysId:
                  - '123'
        - entityName: incident
          params:
            fn::toJSON:
              inclusion_filters:
                knowledgeBaseSysId:
                  - '123'
        - entityName: knowledge_base
          params:
            fn::toJSON:
              inclusion_filters:
                knowledgeBaseSysId:
                  - '123'
      staticIpEnabled: false
      connectorModes:
        - DATA_INGESTION
      syncMode: PERIODIC

    Discoveryengine Dataconnector Jira With Actions

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

const jira_with_actions = new gcp.discoveryengine.DataConnector("jira-with-actions", {
    location: "global",
    collectionId: "collection-id",
    collectionDisplayName: "Jira Federated",
    dataSource: "jira",
    dataSourceVersion: 3,
    params: {
        instance_uri: "https://example.atlassian.net",
        instance_id: "SECRET_MANAGER_RESOURCE_NAME",
        client_id: "SECRET_MANAGER_RESOURCE_NAME",
        client_secret: "SECRET_MANAGER_RESOURCE_NAME",
        refresh_token: "SECRET_MANAGER_RESOURCE_NAME",
        auth_type: "OAUTH",
    },
    refreshInterval: "86400s",
    entities: [
        {
            entityName: "project",
        },
        {
            entityName: "issue",
        },
        {
            entityName: "comment",
        },
        {
            entityName: "attachment",
        },
    ],
    staticIpEnabled: false,
    destinationConfigs: [{
        key: "url",
        destinations: [{
            host: "https://example.atlassian.net",
        }],
    }],
    connectorModes: [
        "FEDERATED",
        "ACTIONS",
    ],
    syncMode: "PERIODIC",
    autoRunDisabled: true,
    incrementalSyncDisabled: true,
    actionConfig: {
        actionParams: {
            instance_uri: "https://example.atlassian.net",
            instance_id: "SECRET_MANAGER_RESOURCE_NAME",
            client_id: "SECRET_MANAGER_RESOURCE_NAME",
            client_secret: "SECRET_MANAGER_RESOURCE_NAME",
            auth_type: "OAUTH",
        },
        createBapConnection: true,
    },
    bapConfig: {
        supportedConnectorModes: ["ACTIONS"],
        enabledActions: [
            "create_issue",
            "update_issue",
            "change_issue_status",
            "create_comment",
            "update_comment",
            "upload_attachment",
        ],
    },
});

    import pulumi
import pulumi_gcp as gcp

jira_with_actions = gcp.discoveryengine.DataConnector("jira-with-actions",
    location="global",
    collection_id="collection-id",
    collection_display_name="Jira Federated",
    data_source="jira",
    data_source_version=3,
    params={
        "instance_uri": "https://example.atlassian.net",
        "instance_id": "SECRET_MANAGER_RESOURCE_NAME",
        "client_id": "SECRET_MANAGER_RESOURCE_NAME",
        "client_secret": "SECRET_MANAGER_RESOURCE_NAME",
        "refresh_token": "SECRET_MANAGER_RESOURCE_NAME",
        "auth_type": "OAUTH",
    },
    refresh_interval="86400s",
    entities=[
        {
            "entity_name": "project",
        },
        {
            "entity_name": "issue",
        },
        {
            "entity_name": "comment",
        },
        {
            "entity_name": "attachment",
        },
    ],
    static_ip_enabled=False,
    destination_configs=[{
        "key": "url",
        "destinations": [{
            "host": "https://example.atlassian.net",
        }],
    }],
    connector_modes=[
        "FEDERATED",
        "ACTIONS",
    ],
    sync_mode="PERIODIC",
    auto_run_disabled=True,
    incremental_sync_disabled=True,
    action_config={
        "action_params": {
            "instance_uri": "https://example.atlassian.net",
            "instance_id": "SECRET_MANAGER_RESOURCE_NAME",
            "client_id": "SECRET_MANAGER_RESOURCE_NAME",
            "client_secret": "SECRET_MANAGER_RESOURCE_NAME",
            "auth_type": "OAUTH",
        },
        "create_bap_connection": True,
    },
    bap_config={
        "supported_connector_modes": ["ACTIONS"],
        "enabled_actions": [
            "create_issue",
            "update_issue",
            "change_issue_status",
            "create_comment",
            "update_comment",
            "upload_attachment",
        ],
    })

    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-with-actions", &discoveryengine.DataConnectorArgs{
			Location:              pulumi.String("global"),
			CollectionId:          pulumi.String("collection-id"),
			CollectionDisplayName: pulumi.String("Jira Federated"),
			DataSource:            pulumi.String("jira"),
			DataSourceVersion:     pulumi.Int(3),
			Params: pulumi.StringMap{
				"instance_uri":  pulumi.String("https://example.atlassian.net"),
				"instance_id":   pulumi.String("SECRET_MANAGER_RESOURCE_NAME"),
				"client_id":     pulumi.String("SECRET_MANAGER_RESOURCE_NAME"),
				"client_secret": pulumi.String("SECRET_MANAGER_RESOURCE_NAME"),
				"refresh_token": pulumi.String("SECRET_MANAGER_RESOURCE_NAME"),
				"auth_type":     pulumi.String("OAUTH"),
			},
			RefreshInterval: pulumi.String("86400s"),
			Entities: discoveryengine.DataConnectorEntityArray{
				&discoveryengine.DataConnectorEntityArgs{
					EntityName: pulumi.String("project"),
				},
				&discoveryengine.DataConnectorEntityArgs{
					EntityName: pulumi.String("issue"),
				},
				&discoveryengine.DataConnectorEntityArgs{
					EntityName: pulumi.String("comment"),
				},
				&discoveryengine.DataConnectorEntityArgs{
					EntityName: pulumi.String("attachment"),
				},
			},
			StaticIpEnabled: pulumi.Bool(false),
			DestinationConfigs: discoveryengine.DataConnectorDestinationConfigArray{
				&discoveryengine.DataConnectorDestinationConfigArgs{
					Key: pulumi.String("url"),
					Destinations: discoveryengine.DataConnectorDestinationConfigDestinationArray{
						&discoveryengine.DataConnectorDestinationConfigDestinationArgs{
							Host: pulumi.String("https://example.atlassian.net"),
						},
					},
				},
			},
			ConnectorModes: pulumi.StringArray{
				pulumi.String("FEDERATED"),
				pulumi.String("ACTIONS"),
			},
			SyncMode:                pulumi.String("PERIODIC"),
			AutoRunDisabled:         pulumi.Bool(true),
			IncrementalSyncDisabled: pulumi.Bool(true),
			ActionConfig: &discoveryengine.DataConnectorActionConfigArgs{
				ActionParams: pulumi.StringMap{
					"instance_uri":  pulumi.String("https://example.atlassian.net"),
					"instance_id":   pulumi.String("SECRET_MANAGER_RESOURCE_NAME"),
					"client_id":     pulumi.String("SECRET_MANAGER_RESOURCE_NAME"),
					"client_secret": pulumi.String("SECRET_MANAGER_RESOURCE_NAME"),
					"auth_type":     pulumi.String("OAUTH"),
				},
				CreateBapConnection: pulumi.Bool(true),
			},
			BapConfig: &discoveryengine.DataConnectorBapConfigArgs{
				SupportedConnectorModes: pulumi.StringArray{
					pulumi.String("ACTIONS"),
				},
				EnabledActions: pulumi.StringArray{
					pulumi.String("create_issue"),
					pulumi.String("update_issue"),
					pulumi.String("change_issue_status"),
					pulumi.String("create_comment"),
					pulumi.String("update_comment"),
					pulumi.String("upload_attachment"),
				},
			},
		})
		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_with_actions = new Gcp.DiscoveryEngine.DataConnector("jira-with-actions", new()
    {
        Location = "global",
        CollectionId = "collection-id",
        CollectionDisplayName = "Jira Federated",
        DataSource = "jira",
        DataSourceVersion = 3,
        Params = 
        {
            { "instance_uri", "https://example.atlassian.net" },
            { "instance_id", "SECRET_MANAGER_RESOURCE_NAME" },
            { "client_id", "SECRET_MANAGER_RESOURCE_NAME" },
            { "client_secret", "SECRET_MANAGER_RESOURCE_NAME" },
            { "refresh_token", "SECRET_MANAGER_RESOURCE_NAME" },
            { "auth_type", "OAUTH" },
        },
        RefreshInterval = "86400s",
        Entities = new[]
        {
            new Gcp.DiscoveryEngine.Inputs.DataConnectorEntityArgs
            {
                EntityName = "project",
            },
            new Gcp.DiscoveryEngine.Inputs.DataConnectorEntityArgs
            {
                EntityName = "issue",
            },
            new Gcp.DiscoveryEngine.Inputs.DataConnectorEntityArgs
            {
                EntityName = "comment",
            },
            new Gcp.DiscoveryEngine.Inputs.DataConnectorEntityArgs
            {
                EntityName = "attachment",
            },
        },
        StaticIpEnabled = false,
        DestinationConfigs = new[]
        {
            new Gcp.DiscoveryEngine.Inputs.DataConnectorDestinationConfigArgs
            {
                Key = "url",
                Destinations = new[]
                {
                    new Gcp.DiscoveryEngine.Inputs.DataConnectorDestinationConfigDestinationArgs
                    {
                        Host = "https://example.atlassian.net",
                    },
                },
            },
        },
        ConnectorModes = new[]
        {
            "FEDERATED",
            "ACTIONS",
        },
        SyncMode = "PERIODIC",
        AutoRunDisabled = true,
        IncrementalSyncDisabled = true,
        ActionConfig = new Gcp.DiscoveryEngine.Inputs.DataConnectorActionConfigArgs
        {
            ActionParams = 
            {
                { "instance_uri", "https://example.atlassian.net" },
                { "instance_id", "SECRET_MANAGER_RESOURCE_NAME" },
                { "client_id", "SECRET_MANAGER_RESOURCE_NAME" },
                { "client_secret", "SECRET_MANAGER_RESOURCE_NAME" },
                { "auth_type", "OAUTH" },
            },
            CreateBapConnection = true,
        },
        BapConfig = new Gcp.DiscoveryEngine.Inputs.DataConnectorBapConfigArgs
        {
            SupportedConnectorModes = new[]
            {
                "ACTIONS",
            },
            EnabledActions = new[]
            {
                "create_issue",
                "update_issue",
                "change_issue_status",
                "create_comment",
                "update_comment",
                "upload_attachment",
            },
        },
    });

});

    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 com.pulumi.gcp.discoveryengine.inputs.DataConnectorDestinationConfigArgs;
import com.pulumi.gcp.discoveryengine.inputs.DataConnectorActionConfigArgs;
import com.pulumi.gcp.discoveryengine.inputs.DataConnectorBapConfigArgs;
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_with_actions = new DataConnector("jira-with-actions", DataConnectorArgs.builder()
            .location("global")
            .collectionId("collection-id")
            .collectionDisplayName("Jira Federated")
            .dataSource("jira")
            .dataSourceVersion(3)
            .params(Map.ofEntries(
                Map.entry("instance_uri", "https://example.atlassian.net"),
                Map.entry("instance_id", "SECRET_MANAGER_RESOURCE_NAME"),
                Map.entry("client_id", "SECRET_MANAGER_RESOURCE_NAME"),
                Map.entry("client_secret", "SECRET_MANAGER_RESOURCE_NAME"),
                Map.entry("refresh_token", "SECRET_MANAGER_RESOURCE_NAME"),
                Map.entry("auth_type", "OAUTH")
            ))
            .refreshInterval("86400s")
            .entities(            
                DataConnectorEntityArgs.builder()
                    .entityName("project")
                    .build(),
                DataConnectorEntityArgs.builder()
                    .entityName("issue")
                    .build(),
                DataConnectorEntityArgs.builder()
                    .entityName("comment")
                    .build(),
                DataConnectorEntityArgs.builder()
                    .entityName("attachment")
                    .build())
            .staticIpEnabled(false)
            .destinationConfigs(DataConnectorDestinationConfigArgs.builder()
                .key("url")
                .destinations(DataConnectorDestinationConfigDestinationArgs.builder()
                    .host("https://example.atlassian.net")
                    .build())
                .build())
            .connectorModes(            
                "FEDERATED",
                "ACTIONS")
            .syncMode("PERIODIC")
            .autoRunDisabled(true)
            .incrementalSyncDisabled(true)
            .actionConfig(DataConnectorActionConfigArgs.builder()
                .actionParams(Map.ofEntries(
                    Map.entry("instance_uri", "https://example.atlassian.net"),
                    Map.entry("instance_id", "SECRET_MANAGER_RESOURCE_NAME"),
                    Map.entry("client_id", "SECRET_MANAGER_RESOURCE_NAME"),
                    Map.entry("client_secret", "SECRET_MANAGER_RESOURCE_NAME"),
                    Map.entry("auth_type", "OAUTH")
                ))
                .createBapConnection(true)
                .build())
            .bapConfig(DataConnectorBapConfigArgs.builder()
                .supportedConnectorModes("ACTIONS")
                .enabledActions(                
                    "create_issue",
                    "update_issue",
                    "change_issue_status",
                    "create_comment",
                    "update_comment",
                    "upload_attachment")
                .build())
            .build());

    }
}

    resources:
  jira-with-actions:
    type: gcp:discoveryengine:DataConnector
    properties:
      location: global
      collectionId: collection-id
      collectionDisplayName: Jira Federated
      dataSource: jira
      dataSourceVersion: 3
      params:
        instance_uri: https://example.atlassian.net
        instance_id: SECRET_MANAGER_RESOURCE_NAME
        client_id: SECRET_MANAGER_RESOURCE_NAME
        client_secret: SECRET_MANAGER_RESOURCE_NAME
        refresh_token: SECRET_MANAGER_RESOURCE_NAME
        auth_type: OAUTH
      refreshInterval: 86400s
      entities:
        - entityName: project
        - entityName: issue
        - entityName: comment
        - entityName: attachment
      staticIpEnabled: false
      destinationConfigs:
        - key: url
          destinations:
            - host: https://example.atlassian.net
      connectorModes:
        - FEDERATED
        - ACTIONS
      syncMode: PERIODIC
      autoRunDisabled: true
      incrementalSyncDisabled: true
      actionConfig:
        actionParams:
          instance_uri: https://example.atlassian.net
          instance_id: SECRET_MANAGER_RESOURCE_NAME
          client_id: SECRET_MANAGER_RESOURCE_NAME
          client_secret: SECRET_MANAGER_RESOURCE_NAME
          auth_type: OAUTH
        createBapConnection: true
      bapConfig:
        supportedConnectorModes:
          - ACTIONS
        enabledActions:
          - create_issue
          - update_issue
          - change_issue_status
          - create_comment
          - update_comment
          - upload_attachment

    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,
                  data_source: Optional[str] = None,
                  refresh_interval: Optional[str] = None,
                  location: Optional[str] = None,
                  collection_display_name: Optional[str] = None,
                  collection_id: Optional[str] = None,
                  incremental_refresh_interval: Optional[str] = None,
                  json_params: Optional[str] = None,
                  data_source_version: Optional[int] = None,
                  destination_configs: Optional[Sequence[DataConnectorDestinationConfigArgs]] = None,
                  entities: Optional[Sequence[DataConnectorEntityArgs]] = None,
                  action_config: Optional[DataConnectorActionConfigArgs] = None,
                  incremental_sync_disabled: Optional[bool] = None,
                  connector_modes: Optional[Sequence[str]] = None,
                  kms_key_name: Optional[str] = None,
                  bap_config: Optional[DataConnectorBapConfigArgs] = None,
                  params: Optional[Mapping[str, str]] = None,
                  project: Optional[str] = None,
                  auto_run_disabled: Optional[bool] = None,
                  static_ip_enabled: Optional[bool] = None,
                  sync_mode: Optional[str] = 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()
{
    DataSource = "string",
    RefreshInterval = "string",
    Location = "string",
    CollectionDisplayName = "string",
    CollectionId = "string",
    IncrementalRefreshInterval = "string",
    JsonParams = "string",
    DataSourceVersion = 0,
    DestinationConfigs = new[]
    {
        new Gcp.DiscoveryEngine.Inputs.DataConnectorDestinationConfigArgs
        {
            Destinations = new[]
            {
                new Gcp.DiscoveryEngine.Inputs.DataConnectorDestinationConfigDestinationArgs
                {
                    Host = "string",
                },
            },
            Key = "string",
        },
    },
    Entities = new[]
    {
        new Gcp.DiscoveryEngine.Inputs.DataConnectorEntityArgs
        {
            DataStore = "string",
            EntityName = "string",
            KeyPropertyMappings = 
            {
                { "string", "string" },
            },
            Params = "string",
        },
    },
    ActionConfig = new Gcp.DiscoveryEngine.Inputs.DataConnectorActionConfigArgs
    {
        ActionParams = 
        {
            { "string", "string" },
        },
        CreateBapConnection = false,
        IsActionConfigured = false,
    },
    IncrementalSyncDisabled = false,
    ConnectorModes = new[]
    {
        "string",
    },
    KmsKeyName = "string",
    BapConfig = new Gcp.DiscoveryEngine.Inputs.DataConnectorBapConfigArgs
    {
        EnabledActions = new[]
        {
            "string",
        },
        SupportedConnectorModes = new[]
        {
            "string",
        },
    },
    Params = 
    {
        { "string", "string" },
    },
    Project = "string",
    AutoRunDisabled = false,
    StaticIpEnabled = false,
    SyncMode = "string",
});

    example, err := discoveryengine.NewDataConnector(ctx, "dataConnectorResource", &discoveryengine.DataConnectorArgs{
	DataSource:                 pulumi.String("string"),
	RefreshInterval:            pulumi.String("string"),
	Location:                   pulumi.String("string"),
	CollectionDisplayName:      pulumi.String("string"),
	CollectionId:               pulumi.String("string"),
	IncrementalRefreshInterval: pulumi.String("string"),
	JsonParams:                 pulumi.String("string"),
	DataSourceVersion:          pulumi.Int(0),
	DestinationConfigs: discoveryengine.DataConnectorDestinationConfigArray{
		&discoveryengine.DataConnectorDestinationConfigArgs{
			Destinations: discoveryengine.DataConnectorDestinationConfigDestinationArray{
				&discoveryengine.DataConnectorDestinationConfigDestinationArgs{
					Host: pulumi.String("string"),
				},
			},
			Key: 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.String("string"),
		},
	},
	ActionConfig: &discoveryengine.DataConnectorActionConfigArgs{
		ActionParams: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		CreateBapConnection: pulumi.Bool(false),
		IsActionConfigured:  pulumi.Bool(false),
	},
	IncrementalSyncDisabled: pulumi.Bool(false),
	ConnectorModes: pulumi.StringArray{
		pulumi.String("string"),
	},
	KmsKeyName: pulumi.String("string"),
	BapConfig: &discoveryengine.DataConnectorBapConfigArgs{
		EnabledActions: pulumi.StringArray{
			pulumi.String("string"),
		},
		SupportedConnectorModes: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Params: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project:         pulumi.String("string"),
	AutoRunDisabled: pulumi.Bool(false),
	StaticIpEnabled: pulumi.Bool(false),
	SyncMode:        pulumi.String("string"),
})

    var dataConnectorResource = new DataConnector("dataConnectorResource", DataConnectorArgs.builder()
    .dataSource("string")
    .refreshInterval("string")
    .location("string")
    .collectionDisplayName("string")
    .collectionId("string")
    .incrementalRefreshInterval("string")
    .jsonParams("string")
    .dataSourceVersion(0)
    .destinationConfigs(DataConnectorDestinationConfigArgs.builder()
        .destinations(DataConnectorDestinationConfigDestinationArgs.builder()
            .host("string")
            .build())
        .key("string")
        .build())
    .entities(DataConnectorEntityArgs.builder()
        .dataStore("string")
        .entityName("string")
        .keyPropertyMappings(Map.of("string", "string"))
        .params("string")
        .build())
    .actionConfig(DataConnectorActionConfigArgs.builder()
        .actionParams(Map.of("string", "string"))
        .createBapConnection(false)
        .isActionConfigured(false)
        .build())
    .incrementalSyncDisabled(false)
    .connectorModes("string")
    .kmsKeyName("string")
    .bapConfig(DataConnectorBapConfigArgs.builder()
        .enabledActions("string")
        .supportedConnectorModes("string")
        .build())
    .params(Map.of("string", "string"))
    .project("string")
    .autoRunDisabled(false)
    .staticIpEnabled(false)
    .syncMode("string")
    .build());

    data_connector_resource = gcp.discoveryengine.DataConnector("dataConnectorResource",
    data_source="string",
    refresh_interval="string",
    location="string",
    collection_display_name="string",
    collection_id="string",
    incremental_refresh_interval="string",
    json_params="string",
    data_source_version=0,
    destination_configs=[{
        "destinations": [{
            "host": "string",
        }],
        "key": "string",
    }],
    entities=[{
        "data_store": "string",
        "entity_name": "string",
        "key_property_mappings": {
            "string": "string",
        },
        "params": "string",
    }],
    action_config={
        "action_params": {
            "string": "string",
        },
        "create_bap_connection": False,
        "is_action_configured": False,
    },
    incremental_sync_disabled=False,
    connector_modes=["string"],
    kms_key_name="string",
    bap_config={
        "enabled_actions": ["string"],
        "supported_connector_modes": ["string"],
    },
    params={
        "string": "string",
    },
    project="string",
    auto_run_disabled=False,
    static_ip_enabled=False,
    sync_mode="string")

    const dataConnectorResource = new gcp.discoveryengine.DataConnector("dataConnectorResource", {
    dataSource: "string",
    refreshInterval: "string",
    location: "string",
    collectionDisplayName: "string",
    collectionId: "string",
    incrementalRefreshInterval: "string",
    jsonParams: "string",
    dataSourceVersion: 0,
    destinationConfigs: [{
        destinations: [{
            host: "string",
        }],
        key: "string",
    }],
    entities: [{
        dataStore: "string",
        entityName: "string",
        keyPropertyMappings: {
            string: "string",
        },
        params: "string",
    }],
    actionConfig: {
        actionParams: {
            string: "string",
        },
        createBapConnection: false,
        isActionConfigured: false,
    },
    incrementalSyncDisabled: false,
    connectorModes: ["string"],
    kmsKeyName: "string",
    bapConfig: {
        enabledActions: ["string"],
        supportedConnectorModes: ["string"],
    },
    params: {
        string: "string",
    },
    project: "string",
    autoRunDisabled: false,
    staticIpEnabled: false,
    syncMode: "string",
});

    type: gcp:discoveryengine:DataConnector
properties:
    actionConfig:
        actionParams:
            string: string
        createBapConnection: false
        isActionConfigured: false
    autoRunDisabled: false
    bapConfig:
        enabledActions:
            - string
        supportedConnectorModes:
            - string
    collectionDisplayName: string
    collectionId: string
    connectorModes:
        - string
    dataSource: string
    dataSourceVersion: 0
    destinationConfigs:
        - destinations:
            - host: string
          key: string
    entities:
        - dataStore: string
          entityName: string
          keyPropertyMappings:
            string: string
          params: string
    incrementalRefreshInterval: string
    incrementalSyncDisabled: false
    jsonParams: string
    kmsKeyName: string
    location: string
    params:
        string: string
    project: string
    refreshInterval: string
    staticIpEnabled: false
    syncMode: string

    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.
    ActionConfig DataConnectorActionConfig
    Action configuration for the data connector. Configures action capabilities for connectors that support the ACTIONS connector mode. Structure is documented below.
    AutoRunDisabled bool
    Indicates whether full syncs are paused for this connector
    BapConfig DataConnectorBapConfig
    BAP (Business Application Platform) configuration for the data connector. Controls which actions are enabled for connectors using the ACTIONS connector mode. Structure is documented below.
    ConnectorModes List<string>
    The modes enabled for this connector. The possible value can be: 'DATA_INGESTION', 'ACTIONS', 'FEDERATED' 'EUA', 'FEDERATED_AND_EUA'.
    DataSourceVersion int
    The version of the data source. For example, 3 for Jira v3.
    DestinationConfigs List<DataConnectorDestinationConfig>
    Destination connector configurations for the data connector, used to configure where data is served. Structure is documented below.
    Entities List<DataConnectorEntity>
    List of entities from the connected data source to ingest. Structure is documented below.
    IncrementalRefreshInterval string
    The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
    IncrementalSyncDisabled bool
    Indicates whether incremental syncs are paused for this connector.
    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.
    SyncMode string
    The data synchronization mode supported by the data connector. The possible value can be: 'PERIODIC', 'STREAMING'.
    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.
    ActionConfig DataConnectorActionConfigArgs
    Action configuration for the data connector. Configures action capabilities for connectors that support the ACTIONS connector mode. Structure is documented below.
    AutoRunDisabled bool
    Indicates whether full syncs are paused for this connector
    BapConfig DataConnectorBapConfigArgs
    BAP (Business Application Platform) configuration for the data connector. Controls which actions are enabled for connectors using the ACTIONS connector mode. Structure is documented below.
    ConnectorModes []string
    The modes enabled for this connector. The possible value can be: 'DATA_INGESTION', 'ACTIONS', 'FEDERATED' 'EUA', 'FEDERATED_AND_EUA'.
    DataSourceVersion int
    The version of the data source. For example, 3 for Jira v3.
    DestinationConfigs []DataConnectorDestinationConfigArgs
    Destination connector configurations for the data connector, used to configure where data is served. Structure is documented below.
    Entities []DataConnectorEntityArgs
    List of entities from the connected data source to ingest. Structure is documented below.
    IncrementalRefreshInterval string
    The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
    IncrementalSyncDisabled bool
    Indicates whether incremental syncs are paused for this connector.
    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.
    SyncMode string
    The data synchronization mode supported by the data connector. The possible value can be: 'PERIODIC', 'STREAMING'.
    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.
    actionConfig DataConnectorActionConfig
    Action configuration for the data connector. Configures action capabilities for connectors that support the ACTIONS connector mode. Structure is documented below.
    autoRunDisabled Boolean
    Indicates whether full syncs are paused for this connector
    bapConfig DataConnectorBapConfig
    BAP (Business Application Platform) configuration for the data connector. Controls which actions are enabled for connectors using the ACTIONS connector mode. Structure is documented below.
    connectorModes List<String>
    The modes enabled for this connector. The possible value can be: 'DATA_INGESTION', 'ACTIONS', 'FEDERATED' 'EUA', 'FEDERATED_AND_EUA'.
    dataSourceVersion Integer
    The version of the data source. For example, 3 for Jira v3.
    destinationConfigs List<DataConnectorDestinationConfig>
    Destination connector configurations for the data connector, used to configure where data is served. Structure is documented below.
    entities List<DataConnectorEntity>
    List of entities from the connected data source to ingest. Structure is documented below.
    incrementalRefreshInterval String
    The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
    incrementalSyncDisabled Boolean
    Indicates whether incremental syncs are paused for this connector.
    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.
    syncMode String
    The data synchronization mode supported by the data connector. The possible value can be: 'PERIODIC', 'STREAMING'.
    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.
    actionConfig DataConnectorActionConfig
    Action configuration for the data connector. Configures action capabilities for connectors that support the ACTIONS connector mode. Structure is documented below.
    autoRunDisabled boolean
    Indicates whether full syncs are paused for this connector
    bapConfig DataConnectorBapConfig
    BAP (Business Application Platform) configuration for the data connector. Controls which actions are enabled for connectors using the ACTIONS connector mode. Structure is documented below.
    connectorModes string[]
    The modes enabled for this connector. The possible value can be: 'DATA_INGESTION', 'ACTIONS', 'FEDERATED' 'EUA', 'FEDERATED_AND_EUA'.
    dataSourceVersion number
    The version of the data source. For example, 3 for Jira v3.
    destinationConfigs DataConnectorDestinationConfig[]
    Destination connector configurations for the data connector, used to configure where data is served. Structure is documented below.
    entities DataConnectorEntity[]
    List of entities from the connected data source to ingest. Structure is documented below.
    incrementalRefreshInterval string
    The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
    incrementalSyncDisabled boolean
    Indicates whether incremental syncs are paused for this connector.
    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.
    syncMode string
    The data synchronization mode supported by the data connector. The possible value can be: 'PERIODIC', 'STREAMING'.
    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.
    action_config DataConnectorActionConfigArgs
    Action configuration for the data connector. Configures action capabilities for connectors that support the ACTIONS connector mode. Structure is documented below.
    auto_run_disabled bool
    Indicates whether full syncs are paused for this connector
    bap_config DataConnectorBapConfigArgs
    BAP (Business Application Platform) configuration for the data connector. Controls which actions are enabled for connectors using the ACTIONS connector mode. Structure is documented below.
    connector_modes Sequence[str]
    The modes enabled for this connector. The possible value can be: 'DATA_INGESTION', 'ACTIONS', 'FEDERATED' 'EUA', 'FEDERATED_AND_EUA'.
    data_source_version int
    The version of the data source. For example, 3 for Jira v3.
    destination_configs Sequence[DataConnectorDestinationConfigArgs]
    Destination connector configurations for the data connector, used to configure where data is served. Structure is documented below.
    entities Sequence[DataConnectorEntityArgs]
    List of entities from the connected data source to ingest. Structure is documented below.
    incremental_refresh_interval str
    The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
    incremental_sync_disabled bool
    Indicates whether incremental syncs are paused for this connector.
    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.
    sync_mode str
    The data synchronization mode supported by the data connector. The possible value can be: 'PERIODIC', 'STREAMING'.
    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.
    actionConfig Property Map
    Action configuration for the data connector. Configures action capabilities for connectors that support the ACTIONS connector mode. Structure is documented below.
    autoRunDisabled Boolean
    Indicates whether full syncs are paused for this connector
    bapConfig Property Map
    BAP (Business Application Platform) configuration for the data connector. Controls which actions are enabled for connectors using the ACTIONS connector mode. Structure is documented below.
    connectorModes List<String>
    The modes enabled for this connector. The possible value can be: 'DATA_INGESTION', 'ACTIONS', 'FEDERATED' 'EUA', 'FEDERATED_AND_EUA'.
    dataSourceVersion Number
    The version of the data source. For example, 3 for Jira v3.
    destinationConfigs List<Property Map>
    Destination connector configurations for the data connector, used to configure where data is served. Structure is documented below.
    entities List<Property Map>
    List of entities from the connected data source to ingest. Structure is documented below.
    incrementalRefreshInterval String
    The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
    incrementalSyncDisabled Boolean
    Indicates whether incremental syncs are paused for this connector.
    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.
    syncMode String
    The data synchronization mode supported by the data connector. The possible value can be: 'PERIODIC', 'STREAMING'.

    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
    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 []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 []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
    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
    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 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 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
    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'.
    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
    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'.
    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
    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<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_config: Optional[DataConnectorActionConfigArgs] = None,
        action_state: Optional[str] = None,
        auto_run_disabled: Optional[bool] = None,
        bap_config: Optional[DataConnectorBapConfigArgs] = None,
        blocking_reasons: Optional[Sequence[str]] = None,
        collection_display_name: Optional[str] = None,
        collection_id: Optional[str] = None,
        connector_modes: Optional[Sequence[str]] = None,
        connector_type: Optional[str] = None,
        create_time: Optional[str] = None,
        data_source: Optional[str] = None,
        data_source_version: Optional[int] = None,
        destination_configs: Optional[Sequence[DataConnectorDestinationConfigArgs]] = None,
        entities: Optional[Sequence[DataConnectorEntityArgs]] = None,
        errors: Optional[Sequence[DataConnectorErrorArgs]] = None,
        incremental_refresh_interval: Optional[str] = None,
        incremental_sync_disabled: Optional[bool] = 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,
        sync_mode: Optional[str] = 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:
    ActionConfig DataConnectorActionConfig
    Action configuration for the data connector. Configures action capabilities for connectors that support the ACTIONS connector mode. Structure is documented below.
    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'.
    AutoRunDisabled bool
    Indicates whether full syncs are paused for this connector
    BapConfig DataConnectorBapConfig
    BAP (Business Application Platform) configuration for the data connector. Controls which actions are enabled for connectors using the ACTIONS connector mode. Structure is documented below.
    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.
    ConnectorModes List<string>
    The modes enabled for this connector. The possible value can be: 'DATA_INGESTION', 'ACTIONS', 'FEDERATED' 'EUA', 'FEDERATED_AND_EUA'.
    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.
    DataSource string
    The name of the data source. Supported values: salesforce, jira, confluence, bigquery.
    DataSourceVersion int
    The version of the data source. For example, 3 for Jira v3.
    DestinationConfigs List<DataConnectorDestinationConfig>
    Destination connector configurations for the data connector, used to configure where data is served. Structure is documented below.
    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.
    IncrementalRefreshInterval string
    The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
    IncrementalSyncDisabled bool
    Indicates whether incremental syncs are paused for this connector.
    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.
    SyncMode string
    The data synchronization mode supported by the data connector. The possible value can be: 'PERIODIC', 'STREAMING'.
    UpdateTime string
    Timestamp when the DataConnector was updated.
    ActionConfig DataConnectorActionConfigArgs
    Action configuration for the data connector. Configures action capabilities for connectors that support the ACTIONS connector mode. Structure is documented below.
    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'.
    AutoRunDisabled bool
    Indicates whether full syncs are paused for this connector
    BapConfig DataConnectorBapConfigArgs
    BAP (Business Application Platform) configuration for the data connector. Controls which actions are enabled for connectors using the ACTIONS connector mode. Structure is documented below.
    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
    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.
    ConnectorModes []string
    The modes enabled for this connector. The possible value can be: 'DATA_INGESTION', 'ACTIONS', 'FEDERATED' 'EUA', 'FEDERATED_AND_EUA'.
    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.
    DataSource string
    The name of the data source. Supported values: salesforce, jira, confluence, bigquery.
    DataSourceVersion int
    The version of the data source. For example, 3 for Jira v3.
    DestinationConfigs []DataConnectorDestinationConfigArgs
    Destination connector configurations for the data connector, used to configure where data is served. Structure is documented below.
    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.
    IncrementalRefreshInterval string
    The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
    IncrementalSyncDisabled bool
    Indicates whether incremental syncs are paused for this connector.
    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 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
    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 []string
    The static IP addresses used by this connector.
    StaticIpEnabled bool
    Whether customer has enabled static IP addresses for this connector.
    SyncMode string
    The data synchronization mode supported by the data connector. The possible value can be: 'PERIODIC', 'STREAMING'.
    UpdateTime string
    Timestamp when the DataConnector was updated.
    actionConfig DataConnectorActionConfig
    Action configuration for the data connector. Configures action capabilities for connectors that support the ACTIONS connector mode. Structure is documented below.
    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'.
    autoRunDisabled Boolean
    Indicates whether full syncs are paused for this connector
    bapConfig DataConnectorBapConfig
    BAP (Business Application Platform) configuration for the data connector. Controls which actions are enabled for connectors using the ACTIONS connector mode. Structure is documented below.
    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.
    connectorModes List<String>
    The modes enabled for this connector. The possible value can be: 'DATA_INGESTION', 'ACTIONS', 'FEDERATED' 'EUA', 'FEDERATED_AND_EUA'.
    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.
    dataSource String
    The name of the data source. Supported values: salesforce, jira, confluence, bigquery.
    dataSourceVersion Integer
    The version of the data source. For example, 3 for Jira v3.
    destinationConfigs List<DataConnectorDestinationConfig>
    Destination connector configurations for the data connector, used to configure where data is served. Structure is documented below.
    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.
    incrementalRefreshInterval String
    The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
    incrementalSyncDisabled Boolean
    Indicates whether incremental syncs are paused for this connector.
    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 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
    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 Boolean
    Whether customer has enabled static IP addresses for this connector.
    syncMode String
    The data synchronization mode supported by the data connector. The possible value can be: 'PERIODIC', 'STREAMING'.
    updateTime String
    Timestamp when the DataConnector was updated.
    actionConfig DataConnectorActionConfig
    Action configuration for the data connector. Configures action capabilities for connectors that support the ACTIONS connector mode. Structure is documented below.
    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'.
    autoRunDisabled boolean
    Indicates whether full syncs are paused for this connector
    bapConfig DataConnectorBapConfig
    BAP (Business Application Platform) configuration for the data connector. Controls which actions are enabled for connectors using the ACTIONS connector mode. Structure is documented below.
    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
    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.
    connectorModes string[]
    The modes enabled for this connector. The possible value can be: 'DATA_INGESTION', 'ACTIONS', 'FEDERATED' 'EUA', 'FEDERATED_AND_EUA'.
    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.
    dataSource string
    The name of the data source. Supported values: salesforce, jira, confluence, bigquery.
    dataSourceVersion number
    The version of the data source. For example, 3 for Jira v3.
    destinationConfigs DataConnectorDestinationConfig[]
    Destination connector configurations for the data connector, used to configure where data is served. Structure is documented below.
    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.
    incrementalRefreshInterval string
    The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
    incrementalSyncDisabled boolean
    Indicates whether incremental syncs are paused for this connector.
    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 {[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
    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 string[]
    The static IP addresses used by this connector.
    staticIpEnabled boolean
    Whether customer has enabled static IP addresses for this connector.
    syncMode string
    The data synchronization mode supported by the data connector. The possible value can be: 'PERIODIC', 'STREAMING'.
    updateTime string
    Timestamp when the DataConnector was updated.
    action_config DataConnectorActionConfigArgs
    Action configuration for the data connector. Configures action capabilities for connectors that support the ACTIONS connector mode. Structure is documented below.
    action_state str
    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'.
    auto_run_disabled bool
    Indicates whether full syncs are paused for this connector
    bap_config DataConnectorBapConfigArgs
    BAP (Business Application Platform) configuration for the data connector. Controls which actions are enabled for connectors using the ACTIONS connector mode. Structure is documented below.
    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
    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.
    connector_modes Sequence[str]
    The modes enabled for this connector. The possible value can be: 'DATA_INGESTION', 'ACTIONS', 'FEDERATED' 'EUA', 'FEDERATED_AND_EUA'.
    connector_type str
    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'.
    create_time str
    Timestamp when the DataConnector was created.
    data_source str
    The name of the data source. Supported values: salesforce, jira, confluence, bigquery.
    data_source_version int
    The version of the data source. For example, 3 for Jira v3.
    destination_configs Sequence[DataConnectorDestinationConfigArgs]
    Destination connector configurations for the data connector, used to configure where data is served. Structure is documented below.
    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.
    incremental_refresh_interval str
    The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
    incremental_sync_disabled bool
    Indicates whether incremental syncs are paused for this connector.
    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.
    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
    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 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.
    sync_mode str
    The data synchronization mode supported by the data connector. The possible value can be: 'PERIODIC', 'STREAMING'.
    update_time str
    Timestamp when the DataConnector was updated.
    actionConfig Property Map
    Action configuration for the data connector. Configures action capabilities for connectors that support the ACTIONS connector mode. Structure is documented below.
    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'.
    autoRunDisabled Boolean
    Indicates whether full syncs are paused for this connector
    bapConfig Property Map
    BAP (Business Application Platform) configuration for the data connector. Controls which actions are enabled for connectors using the ACTIONS connector mode. Structure is documented below.
    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.
    connectorModes List<String>
    The modes enabled for this connector. The possible value can be: 'DATA_INGESTION', 'ACTIONS', 'FEDERATED' 'EUA', 'FEDERATED_AND_EUA'.
    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.
    dataSource String
    The name of the data source. Supported values: salesforce, jira, confluence, bigquery.
    dataSourceVersion Number
    The version of the data source. For example, 3 for Jira v3.
    destinationConfigs List<Property Map>
    Destination connector configurations for the data connector, used to configure where data is served. Structure is documented below.
    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.
    incrementalRefreshInterval String
    The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
    incrementalSyncDisabled Boolean
    Indicates whether incremental syncs are paused for this connector.
    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 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
    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 Boolean
    Whether customer has enabled static IP addresses for this connector.
    syncMode String
    The data synchronization mode supported by the data connector. The possible value can be: 'PERIODIC', 'STREAMING'.
    updateTime String
    Timestamp when the DataConnector was updated.

    Supporting Types

    DataConnectorActionConfig, DataConnectorActionConfigArgs

    ActionParams Dictionary<string, string>
    Params needed to configure the actions in the format of String-to-String (Key, Value) pairs. Contains connection credentials and configuration for the action connector.
    CreateBapConnection bool
    Whether to create a BAP (Business Application Platform) connection for this action connector.
    IsActionConfigured bool
    (Output) Whether the action connector is fully configured. Set by the system after the action configuration is validated.
    ActionParams map[string]string
    Params needed to configure the actions in the format of String-to-String (Key, Value) pairs. Contains connection credentials and configuration for the action connector.
    CreateBapConnection bool
    Whether to create a BAP (Business Application Platform) connection for this action connector.
    IsActionConfigured bool
    (Output) Whether the action connector is fully configured. Set by the system after the action configuration is validated.
    actionParams Map<String,String>
    Params needed to configure the actions in the format of String-to-String (Key, Value) pairs. Contains connection credentials and configuration for the action connector.
    createBapConnection Boolean
    Whether to create a BAP (Business Application Platform) connection for this action connector.
    isActionConfigured Boolean
    (Output) Whether the action connector is fully configured. Set by the system after the action configuration is validated.
    actionParams {[key: string]: string}
    Params needed to configure the actions in the format of String-to-String (Key, Value) pairs. Contains connection credentials and configuration for the action connector.
    createBapConnection boolean
    Whether to create a BAP (Business Application Platform) connection for this action connector.
    isActionConfigured boolean
    (Output) Whether the action connector is fully configured. Set by the system after the action configuration is validated.
    action_params Mapping[str, str]
    Params needed to configure the actions in the format of String-to-String (Key, Value) pairs. Contains connection credentials and configuration for the action connector.
    create_bap_connection bool
    Whether to create a BAP (Business Application Platform) connection for this action connector.
    is_action_configured bool
    (Output) Whether the action connector is fully configured. Set by the system after the action configuration is validated.
    actionParams Map<String>
    Params needed to configure the actions in the format of String-to-String (Key, Value) pairs. Contains connection credentials and configuration for the action connector.
    createBapConnection Boolean
    Whether to create a BAP (Business Application Platform) connection for this action connector.
    isActionConfigured Boolean
    (Output) Whether the action connector is fully configured. Set by the system after the action configuration is validated.

    DataConnectorBapConfig, DataConnectorBapConfigArgs

    EnabledActions List<string>
    The list of enabled actions for this connector. Supported values include: create_issue, update_issue, change_issue_status, create_comment, update_comment, upload_attachment.
    SupportedConnectorModes List<string>
    The connector modes supported by the BAP configuration. The possible values include: ACTIONS.
    EnabledActions []string
    The list of enabled actions for this connector. Supported values include: create_issue, update_issue, change_issue_status, create_comment, update_comment, upload_attachment.
    SupportedConnectorModes []string
    The connector modes supported by the BAP configuration. The possible values include: ACTIONS.
    enabledActions List<String>
    The list of enabled actions for this connector. Supported values include: create_issue, update_issue, change_issue_status, create_comment, update_comment, upload_attachment.
    supportedConnectorModes List<String>
    The connector modes supported by the BAP configuration. The possible values include: ACTIONS.
    enabledActions string[]
    The list of enabled actions for this connector. Supported values include: create_issue, update_issue, change_issue_status, create_comment, update_comment, upload_attachment.
    supportedConnectorModes string[]
    The connector modes supported by the BAP configuration. The possible values include: ACTIONS.
    enabled_actions Sequence[str]
    The list of enabled actions for this connector. Supported values include: create_issue, update_issue, change_issue_status, create_comment, update_comment, upload_attachment.
    supported_connector_modes Sequence[str]
    The connector modes supported by the BAP configuration. The possible values include: ACTIONS.
    enabledActions List<String>
    The list of enabled actions for this connector. Supported values include: create_issue, update_issue, change_issue_status, create_comment, update_comment, upload_attachment.
    supportedConnectorModes List<String>
    The connector modes supported by the BAP configuration. The possible values include: ACTIONS.

    DataConnectorDestinationConfig, DataConnectorDestinationConfigArgs

    Destinations List<DataConnectorDestinationConfigDestination>
    The list of destinations for this configuration. Structure is documented below.
    Key string
    The key of the destination configuration, for example url.
    Destinations []DataConnectorDestinationConfigDestination
    The list of destinations for this configuration. Structure is documented below.
    Key string
    The key of the destination configuration, for example url.
    destinations List<DataConnectorDestinationConfigDestination>
    The list of destinations for this configuration. Structure is documented below.
    key String
    The key of the destination configuration, for example url.
    destinations DataConnectorDestinationConfigDestination[]
    The list of destinations for this configuration. Structure is documented below.
    key string
    The key of the destination configuration, for example url.
    destinations Sequence[DataConnectorDestinationConfigDestination]
    The list of destinations for this configuration. Structure is documented below.
    key str
    The key of the destination configuration, for example url.
    destinations List<Property Map>
    The list of destinations for this configuration. Structure is documented below.
    key String
    The key of the destination configuration, for example url.

    DataConnectorDestinationConfigDestination, DataConnectorDestinationConfigDestinationArgs

    Host string
    The host of the destination, for example https://example.atlassian.net.
    Host string
    The host of the destination, for example https://example.atlassian.net.
    host String
    The host of the destination, for example https://example.atlassian.net.
    host string
    The host of the destination, for example https://example.atlassian.net.
    host str
    The host of the destination, for example https://example.atlassian.net.
    host String
    The host of the destination, for example https://example.atlassian.net.

    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 string
    The parameters for the entity to facilitate data ingestion.
    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 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 string
    The parameters for the entity to facilitate data ingestion.
    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 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 String
    The parameters for the entity to facilitate data ingestion.
    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 {[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 string
    The parameters for the entity to facilitate data ingestion.
    data_store str
    (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.
    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 str
    The parameters for the entity to facilitate data ingestion.
    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 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 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.
    gcp logo
    Viewing docs for Google Cloud v9.15.0
    published on Thursday, Mar 12, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gcp
      Try Pulumi Cloud free. Your team will thank you.