gcp.bigqueryanalyticshub.DataExchangeSubscription
Explore with Pulumi AI
Example Usage
Bigquery Analyticshub Dataexchange Subscription Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const subscription = new gcp.bigqueryanalyticshub.DataExchange("subscription", {
location: "us",
dataExchangeId: "my_test_dataexchange",
displayName: "my_test_dataexchange",
description: "Test Data Exchange",
sharingEnvironmentConfig: {
dcrExchangeConfig: {},
},
});
const subscriptionDataset = new gcp.bigquery.Dataset("subscription", {
datasetId: "listing_src_dataset",
friendlyName: "listing_src_dataset",
description: "Dataset for Listing",
location: "us",
});
const subscriptionTable = new gcp.bigquery.Table("subscription", {
deletionProtection: false,
tableId: "listing_src_table",
datasetId: subscriptionDataset.datasetId,
schema: `[
{
"name": "name",
"type": "STRING",
"mode": "NULLABLE"
},
{
"name": "post_abbr",
"type": "STRING",
"mode": "NULLABLE"
},
{
"name": "date",
"type": "DATE",
"mode": "NULLABLE"
}
]
`,
});
const subscriptionListing = new gcp.bigqueryanalyticshub.Listing("subscription", {
location: "us",
dataExchangeId: subscription.dataExchangeId,
listingId: "my_test_listing",
displayName: "my_test_listing",
description: "Test Listing",
restrictedExportConfig: {
enabled: true,
},
bigqueryDataset: {
dataset: subscriptionDataset.id,
selectedResources: [{
table: subscriptionTable.id,
}],
},
});
const subscriptionDataExchangeSubscription = new gcp.bigqueryanalyticshub.DataExchangeSubscription("subscription", {
project: subscriptionDataset.project,
location: "us",
dataExchangeProject: subscription.project,
dataExchangeLocation: subscription.location,
dataExchangeId: subscription.dataExchangeId,
subscriptionId: "my_subscription_id",
subscriberContact: "testuser@example.com",
destinationDataset: {
location: "us",
datasetReference: {
projectId: subscriptionDataset.project,
datasetId: "subscribed_dest_dataset",
},
friendlyName: "Subscribed Destination Dataset",
description: "Destination dataset for subscription",
labels: {
environment: "development",
owner: "team-a",
},
},
refreshPolicy: "ON_READ",
});
import pulumi
import pulumi_gcp as gcp
subscription = gcp.bigqueryanalyticshub.DataExchange("subscription",
location="us",
data_exchange_id="my_test_dataexchange",
display_name="my_test_dataexchange",
description="Test Data Exchange",
sharing_environment_config={
"dcr_exchange_config": {},
})
subscription_dataset = gcp.bigquery.Dataset("subscription",
dataset_id="listing_src_dataset",
friendly_name="listing_src_dataset",
description="Dataset for Listing",
location="us")
subscription_table = gcp.bigquery.Table("subscription",
deletion_protection=False,
table_id="listing_src_table",
dataset_id=subscription_dataset.dataset_id,
schema="""[
{
"name": "name",
"type": "STRING",
"mode": "NULLABLE"
},
{
"name": "post_abbr",
"type": "STRING",
"mode": "NULLABLE"
},
{
"name": "date",
"type": "DATE",
"mode": "NULLABLE"
}
]
""")
subscription_listing = gcp.bigqueryanalyticshub.Listing("subscription",
location="us",
data_exchange_id=subscription.data_exchange_id,
listing_id="my_test_listing",
display_name="my_test_listing",
description="Test Listing",
restricted_export_config={
"enabled": True,
},
bigquery_dataset={
"dataset": subscription_dataset.id,
"selected_resources": [{
"table": subscription_table.id,
}],
})
subscription_data_exchange_subscription = gcp.bigqueryanalyticshub.DataExchangeSubscription("subscription",
project=subscription_dataset.project,
location="us",
data_exchange_project=subscription.project,
data_exchange_location=subscription.location,
data_exchange_id=subscription.data_exchange_id,
subscription_id="my_subscription_id",
subscriber_contact="testuser@example.com",
destination_dataset={
"location": "us",
"dataset_reference": {
"project_id": subscription_dataset.project,
"dataset_id": "subscribed_dest_dataset",
},
"friendly_name": "Subscribed Destination Dataset",
"description": "Destination dataset for subscription",
"labels": {
"environment": "development",
"owner": "team-a",
},
},
refresh_policy="ON_READ")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigquery"
"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 {
subscription, err := bigqueryanalyticshub.NewDataExchange(ctx, "subscription", &bigqueryanalyticshub.DataExchangeArgs{
Location: pulumi.String("us"),
DataExchangeId: pulumi.String("my_test_dataexchange"),
DisplayName: pulumi.String("my_test_dataexchange"),
Description: pulumi.String("Test Data Exchange"),
SharingEnvironmentConfig: &bigqueryanalyticshub.DataExchangeSharingEnvironmentConfigArgs{
DcrExchangeConfig: &bigqueryanalyticshub.DataExchangeSharingEnvironmentConfigDcrExchangeConfigArgs{},
},
})
if err != nil {
return err
}
subscriptionDataset, err := bigquery.NewDataset(ctx, "subscription", &bigquery.DatasetArgs{
DatasetId: pulumi.String("listing_src_dataset"),
FriendlyName: pulumi.String("listing_src_dataset"),
Description: pulumi.String("Dataset for Listing"),
Location: pulumi.String("us"),
})
if err != nil {
return err
}
subscriptionTable, err := bigquery.NewTable(ctx, "subscription", &bigquery.TableArgs{
DeletionProtection: pulumi.Bool(false),
TableId: pulumi.String("listing_src_table"),
DatasetId: subscriptionDataset.DatasetId,
Schema: pulumi.String(`[
{
"name": "name",
"type": "STRING",
"mode": "NULLABLE"
},
{
"name": "post_abbr",
"type": "STRING",
"mode": "NULLABLE"
},
{
"name": "date",
"type": "DATE",
"mode": "NULLABLE"
}
]
`),
})
if err != nil {
return err
}
_, err = bigqueryanalyticshub.NewListing(ctx, "subscription", &bigqueryanalyticshub.ListingArgs{
Location: pulumi.String("us"),
DataExchangeId: subscription.DataExchangeId,
ListingId: pulumi.String("my_test_listing"),
DisplayName: pulumi.String("my_test_listing"),
Description: pulumi.String("Test Listing"),
RestrictedExportConfig: &bigqueryanalyticshub.ListingRestrictedExportConfigArgs{
Enabled: pulumi.Bool(true),
},
BigqueryDataset: &bigqueryanalyticshub.ListingBigqueryDatasetArgs{
Dataset: subscriptionDataset.ID(),
SelectedResources: bigqueryanalyticshub.ListingBigqueryDatasetSelectedResourceArray{
&bigqueryanalyticshub.ListingBigqueryDatasetSelectedResourceArgs{
Table: subscriptionTable.ID(),
},
},
},
})
if err != nil {
return err
}
_, err = bigqueryanalyticshub.NewDataExchangeSubscription(ctx, "subscription", &bigqueryanalyticshub.DataExchangeSubscriptionArgs{
Project: subscriptionDataset.Project,
Location: pulumi.String("us"),
DataExchangeProject: subscription.Project,
DataExchangeLocation: subscription.Location,
DataExchangeId: subscription.DataExchangeId,
SubscriptionId: pulumi.String("my_subscription_id"),
SubscriberContact: pulumi.String("testuser@example.com"),
DestinationDataset: &bigqueryanalyticshub.DataExchangeSubscriptionDestinationDatasetArgs{
Location: pulumi.String("us"),
DatasetReference: &bigqueryanalyticshub.DataExchangeSubscriptionDestinationDatasetDatasetReferenceArgs{
ProjectId: subscriptionDataset.Project,
DatasetId: pulumi.String("subscribed_dest_dataset"),
},
FriendlyName: pulumi.String("Subscribed Destination Dataset"),
Description: pulumi.String("Destination dataset for subscription"),
Labels: pulumi.StringMap{
"environment": pulumi.String("development"),
"owner": pulumi.String("team-a"),
},
},
RefreshPolicy: pulumi.String("ON_READ"),
})
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 subscription = new Gcp.BigQueryAnalyticsHub.DataExchange("subscription", new()
{
Location = "us",
DataExchangeId = "my_test_dataexchange",
DisplayName = "my_test_dataexchange",
Description = "Test Data Exchange",
SharingEnvironmentConfig = new Gcp.BigQueryAnalyticsHub.Inputs.DataExchangeSharingEnvironmentConfigArgs
{
DcrExchangeConfig = null,
},
});
var subscriptionDataset = new Gcp.BigQuery.Dataset("subscription", new()
{
DatasetId = "listing_src_dataset",
FriendlyName = "listing_src_dataset",
Description = "Dataset for Listing",
Location = "us",
});
var subscriptionTable = new Gcp.BigQuery.Table("subscription", new()
{
DeletionProtection = false,
TableId = "listing_src_table",
DatasetId = subscriptionDataset.DatasetId,
Schema = @"[
{
""name"": ""name"",
""type"": ""STRING"",
""mode"": ""NULLABLE""
},
{
""name"": ""post_abbr"",
""type"": ""STRING"",
""mode"": ""NULLABLE""
},
{
""name"": ""date"",
""type"": ""DATE"",
""mode"": ""NULLABLE""
}
]
",
});
var subscriptionListing = new Gcp.BigQueryAnalyticsHub.Listing("subscription", new()
{
Location = "us",
DataExchangeId = subscription.DataExchangeId,
ListingId = "my_test_listing",
DisplayName = "my_test_listing",
Description = "Test Listing",
RestrictedExportConfig = new Gcp.BigQueryAnalyticsHub.Inputs.ListingRestrictedExportConfigArgs
{
Enabled = true,
},
BigqueryDataset = new Gcp.BigQueryAnalyticsHub.Inputs.ListingBigqueryDatasetArgs
{
Dataset = subscriptionDataset.Id,
SelectedResources = new[]
{
new Gcp.BigQueryAnalyticsHub.Inputs.ListingBigqueryDatasetSelectedResourceArgs
{
Table = subscriptionTable.Id,
},
},
},
});
var subscriptionDataExchangeSubscription = new Gcp.BigQueryAnalyticsHub.DataExchangeSubscription("subscription", new()
{
Project = subscriptionDataset.Project,
Location = "us",
DataExchangeProject = subscription.Project,
DataExchangeLocation = subscription.Location,
DataExchangeId = subscription.DataExchangeId,
SubscriptionId = "my_subscription_id",
SubscriberContact = "testuser@example.com",
DestinationDataset = new Gcp.BigQueryAnalyticsHub.Inputs.DataExchangeSubscriptionDestinationDatasetArgs
{
Location = "us",
DatasetReference = new Gcp.BigQueryAnalyticsHub.Inputs.DataExchangeSubscriptionDestinationDatasetDatasetReferenceArgs
{
ProjectId = subscriptionDataset.Project,
DatasetId = "subscribed_dest_dataset",
},
FriendlyName = "Subscribed Destination Dataset",
Description = "Destination dataset for subscription",
Labels =
{
{ "environment", "development" },
{ "owner", "team-a" },
},
},
RefreshPolicy = "ON_READ",
});
});
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 com.pulumi.gcp.bigquery.Dataset;
import com.pulumi.gcp.bigquery.DatasetArgs;
import com.pulumi.gcp.bigquery.Table;
import com.pulumi.gcp.bigquery.TableArgs;
import com.pulumi.gcp.bigqueryanalyticshub.Listing;
import com.pulumi.gcp.bigqueryanalyticshub.ListingArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.ListingRestrictedExportConfigArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.ListingBigqueryDatasetArgs;
import com.pulumi.gcp.bigqueryanalyticshub.DataExchangeSubscription;
import com.pulumi.gcp.bigqueryanalyticshub.DataExchangeSubscriptionArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.DataExchangeSubscriptionDestinationDatasetArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.DataExchangeSubscriptionDestinationDatasetDatasetReferenceArgs;
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 subscription = new DataExchange("subscription", DataExchangeArgs.builder()
.location("us")
.dataExchangeId("my_test_dataexchange")
.displayName("my_test_dataexchange")
.description("Test Data Exchange")
.sharingEnvironmentConfig(DataExchangeSharingEnvironmentConfigArgs.builder()
.dcrExchangeConfig(DataExchangeSharingEnvironmentConfigDcrExchangeConfigArgs.builder()
.build())
.build())
.build());
var subscriptionDataset = new Dataset("subscriptionDataset", DatasetArgs.builder()
.datasetId("listing_src_dataset")
.friendlyName("listing_src_dataset")
.description("Dataset for Listing")
.location("us")
.build());
var subscriptionTable = new Table("subscriptionTable", TableArgs.builder()
.deletionProtection(false)
.tableId("listing_src_table")
.datasetId(subscriptionDataset.datasetId())
.schema("""
[
{
"name": "name",
"type": "STRING",
"mode": "NULLABLE"
},
{
"name": "post_abbr",
"type": "STRING",
"mode": "NULLABLE"
},
{
"name": "date",
"type": "DATE",
"mode": "NULLABLE"
}
]
""")
.build());
var subscriptionListing = new Listing("subscriptionListing", ListingArgs.builder()
.location("us")
.dataExchangeId(subscription.dataExchangeId())
.listingId("my_test_listing")
.displayName("my_test_listing")
.description("Test Listing")
.restrictedExportConfig(ListingRestrictedExportConfigArgs.builder()
.enabled(true)
.build())
.bigqueryDataset(ListingBigqueryDatasetArgs.builder()
.dataset(subscriptionDataset.id())
.selectedResources(ListingBigqueryDatasetSelectedResourceArgs.builder()
.table(subscriptionTable.id())
.build())
.build())
.build());
var subscriptionDataExchangeSubscription = new DataExchangeSubscription("subscriptionDataExchangeSubscription", DataExchangeSubscriptionArgs.builder()
.project(subscriptionDataset.project())
.location("us")
.dataExchangeProject(subscription.project())
.dataExchangeLocation(subscription.location())
.dataExchangeId(subscription.dataExchangeId())
.subscriptionId("my_subscription_id")
.subscriberContact("testuser@example.com")
.destinationDataset(DataExchangeSubscriptionDestinationDatasetArgs.builder()
.location("us")
.datasetReference(DataExchangeSubscriptionDestinationDatasetDatasetReferenceArgs.builder()
.projectId(subscriptionDataset.project())
.datasetId("subscribed_dest_dataset")
.build())
.friendlyName("Subscribed Destination Dataset")
.description("Destination dataset for subscription")
.labels(Map.ofEntries(
Map.entry("environment", "development"),
Map.entry("owner", "team-a")
))
.build())
.refreshPolicy("ON_READ")
.build());
}
}
resources:
subscription:
type: gcp:bigqueryanalyticshub:DataExchange
properties:
location: us
dataExchangeId: my_test_dataexchange
displayName: my_test_dataexchange
description: Test Data Exchange
sharingEnvironmentConfig:
dcrExchangeConfig: {}
subscriptionDataset:
type: gcp:bigquery:Dataset
name: subscription
properties:
datasetId: listing_src_dataset
friendlyName: listing_src_dataset
description: Dataset for Listing
location: us
subscriptionTable:
type: gcp:bigquery:Table
name: subscription
properties:
deletionProtection: false
tableId: listing_src_table
datasetId: ${subscriptionDataset.datasetId}
schema: |
[
{
"name": "name",
"type": "STRING",
"mode": "NULLABLE"
},
{
"name": "post_abbr",
"type": "STRING",
"mode": "NULLABLE"
},
{
"name": "date",
"type": "DATE",
"mode": "NULLABLE"
}
]
subscriptionListing:
type: gcp:bigqueryanalyticshub:Listing
name: subscription
properties:
location: us
dataExchangeId: ${subscription.dataExchangeId}
listingId: my_test_listing
displayName: my_test_listing
description: Test Listing
restrictedExportConfig:
enabled: true
bigqueryDataset:
dataset: ${subscriptionDataset.id}
selectedResources:
- table: ${subscriptionTable.id}
subscriptionDataExchangeSubscription:
type: gcp:bigqueryanalyticshub:DataExchangeSubscription
name: subscription
properties:
project: ${subscriptionDataset.project}
location: us
dataExchangeProject: ${subscription.project}
dataExchangeLocation: ${subscription.location}
dataExchangeId: ${subscription.dataExchangeId}
subscriptionId: my_subscription_id
subscriberContact: testuser@example.com
destinationDataset:
location: us
datasetReference:
projectId: ${subscriptionDataset.project}
datasetId: subscribed_dest_dataset
friendlyName: Subscribed Destination Dataset
description: Destination dataset for subscription
labels:
environment: development
owner: team-a
refreshPolicy: ON_READ
Create DataExchangeSubscription Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DataExchangeSubscription(name: string, args: DataExchangeSubscriptionArgs, opts?: CustomResourceOptions);
@overload
def DataExchangeSubscription(resource_name: str,
args: DataExchangeSubscriptionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DataExchangeSubscription(resource_name: str,
opts: Optional[ResourceOptions] = None,
data_exchange_id: Optional[str] = None,
data_exchange_location: Optional[str] = None,
data_exchange_project: Optional[str] = None,
location: Optional[str] = None,
subscription_id: Optional[str] = None,
destination_dataset: Optional[DataExchangeSubscriptionDestinationDatasetArgs] = None,
project: Optional[str] = None,
refresh_policy: Optional[str] = None,
subscriber_contact: Optional[str] = None)
func NewDataExchangeSubscription(ctx *Context, name string, args DataExchangeSubscriptionArgs, opts ...ResourceOption) (*DataExchangeSubscription, error)
public DataExchangeSubscription(string name, DataExchangeSubscriptionArgs args, CustomResourceOptions? opts = null)
public DataExchangeSubscription(String name, DataExchangeSubscriptionArgs args)
public DataExchangeSubscription(String name, DataExchangeSubscriptionArgs args, CustomResourceOptions options)
type: gcp:bigqueryanalyticshub:DataExchangeSubscription
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 DataExchangeSubscriptionArgs
- 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 DataExchangeSubscriptionArgs
- 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 DataExchangeSubscriptionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DataExchangeSubscriptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DataExchangeSubscriptionArgs
- 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 dataExchangeSubscriptionResource = new Gcp.BigQueryAnalyticsHub.DataExchangeSubscription("dataExchangeSubscriptionResource", new()
{
DataExchangeId = "string",
DataExchangeLocation = "string",
DataExchangeProject = "string",
Location = "string",
SubscriptionId = "string",
DestinationDataset = new Gcp.BigQueryAnalyticsHub.Inputs.DataExchangeSubscriptionDestinationDatasetArgs
{
DatasetReference = new Gcp.BigQueryAnalyticsHub.Inputs.DataExchangeSubscriptionDestinationDatasetDatasetReferenceArgs
{
DatasetId = "string",
ProjectId = "string",
},
Location = "string",
Description = "string",
FriendlyName = "string",
Labels =
{
{ "string", "string" },
},
},
Project = "string",
RefreshPolicy = "string",
SubscriberContact = "string",
});
example, err := bigqueryanalyticshub.NewDataExchangeSubscription(ctx, "dataExchangeSubscriptionResource", &bigqueryanalyticshub.DataExchangeSubscriptionArgs{
DataExchangeId: pulumi.String("string"),
DataExchangeLocation: pulumi.String("string"),
DataExchangeProject: pulumi.String("string"),
Location: pulumi.String("string"),
SubscriptionId: pulumi.String("string"),
DestinationDataset: &bigqueryanalyticshub.DataExchangeSubscriptionDestinationDatasetArgs{
DatasetReference: &bigqueryanalyticshub.DataExchangeSubscriptionDestinationDatasetDatasetReferenceArgs{
DatasetId: pulumi.String("string"),
ProjectId: pulumi.String("string"),
},
Location: pulumi.String("string"),
Description: pulumi.String("string"),
FriendlyName: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
Project: pulumi.String("string"),
RefreshPolicy: pulumi.String("string"),
SubscriberContact: pulumi.String("string"),
})
var dataExchangeSubscriptionResource = new DataExchangeSubscription("dataExchangeSubscriptionResource", DataExchangeSubscriptionArgs.builder()
.dataExchangeId("string")
.dataExchangeLocation("string")
.dataExchangeProject("string")
.location("string")
.subscriptionId("string")
.destinationDataset(DataExchangeSubscriptionDestinationDatasetArgs.builder()
.datasetReference(DataExchangeSubscriptionDestinationDatasetDatasetReferenceArgs.builder()
.datasetId("string")
.projectId("string")
.build())
.location("string")
.description("string")
.friendlyName("string")
.labels(Map.of("string", "string"))
.build())
.project("string")
.refreshPolicy("string")
.subscriberContact("string")
.build());
data_exchange_subscription_resource = gcp.bigqueryanalyticshub.DataExchangeSubscription("dataExchangeSubscriptionResource",
data_exchange_id="string",
data_exchange_location="string",
data_exchange_project="string",
location="string",
subscription_id="string",
destination_dataset={
"dataset_reference": {
"dataset_id": "string",
"project_id": "string",
},
"location": "string",
"description": "string",
"friendly_name": "string",
"labels": {
"string": "string",
},
},
project="string",
refresh_policy="string",
subscriber_contact="string")
const dataExchangeSubscriptionResource = new gcp.bigqueryanalyticshub.DataExchangeSubscription("dataExchangeSubscriptionResource", {
dataExchangeId: "string",
dataExchangeLocation: "string",
dataExchangeProject: "string",
location: "string",
subscriptionId: "string",
destinationDataset: {
datasetReference: {
datasetId: "string",
projectId: "string",
},
location: "string",
description: "string",
friendlyName: "string",
labels: {
string: "string",
},
},
project: "string",
refreshPolicy: "string",
subscriberContact: "string",
});
type: gcp:bigqueryanalyticshub:DataExchangeSubscription
properties:
dataExchangeId: string
dataExchangeLocation: string
dataExchangeProject: string
destinationDataset:
datasetReference:
datasetId: string
projectId: string
description: string
friendlyName: string
labels:
string: string
location: string
location: string
project: string
refreshPolicy: string
subscriberContact: string
subscriptionId: string
DataExchangeSubscription 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 DataExchangeSubscription resource accepts the following input properties:
- Data
Exchange stringId - 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.
- Data
Exchange stringLocation - The name of the location of the Data Exchange.
- Data
Exchange stringProject - The ID of the Google Cloud project where the Data Exchange is located.
- Location string
- The geographic location where the Subscription (and its linked dataset) should reside. This is the subscriber's desired location for the created resources. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- Subscription
Id string - Name of the subscription to create.
- Destination
Dataset DataExchange Subscription Destination Dataset - BigQuery destination dataset to create for the subscriber. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Refresh
Policy string - Subscriber
Contact string - Email of the subscriber.
- Data
Exchange stringId - 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.
- Data
Exchange stringLocation - The name of the location of the Data Exchange.
- Data
Exchange stringProject - The ID of the Google Cloud project where the Data Exchange is located.
- Location string
- The geographic location where the Subscription (and its linked dataset) should reside. This is the subscriber's desired location for the created resources. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- Subscription
Id string - Name of the subscription to create.
- Destination
Dataset DataExchange Subscription Destination Dataset Args - BigQuery destination dataset to create for the subscriber. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Refresh
Policy string - Subscriber
Contact string - Email of the subscriber.
- data
Exchange StringId - 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.
- data
Exchange StringLocation - The name of the location of the Data Exchange.
- data
Exchange StringProject - The ID of the Google Cloud project where the Data Exchange is located.
- location String
- The geographic location where the Subscription (and its linked dataset) should reside. This is the subscriber's desired location for the created resources. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- subscription
Id String - Name of the subscription to create.
- destination
Dataset DataExchange Subscription Destination Dataset - BigQuery destination dataset to create for the subscriber. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- refresh
Policy String - subscriber
Contact String - Email of the subscriber.
- data
Exchange stringId - 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.
- data
Exchange stringLocation - The name of the location of the Data Exchange.
- data
Exchange stringProject - The ID of the Google Cloud project where the Data Exchange is located.
- location string
- The geographic location where the Subscription (and its linked dataset) should reside. This is the subscriber's desired location for the created resources. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- subscription
Id string - Name of the subscription to create.
- destination
Dataset DataExchange Subscription Destination Dataset - BigQuery destination dataset to create for the subscriber. Structure is documented below.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- refresh
Policy string - subscriber
Contact string - Email of the subscriber.
- data_
exchange_ strid - 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.
- data_
exchange_ strlocation - The name of the location of the Data Exchange.
- data_
exchange_ strproject - The ID of the Google Cloud project where the Data Exchange is located.
- location str
- The geographic location where the Subscription (and its linked dataset) should reside. This is the subscriber's desired location for the created resources. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- subscription_
id str - Name of the subscription to create.
- destination_
dataset DataExchange Subscription Destination Dataset Args - BigQuery destination dataset to create for the subscriber. Structure is documented below.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- refresh_
policy str - subscriber_
contact str - Email of the subscriber.
- data
Exchange StringId - 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.
- data
Exchange StringLocation - The name of the location of the Data Exchange.
- data
Exchange StringProject - The ID of the Google Cloud project where the Data Exchange is located.
- location String
- The geographic location where the Subscription (and its linked dataset) should reside. This is the subscriber's desired location for the created resources. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- subscription
Id String - Name of the subscription to create.
- destination
Dataset Property Map - BigQuery destination dataset to create for the subscriber. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- refresh
Policy String - subscriber
Contact String - Email of the subscriber.
Outputs
All input properties are implicitly available as output properties. Additionally, the DataExchangeSubscription resource produces the following output properties:
- Creation
Time string - Timestamp when the subscription was created.
- Data
Exchange string - Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modify stringTime - Timestamp when the subscription was last modified.
- Linked
Dataset List<DataMaps Exchange Subscription Linked Dataset Map> - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset For Data Exchange subscriptions, this map may contain multiple entries if the Data Exchange has multiple listings. Structure is documented below.
- Linked
Resources List<DataExchange Subscription Linked Resource> - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- Log
Linked boolDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- Name string
- The resource name of the subscription. e.g. "projects/myproject/locations/us/subscriptions/123"
- Organization
Display stringName - Display name of the project of this subscription.
- Organization
Id string - Organization of the project this subscription belongs to.
- Resource
Type string - Listing shared asset type.
- State string
- Current state of the subscription.
- Creation
Time string - Timestamp when the subscription was created.
- Data
Exchange string - Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modify stringTime - Timestamp when the subscription was last modified.
- Linked
Dataset []DataMaps Exchange Subscription Linked Dataset Map - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset For Data Exchange subscriptions, this map may contain multiple entries if the Data Exchange has multiple listings. Structure is documented below.
- Linked
Resources []DataExchange Subscription Linked Resource - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- Log
Linked boolDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- Name string
- The resource name of the subscription. e.g. "projects/myproject/locations/us/subscriptions/123"
- Organization
Display stringName - Display name of the project of this subscription.
- Organization
Id string - Organization of the project this subscription belongs to.
- Resource
Type string - Listing shared asset type.
- State string
- Current state of the subscription.
- creation
Time String - Timestamp when the subscription was created.
- data
Exchange String - Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modify StringTime - Timestamp when the subscription was last modified.
- linked
Dataset List<DataMaps Exchange Subscription Linked Dataset Map> - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset For Data Exchange subscriptions, this map may contain multiple entries if the Data Exchange has multiple listings. Structure is documented below.
- linked
Resources List<DataExchange Subscription Linked Resource> - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- log
Linked BooleanDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- name String
- The resource name of the subscription. e.g. "projects/myproject/locations/us/subscriptions/123"
- organization
Display StringName - Display name of the project of this subscription.
- organization
Id String - Organization of the project this subscription belongs to.
- resource
Type String - Listing shared asset type.
- state String
- Current state of the subscription.
- creation
Time string - Timestamp when the subscription was created.
- data
Exchange string - Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modify stringTime - Timestamp when the subscription was last modified.
- linked
Dataset DataMaps Exchange Subscription Linked Dataset Map[] - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset For Data Exchange subscriptions, this map may contain multiple entries if the Data Exchange has multiple listings. Structure is documented below.
- linked
Resources DataExchange Subscription Linked Resource[] - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- log
Linked booleanDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- name string
- The resource name of the subscription. e.g. "projects/myproject/locations/us/subscriptions/123"
- organization
Display stringName - Display name of the project of this subscription.
- organization
Id string - Organization of the project this subscription belongs to.
- resource
Type string - Listing shared asset type.
- state string
- Current state of the subscription.
- creation_
time str - Timestamp when the subscription was created.
- data_
exchange str - Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modify_ strtime - Timestamp when the subscription was last modified.
- linked_
dataset_ Sequence[Datamaps Exchange Subscription Linked Dataset Map] - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset For Data Exchange subscriptions, this map may contain multiple entries if the Data Exchange has multiple listings. Structure is documented below.
- linked_
resources Sequence[DataExchange Subscription Linked Resource] - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- log_
linked_ booldataset_ query_ user_ email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- name str
- The resource name of the subscription. e.g. "projects/myproject/locations/us/subscriptions/123"
- organization_
display_ strname - Display name of the project of this subscription.
- organization_
id str - Organization of the project this subscription belongs to.
- resource_
type str - Listing shared asset type.
- state str
- Current state of the subscription.
- creation
Time String - Timestamp when the subscription was created.
- data
Exchange String - Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modify StringTime - Timestamp when the subscription was last modified.
- linked
Dataset List<Property Map>Maps - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset For Data Exchange subscriptions, this map may contain multiple entries if the Data Exchange has multiple listings. Structure is documented below.
- linked
Resources List<Property Map> - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- log
Linked BooleanDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- name String
- The resource name of the subscription. e.g. "projects/myproject/locations/us/subscriptions/123"
- organization
Display StringName - Display name of the project of this subscription.
- organization
Id String - Organization of the project this subscription belongs to.
- resource
Type String - Listing shared asset type.
- state String
- Current state of the subscription.
Look up Existing DataExchangeSubscription Resource
Get an existing DataExchangeSubscription 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?: DataExchangeSubscriptionState, opts?: CustomResourceOptions): DataExchangeSubscription
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
creation_time: Optional[str] = None,
data_exchange: Optional[str] = None,
data_exchange_id: Optional[str] = None,
data_exchange_location: Optional[str] = None,
data_exchange_project: Optional[str] = None,
destination_dataset: Optional[DataExchangeSubscriptionDestinationDatasetArgs] = None,
last_modify_time: Optional[str] = None,
linked_dataset_maps: Optional[Sequence[DataExchangeSubscriptionLinkedDatasetMapArgs]] = None,
linked_resources: Optional[Sequence[DataExchangeSubscriptionLinkedResourceArgs]] = None,
location: Optional[str] = None,
log_linked_dataset_query_user_email: Optional[bool] = None,
name: Optional[str] = None,
organization_display_name: Optional[str] = None,
organization_id: Optional[str] = None,
project: Optional[str] = None,
refresh_policy: Optional[str] = None,
resource_type: Optional[str] = None,
state: Optional[str] = None,
subscriber_contact: Optional[str] = None,
subscription_id: Optional[str] = None) -> DataExchangeSubscription
func GetDataExchangeSubscription(ctx *Context, name string, id IDInput, state *DataExchangeSubscriptionState, opts ...ResourceOption) (*DataExchangeSubscription, error)
public static DataExchangeSubscription Get(string name, Input<string> id, DataExchangeSubscriptionState? state, CustomResourceOptions? opts = null)
public static DataExchangeSubscription get(String name, Output<String> id, DataExchangeSubscriptionState state, CustomResourceOptions options)
resources: _: type: gcp:bigqueryanalyticshub:DataExchangeSubscription 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.
- Creation
Time string - Timestamp when the subscription was created.
- Data
Exchange string - Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
- Data
Exchange stringId - 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.
- Data
Exchange stringLocation - The name of the location of the Data Exchange.
- Data
Exchange stringProject - The ID of the Google Cloud project where the Data Exchange is located.
- Destination
Dataset DataExchange Subscription Destination Dataset - BigQuery destination dataset to create for the subscriber. Structure is documented below.
- Last
Modify stringTime - Timestamp when the subscription was last modified.
- Linked
Dataset List<DataMaps Exchange Subscription Linked Dataset Map> - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset For Data Exchange subscriptions, this map may contain multiple entries if the Data Exchange has multiple listings. Structure is documented below.
- Linked
Resources List<DataExchange Subscription Linked Resource> - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- Location string
- The geographic location where the Subscription (and its linked dataset) should reside. This is the subscriber's desired location for the created resources. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- Log
Linked boolDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- Name string
- The resource name of the subscription. e.g. "projects/myproject/locations/us/subscriptions/123"
- Organization
Display stringName - Display name of the project of this subscription.
- Organization
Id string - Organization of the project this subscription belongs to.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Refresh
Policy string - Resource
Type string - Listing shared asset type.
- State string
- Current state of the subscription.
- Subscriber
Contact string - Email of the subscriber.
- Subscription
Id string - Name of the subscription to create.
- Creation
Time string - Timestamp when the subscription was created.
- Data
Exchange string - Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
- Data
Exchange stringId - 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.
- Data
Exchange stringLocation - The name of the location of the Data Exchange.
- Data
Exchange stringProject - The ID of the Google Cloud project where the Data Exchange is located.
- Destination
Dataset DataExchange Subscription Destination Dataset Args - BigQuery destination dataset to create for the subscriber. Structure is documented below.
- Last
Modify stringTime - Timestamp when the subscription was last modified.
- Linked
Dataset []DataMaps Exchange Subscription Linked Dataset Map Args - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset For Data Exchange subscriptions, this map may contain multiple entries if the Data Exchange has multiple listings. Structure is documented below.
- Linked
Resources []DataExchange Subscription Linked Resource Args - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- Location string
- The geographic location where the Subscription (and its linked dataset) should reside. This is the subscriber's desired location for the created resources. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- Log
Linked boolDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- Name string
- The resource name of the subscription. e.g. "projects/myproject/locations/us/subscriptions/123"
- Organization
Display stringName - Display name of the project of this subscription.
- Organization
Id string - Organization of the project this subscription belongs to.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Refresh
Policy string - Resource
Type string - Listing shared asset type.
- State string
- Current state of the subscription.
- Subscriber
Contact string - Email of the subscriber.
- Subscription
Id string - Name of the subscription to create.
- creation
Time String - Timestamp when the subscription was created.
- data
Exchange String - Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
- data
Exchange StringId - 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.
- data
Exchange StringLocation - The name of the location of the Data Exchange.
- data
Exchange StringProject - The ID of the Google Cloud project where the Data Exchange is located.
- destination
Dataset DataExchange Subscription Destination Dataset - BigQuery destination dataset to create for the subscriber. Structure is documented below.
- last
Modify StringTime - Timestamp when the subscription was last modified.
- linked
Dataset List<DataMaps Exchange Subscription Linked Dataset Map> - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset For Data Exchange subscriptions, this map may contain multiple entries if the Data Exchange has multiple listings. Structure is documented below.
- linked
Resources List<DataExchange Subscription Linked Resource> - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- location String
- The geographic location where the Subscription (and its linked dataset) should reside. This is the subscriber's desired location for the created resources. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- log
Linked BooleanDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- name String
- The resource name of the subscription. e.g. "projects/myproject/locations/us/subscriptions/123"
- organization
Display StringName - Display name of the project of this subscription.
- organization
Id String - Organization of the project this subscription belongs to.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- refresh
Policy String - resource
Type String - Listing shared asset type.
- state String
- Current state of the subscription.
- subscriber
Contact String - Email of the subscriber.
- subscription
Id String - Name of the subscription to create.
- creation
Time string - Timestamp when the subscription was created.
- data
Exchange string - Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
- data
Exchange stringId - 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.
- data
Exchange stringLocation - The name of the location of the Data Exchange.
- data
Exchange stringProject - The ID of the Google Cloud project where the Data Exchange is located.
- destination
Dataset DataExchange Subscription Destination Dataset - BigQuery destination dataset to create for the subscriber. Structure is documented below.
- last
Modify stringTime - Timestamp when the subscription was last modified.
- linked
Dataset DataMaps Exchange Subscription Linked Dataset Map[] - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset For Data Exchange subscriptions, this map may contain multiple entries if the Data Exchange has multiple listings. Structure is documented below.
- linked
Resources DataExchange Subscription Linked Resource[] - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- location string
- The geographic location where the Subscription (and its linked dataset) should reside. This is the subscriber's desired location for the created resources. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- log
Linked booleanDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- name string
- The resource name of the subscription. e.g. "projects/myproject/locations/us/subscriptions/123"
- organization
Display stringName - Display name of the project of this subscription.
- organization
Id string - Organization of the project this subscription belongs to.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- refresh
Policy string - resource
Type string - Listing shared asset type.
- state string
- Current state of the subscription.
- subscriber
Contact string - Email of the subscriber.
- subscription
Id string - Name of the subscription to create.
- creation_
time str - Timestamp when the subscription was created.
- data_
exchange str - Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
- data_
exchange_ strid - 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.
- data_
exchange_ strlocation - The name of the location of the Data Exchange.
- data_
exchange_ strproject - The ID of the Google Cloud project where the Data Exchange is located.
- destination_
dataset DataExchange Subscription Destination Dataset Args - BigQuery destination dataset to create for the subscriber. Structure is documented below.
- last_
modify_ strtime - Timestamp when the subscription was last modified.
- linked_
dataset_ Sequence[Datamaps Exchange Subscription Linked Dataset Map Args] - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset For Data Exchange subscriptions, this map may contain multiple entries if the Data Exchange has multiple listings. Structure is documented below.
- linked_
resources Sequence[DataExchange Subscription Linked Resource Args] - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- location str
- The geographic location where the Subscription (and its linked dataset) should reside. This is the subscriber's desired location for the created resources. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- log_
linked_ booldataset_ query_ user_ email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- name str
- The resource name of the subscription. e.g. "projects/myproject/locations/us/subscriptions/123"
- organization_
display_ strname - Display name of the project of this subscription.
- organization_
id str - Organization of the project this subscription belongs to.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- refresh_
policy str - resource_
type str - Listing shared asset type.
- state str
- Current state of the subscription.
- subscriber_
contact str - Email of the subscriber.
- subscription_
id str - Name of the subscription to create.
- creation
Time String - Timestamp when the subscription was created.
- data
Exchange String - Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
- data
Exchange StringId - 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.
- data
Exchange StringLocation - The name of the location of the Data Exchange.
- data
Exchange StringProject - The ID of the Google Cloud project where the Data Exchange is located.
- destination
Dataset Property Map - BigQuery destination dataset to create for the subscriber. Structure is documented below.
- last
Modify StringTime - Timestamp when the subscription was last modified.
- linked
Dataset List<Property Map>Maps - Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset For Data Exchange subscriptions, this map may contain multiple entries if the Data Exchange has multiple listings. Structure is documented below.
- linked
Resources List<Property Map> - Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
- location String
- The geographic location where the Subscription (and its linked dataset) should reside. This is the subscriber's desired location for the created resources. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- log
Linked BooleanDataset Query User Email - Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- name String
- The resource name of the subscription. e.g. "projects/myproject/locations/us/subscriptions/123"
- organization
Display StringName - Display name of the project of this subscription.
- organization
Id String - Organization of the project this subscription belongs to.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- refresh
Policy String - resource
Type String - Listing shared asset type.
- state String
- Current state of the subscription.
- subscriber
Contact String - Email of the subscriber.
- subscription
Id String - Name of the subscription to create.
Supporting Types
DataExchangeSubscriptionDestinationDataset, DataExchangeSubscriptionDestinationDatasetArgs
- Dataset
Reference DataExchange Subscription Destination Dataset Dataset Reference - A reference that identifies the destination dataset. Structure is documented below.
- Location string
- The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- Description string
- A user-friendly description of the dataset.
- Friendly
Name string - A descriptive name for the dataset.
- Labels Dictionary<string, string>
- The labels associated with this dataset. You can use these to organize and group your datasets.
- Dataset
Reference DataExchange Subscription Destination Dataset Dataset Reference - A reference that identifies the destination dataset. Structure is documented below.
- Location string
- The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- Description string
- A user-friendly description of the dataset.
- Friendly
Name string - A descriptive name for the dataset.
- Labels map[string]string
- The labels associated with this dataset. You can use these to organize and group your datasets.
- dataset
Reference DataExchange Subscription Destination Dataset Dataset Reference - A reference that identifies the destination dataset. Structure is documented below.
- location String
- The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- description String
- A user-friendly description of the dataset.
- friendly
Name String - A descriptive name for the dataset.
- labels Map<String,String>
- The labels associated with this dataset. You can use these to organize and group your datasets.
- dataset
Reference DataExchange Subscription Destination Dataset Dataset Reference - A reference that identifies the destination dataset. Structure is documented below.
- location string
- The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- description string
- A user-friendly description of the dataset.
- friendly
Name string - A descriptive name for the dataset.
- labels {[key: string]: string}
- The labels associated with this dataset. You can use these to organize and group your datasets.
- dataset_
reference DataExchange Subscription Destination Dataset Dataset Reference - A reference that identifies the destination dataset. Structure is documented below.
- location str
- The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- description str
- A user-friendly description of the dataset.
- friendly_
name str - A descriptive name for the dataset.
- labels Mapping[str, str]
- The labels associated with this dataset. You can use these to organize and group your datasets.
- dataset
Reference Property Map - A reference that identifies the destination dataset. Structure is documented below.
- location String
- The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- description String
- A user-friendly description of the dataset.
- friendly
Name String - A descriptive name for the dataset.
- labels Map<String>
- The labels associated with this dataset. You can use these to organize and group your datasets.
DataExchangeSubscriptionDestinationDatasetDatasetReference, DataExchangeSubscriptionDestinationDatasetDatasetReferenceArgs
- dataset_
id str - A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project_
id str - The ID of the project containing this dataset.
DataExchangeSubscriptionLinkedDatasetMap, DataExchangeSubscriptionLinkedDatasetMapArgs
- Resource
Name string - (Required) The identifier for this object. Format specified above.
- Linked
Dataset string - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- Linked
Pubsub stringSubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
- Listing string
- (Output) Output only. Listing for which linked resource is created.
- Resource
Name string - (Required) The identifier for this object. Format specified above.
- Linked
Dataset string - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- Linked
Pubsub stringSubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
- Listing string
- (Output) Output only. Listing for which linked resource is created.
- resource
Name String - (Required) The identifier for this object. Format specified above.
- linked
Dataset String - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- linked
Pubsub StringSubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
- listing String
- (Output) Output only. Listing for which linked resource is created.
- resource
Name string - (Required) The identifier for this object. Format specified above.
- linked
Dataset string - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- linked
Pubsub stringSubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
- listing string
- (Output) Output only. Listing for which linked resource is created.
- resource_
name str - (Required) The identifier for this object. Format specified above.
- linked_
dataset str - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- linked_
pubsub_ strsubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
- listing str
- (Output) Output only. Listing for which linked resource is created.
- resource
Name String - (Required) The identifier for this object. Format specified above.
- linked
Dataset String - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- linked
Pubsub StringSubscription - (Output) Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
- listing String
- (Output) Output only. Listing for which linked resource is created.
DataExchangeSubscriptionLinkedResource, DataExchangeSubscriptionLinkedResourceArgs
- Linked
Dataset string - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- Listing string
- (Output) Output only. Listing for which linked resource is created.
- Linked
Dataset string - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- Listing string
- (Output) Output only. Listing for which linked resource is created.
- linked
Dataset String - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- listing String
- (Output) Output only. Listing for which linked resource is created.
- linked
Dataset string - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- listing string
- (Output) Output only. Listing for which linked resource is created.
- linked_
dataset str - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- listing str
- (Output) Output only. Listing for which linked resource is created.
- linked
Dataset String - (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
- listing String
- (Output) Output only. Listing for which linked resource is created.
Import
DataExchangeSubscription can be imported using any of these accepted formats:
projects/{{project}}/locations/{{location}}/subscriptions/{{subscription_id}}
{{project}}/{{location}}/{{subscription_id}}
{{location}}/{{subscription_id}}
When using the pulumi import
command, DataExchangeSubscription can be imported using one of the formats above. For example:
$ pulumi import gcp:bigqueryanalyticshub/dataExchangeSubscription:DataExchangeSubscription default projects/{{project}}/locations/{{location}}/subscriptions/{{subscription_id}}
$ pulumi import gcp:bigqueryanalyticshub/dataExchangeSubscription:DataExchangeSubscription default {{project}}/{{location}}/{{subscription_id}}
$ pulumi import gcp:bigqueryanalyticshub/dataExchangeSubscription:DataExchangeSubscription default {{location}}/{{subscription_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.