Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. bigqueryanalyticshub
  5. DataExchange
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.bigqueryanalyticshub.DataExchange

Explore with Pulumi AI

Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

A Bigquery Analytics Hub data exchange

To get more information about DataExchange, see:

Example Usage

Bigquery Analyticshub Data Exchange Basic

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

const dataExchange = new gcp.bigqueryanalyticshub.DataExchange("data_exchange", {
    location: "US",
    dataExchangeId: "my_data_exchange",
    displayName: "my_data_exchange",
    description: "example data exchange",
});
Copy
import pulumi
import pulumi_gcp as gcp

data_exchange = gcp.bigqueryanalyticshub.DataExchange("data_exchange",
    location="US",
    data_exchange_id="my_data_exchange",
    display_name="my_data_exchange",
    description="example data exchange")
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigqueryanalyticshub"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigqueryanalyticshub.NewDataExchange(ctx, "data_exchange", &bigqueryanalyticshub.DataExchangeArgs{
			Location:       pulumi.String("US"),
			DataExchangeId: pulumi.String("my_data_exchange"),
			DisplayName:    pulumi.String("my_data_exchange"),
			Description:    pulumi.String("example data exchange"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var dataExchange = new Gcp.BigQueryAnalyticsHub.DataExchange("data_exchange", new()
    {
        Location = "US",
        DataExchangeId = "my_data_exchange",
        DisplayName = "my_data_exchange",
        Description = "example data exchange",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigqueryanalyticshub.DataExchange;
import com.pulumi.gcp.bigqueryanalyticshub.DataExchangeArgs;
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 dataExchange = new DataExchange("dataExchange", DataExchangeArgs.builder()
            .location("US")
            .dataExchangeId("my_data_exchange")
            .displayName("my_data_exchange")
            .description("example data exchange")
            .build());

    }
}
Copy
resources:
  dataExchange:
    type: gcp:bigqueryanalyticshub:DataExchange
    name: data_exchange
    properties:
      location: US
      dataExchangeId: my_data_exchange
      displayName: my_data_exchange
      description: example data exchange
Copy

Bigquery Analyticshub Data Exchange Dcr

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

const dataExchange = new gcp.bigqueryanalyticshub.DataExchange("data_exchange", {
    location: "US",
    dataExchangeId: "dcr_data_exchange",
    displayName: "dcr_data_exchange",
    description: "example dcr data exchange",
    sharingEnvironmentConfig: {
        dcrExchangeConfig: {},
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

data_exchange = gcp.bigqueryanalyticshub.DataExchange("data_exchange",
    location="US",
    data_exchange_id="dcr_data_exchange",
    display_name="dcr_data_exchange",
    description="example dcr data exchange",
    sharing_environment_config={
        "dcr_exchange_config": {},
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigqueryanalyticshub"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigqueryanalyticshub.NewDataExchange(ctx, "data_exchange", &bigqueryanalyticshub.DataExchangeArgs{
			Location:       pulumi.String("US"),
			DataExchangeId: pulumi.String("dcr_data_exchange"),
			DisplayName:    pulumi.String("dcr_data_exchange"),
			Description:    pulumi.String("example dcr data exchange"),
			SharingEnvironmentConfig: &bigqueryanalyticshub.DataExchangeSharingEnvironmentConfigArgs{
				DcrExchangeConfig: &bigqueryanalyticshub.DataExchangeSharingEnvironmentConfigDcrExchangeConfigArgs{},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var dataExchange = new Gcp.BigQueryAnalyticsHub.DataExchange("data_exchange", new()
    {
        Location = "US",
        DataExchangeId = "dcr_data_exchange",
        DisplayName = "dcr_data_exchange",
        Description = "example dcr data exchange",
        SharingEnvironmentConfig = new Gcp.BigQueryAnalyticsHub.Inputs.DataExchangeSharingEnvironmentConfigArgs
        {
            DcrExchangeConfig = null,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigqueryanalyticshub.DataExchange;
import com.pulumi.gcp.bigqueryanalyticshub.DataExchangeArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.DataExchangeSharingEnvironmentConfigArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.DataExchangeSharingEnvironmentConfigDcrExchangeConfigArgs;
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 dataExchange = new DataExchange("dataExchange", DataExchangeArgs.builder()
            .location("US")
            .dataExchangeId("dcr_data_exchange")
            .displayName("dcr_data_exchange")
            .description("example dcr data exchange")
            .sharingEnvironmentConfig(DataExchangeSharingEnvironmentConfigArgs.builder()
                .dcrExchangeConfig()
                .build())
            .build());

    }
}
Copy
resources:
  dataExchange:
    type: gcp:bigqueryanalyticshub:DataExchange
    name: data_exchange
    properties:
      location: US
      dataExchangeId: dcr_data_exchange
      displayName: dcr_data_exchange
      description: example dcr data exchange
      sharingEnvironmentConfig:
        dcrExchangeConfig: {}
Copy

Create DataExchange Resource

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

Constructor syntax

new DataExchange(name: string, args: DataExchangeArgs, opts?: CustomResourceOptions);
@overload
def DataExchange(resource_name: str,
                 args: DataExchangeArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def DataExchange(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 data_exchange_id: Optional[str] = None,
                 display_name: Optional[str] = None,
                 location: Optional[str] = None,
                 description: Optional[str] = None,
                 documentation: Optional[str] = None,
                 icon: Optional[str] = None,
                 primary_contact: Optional[str] = None,
                 project: Optional[str] = None,
                 sharing_environment_config: Optional[DataExchangeSharingEnvironmentConfigArgs] = None)
func NewDataExchange(ctx *Context, name string, args DataExchangeArgs, opts ...ResourceOption) (*DataExchange, error)
public DataExchange(string name, DataExchangeArgs args, CustomResourceOptions? opts = null)
public DataExchange(String name, DataExchangeArgs args)
public DataExchange(String name, DataExchangeArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DataExchangeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DataExchangeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DataExchangeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DataExchangeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DataExchangeArgs
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 dataExchangeResource = new Gcp.BigQueryAnalyticsHub.DataExchange("dataExchangeResource", new()
{
    DataExchangeId = "string",
    DisplayName = "string",
    Location = "string",
    Description = "string",
    Documentation = "string",
    Icon = "string",
    PrimaryContact = "string",
    Project = "string",
    SharingEnvironmentConfig = new Gcp.BigQueryAnalyticsHub.Inputs.DataExchangeSharingEnvironmentConfigArgs
    {
        DcrExchangeConfig = null,
        DefaultExchangeConfig = null,
    },
});
Copy
example, err := bigqueryanalyticshub.NewDataExchange(ctx, "dataExchangeResource", &bigqueryanalyticshub.DataExchangeArgs{
	DataExchangeId: pulumi.String("string"),
	DisplayName:    pulumi.String("string"),
	Location:       pulumi.String("string"),
	Description:    pulumi.String("string"),
	Documentation:  pulumi.String("string"),
	Icon:           pulumi.String("string"),
	PrimaryContact: pulumi.String("string"),
	Project:        pulumi.String("string"),
	SharingEnvironmentConfig: &bigqueryanalyticshub.DataExchangeSharingEnvironmentConfigArgs{
		DcrExchangeConfig:     &bigqueryanalyticshub.DataExchangeSharingEnvironmentConfigDcrExchangeConfigArgs{},
		DefaultExchangeConfig: &bigqueryanalyticshub.DataExchangeSharingEnvironmentConfigDefaultExchangeConfigArgs{},
	},
})
Copy
var dataExchangeResource = new DataExchange("dataExchangeResource", DataExchangeArgs.builder()
    .dataExchangeId("string")
    .displayName("string")
    .location("string")
    .description("string")
    .documentation("string")
    .icon("string")
    .primaryContact("string")
    .project("string")
    .sharingEnvironmentConfig(DataExchangeSharingEnvironmentConfigArgs.builder()
        .dcrExchangeConfig()
        .defaultExchangeConfig()
        .build())
    .build());
Copy
data_exchange_resource = gcp.bigqueryanalyticshub.DataExchange("dataExchangeResource",
    data_exchange_id="string",
    display_name="string",
    location="string",
    description="string",
    documentation="string",
    icon="string",
    primary_contact="string",
    project="string",
    sharing_environment_config={
        "dcr_exchange_config": {},
        "default_exchange_config": {},
    })
Copy
const dataExchangeResource = new gcp.bigqueryanalyticshub.DataExchange("dataExchangeResource", {
    dataExchangeId: "string",
    displayName: "string",
    location: "string",
    description: "string",
    documentation: "string",
    icon: "string",
    primaryContact: "string",
    project: "string",
    sharingEnvironmentConfig: {
        dcrExchangeConfig: {},
        defaultExchangeConfig: {},
    },
});
Copy
type: gcp:bigqueryanalyticshub:DataExchange
properties:
    dataExchangeId: string
    description: string
    displayName: string
    documentation: string
    icon: string
    location: string
    primaryContact: string
    project: string
    sharingEnvironmentConfig:
        dcrExchangeConfig: {}
        defaultExchangeConfig: {}
Copy

DataExchange 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 DataExchange resource accepts the following input properties:

DataExchangeId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
DisplayName This property is required. string
Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.

Location
This property is required.
Changes to this property will trigger replacement.
string
The name of the location this data exchange.
Description string
Description of the data exchange.
Documentation string
Documentation describing the data exchange.
Icon string
Base64 encoded image representing the data exchange.
PrimaryContact string
Email or URL of the primary point of contact of the data exchange.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SharingEnvironmentConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfig
Configurable data sharing environment option for a data exchange. This field is required for data clean room exchanges. Structure is documented below.
DataExchangeId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
DisplayName This property is required. string
Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.

Location
This property is required.
Changes to this property will trigger replacement.
string
The name of the location this data exchange.
Description string
Description of the data exchange.
Documentation string
Documentation describing the data exchange.
Icon string
Base64 encoded image representing the data exchange.
PrimaryContact string
Email or URL of the primary point of contact of the data exchange.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SharingEnvironmentConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfigArgs
Configurable data sharing environment option for a data exchange. This field is required for data clean room exchanges. Structure is documented below.
dataExchangeId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
displayName This property is required. String
Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.

location
This property is required.
Changes to this property will trigger replacement.
String
The name of the location this data exchange.
description String
Description of the data exchange.
documentation String
Documentation describing the data exchange.
icon String
Base64 encoded image representing the data exchange.
primaryContact String
Email or URL of the primary point of contact of the data exchange.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
sharingEnvironmentConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfig
Configurable data sharing environment option for a data exchange. This field is required for data clean room exchanges. Structure is documented below.
dataExchangeId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
displayName This property is required. string
Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.

location
This property is required.
Changes to this property will trigger replacement.
string
The name of the location this data exchange.
description string
Description of the data exchange.
documentation string
Documentation describing the data exchange.
icon string
Base64 encoded image representing the data exchange.
primaryContact string
Email or URL of the primary point of contact of the data exchange.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
sharingEnvironmentConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfig
Configurable data sharing environment option for a data exchange. This field is required for data clean room exchanges. Structure is documented below.
data_exchange_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
display_name This property is required. str
Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.

location
This property is required.
Changes to this property will trigger replacement.
str
The name of the location this data exchange.
description str
Description of the data exchange.
documentation str
Documentation describing the data exchange.
icon str
Base64 encoded image representing the data exchange.
primary_contact str
Email or URL of the primary point of contact of the data exchange.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
sharing_environment_config Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfigArgs
Configurable data sharing environment option for a data exchange. This field is required for data clean room exchanges. Structure is documented below.
dataExchangeId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
displayName This property is required. String
Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.

location
This property is required.
Changes to this property will trigger replacement.
String
The name of the location this data exchange.
description String
Description of the data exchange.
documentation String
Documentation describing the data exchange.
icon String
Base64 encoded image representing the data exchange.
primaryContact String
Email or URL of the primary point of contact of the data exchange.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
sharingEnvironmentConfig Changes to this property will trigger replacement. Property Map
Configurable data sharing environment option for a data exchange. This field is required for data clean room exchanges. Structure is documented below.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
ListingCount int
Number of listings contained in the data exchange.
Name string
The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
Id string
The provider-assigned unique ID for this managed resource.
ListingCount int
Number of listings contained in the data exchange.
Name string
The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
id String
The provider-assigned unique ID for this managed resource.
listingCount Integer
Number of listings contained in the data exchange.
name String
The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
id string
The provider-assigned unique ID for this managed resource.
listingCount number
Number of listings contained in the data exchange.
name string
The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
id str
The provider-assigned unique ID for this managed resource.
listing_count int
Number of listings contained in the data exchange.
name str
The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
id String
The provider-assigned unique ID for this managed resource.
listingCount Number
Number of listings contained in the data exchange.
name String
The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"

Look up Existing DataExchange Resource

Get an existing DataExchange 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?: DataExchangeState, opts?: CustomResourceOptions): DataExchange
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_exchange_id: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        documentation: Optional[str] = None,
        icon: Optional[str] = None,
        listing_count: Optional[int] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        primary_contact: Optional[str] = None,
        project: Optional[str] = None,
        sharing_environment_config: Optional[DataExchangeSharingEnvironmentConfigArgs] = None) -> DataExchange
func GetDataExchange(ctx *Context, name string, id IDInput, state *DataExchangeState, opts ...ResourceOption) (*DataExchange, error)
public static DataExchange Get(string name, Input<string> id, DataExchangeState? state, CustomResourceOptions? opts = null)
public static DataExchange get(String name, Output<String> id, DataExchangeState state, CustomResourceOptions options)
resources:  _:    type: gcp:bigqueryanalyticshub:DataExchange    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
DataExchangeId Changes to this property will trigger replacement. string
The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
Description string
Description of the data exchange.
DisplayName string
Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.

Documentation string
Documentation describing the data exchange.
Icon string
Base64 encoded image representing the data exchange.
ListingCount int
Number of listings contained in the data exchange.
Location Changes to this property will trigger replacement. string
The name of the location this data exchange.
Name string
The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
PrimaryContact string
Email or URL of the primary point of contact of the data exchange.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SharingEnvironmentConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfig
Configurable data sharing environment option for a data exchange. This field is required for data clean room exchanges. Structure is documented below.
DataExchangeId Changes to this property will trigger replacement. string
The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
Description string
Description of the data exchange.
DisplayName string
Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.

Documentation string
Documentation describing the data exchange.
Icon string
Base64 encoded image representing the data exchange.
ListingCount int
Number of listings contained in the data exchange.
Location Changes to this property will trigger replacement. string
The name of the location this data exchange.
Name string
The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
PrimaryContact string
Email or URL of the primary point of contact of the data exchange.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SharingEnvironmentConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfigArgs
Configurable data sharing environment option for a data exchange. This field is required for data clean room exchanges. Structure is documented below.
dataExchangeId Changes to this property will trigger replacement. String
The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
description String
Description of the data exchange.
displayName String
Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.

documentation String
Documentation describing the data exchange.
icon String
Base64 encoded image representing the data exchange.
listingCount Integer
Number of listings contained in the data exchange.
location Changes to this property will trigger replacement. String
The name of the location this data exchange.
name String
The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
primaryContact String
Email or URL of the primary point of contact of the data exchange.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
sharingEnvironmentConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfig
Configurable data sharing environment option for a data exchange. This field is required for data clean room exchanges. Structure is documented below.
dataExchangeId Changes to this property will trigger replacement. string
The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
description string
Description of the data exchange.
displayName string
Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.

documentation string
Documentation describing the data exchange.
icon string
Base64 encoded image representing the data exchange.
listingCount number
Number of listings contained in the data exchange.
location Changes to this property will trigger replacement. string
The name of the location this data exchange.
name string
The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
primaryContact string
Email or URL of the primary point of contact of the data exchange.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
sharingEnvironmentConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfig
Configurable data sharing environment option for a data exchange. This field is required for data clean room exchanges. Structure is documented below.
data_exchange_id Changes to this property will trigger replacement. str
The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
description str
Description of the data exchange.
display_name str
Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.

documentation str
Documentation describing the data exchange.
icon str
Base64 encoded image representing the data exchange.
listing_count int
Number of listings contained in the data exchange.
location Changes to this property will trigger replacement. str
The name of the location this data exchange.
name str
The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
primary_contact str
Email or URL of the primary point of contact of the data exchange.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
sharing_environment_config Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfigArgs
Configurable data sharing environment option for a data exchange. This field is required for data clean room exchanges. Structure is documented below.
dataExchangeId Changes to this property will trigger replacement. String
The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
description String
Description of the data exchange.
displayName String
Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.

documentation String
Documentation describing the data exchange.
icon String
Base64 encoded image representing the data exchange.
listingCount Number
Number of listings contained in the data exchange.
location Changes to this property will trigger replacement. String
The name of the location this data exchange.
name String
The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
primaryContact String
Email or URL of the primary point of contact of the data exchange.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
sharingEnvironmentConfig Changes to this property will trigger replacement. Property Map
Configurable data sharing environment option for a data exchange. This field is required for data clean room exchanges. Structure is documented below.

Supporting Types

DataExchangeSharingEnvironmentConfig
, DataExchangeSharingEnvironmentConfigArgs

DcrExchangeConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfigDcrExchangeConfig
Data Clean Room (DCR), used for privacy-safe and secured data sharing.
DefaultExchangeConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfigDefaultExchangeConfig
Default Analytics Hub data exchange, used for secured data sharing.
DcrExchangeConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfigDcrExchangeConfig
Data Clean Room (DCR), used for privacy-safe and secured data sharing.
DefaultExchangeConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfigDefaultExchangeConfig
Default Analytics Hub data exchange, used for secured data sharing.
dcrExchangeConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfigDcrExchangeConfig
Data Clean Room (DCR), used for privacy-safe and secured data sharing.
defaultExchangeConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfigDefaultExchangeConfig
Default Analytics Hub data exchange, used for secured data sharing.
dcrExchangeConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfigDcrExchangeConfig
Data Clean Room (DCR), used for privacy-safe and secured data sharing.
defaultExchangeConfig Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfigDefaultExchangeConfig
Default Analytics Hub data exchange, used for secured data sharing.
dcr_exchange_config Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfigDcrExchangeConfig
Data Clean Room (DCR), used for privacy-safe and secured data sharing.
default_exchange_config Changes to this property will trigger replacement. DataExchangeSharingEnvironmentConfigDefaultExchangeConfig
Default Analytics Hub data exchange, used for secured data sharing.
dcrExchangeConfig Changes to this property will trigger replacement. Property Map
Data Clean Room (DCR), used for privacy-safe and secured data sharing.
defaultExchangeConfig Changes to this property will trigger replacement. Property Map
Default Analytics Hub data exchange, used for secured data sharing.

Import

DataExchange can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{location}}/dataExchanges/{{data_exchange_id}}

  • {{project}}/{{location}}/{{data_exchange_id}}

  • {{location}}/{{data_exchange_id}}

  • {{data_exchange_id}}

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

$ pulumi import gcp:bigqueryanalyticshub/dataExchange:DataExchange default projects/{{project}}/locations/{{location}}/dataExchanges/{{data_exchange_id}}
Copy
$ pulumi import gcp:bigqueryanalyticshub/dataExchange:DataExchange default {{project}}/{{location}}/{{data_exchange_id}}
Copy
$ pulumi import gcp:bigqueryanalyticshub/dataExchange:DataExchange default {{location}}/{{data_exchange_id}}
Copy
$ pulumi import gcp:bigqueryanalyticshub/dataExchange:DataExchange default {{data_exchange_id}}
Copy

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

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp