Skip to content

googleBigqueryAnalyticsHubListing

A Bigquery Analytics Hub data exchange listing

To get more information about Listing, see:

Open in Cloud Shell

Example Usage - Bigquery Analyticshub Listing Basic

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const googleBigqueryAnalyticsHubDataExchangeListing =
  new google.bigqueryAnalyticsHubDataExchange.BigqueryAnalyticsHubDataExchange(
    this,
    "listing",
    {
      data_exchange_id: "my_data_exchange",
      description: "example data exchange",
      display_name: "my_data_exchange",
      location: "US",
    }
  );
const googleBigqueryDatasetListing = new google.bigqueryDataset.BigqueryDataset(
  this,
  "listing_1",
  {
    dataset_id: "my_listing",
    description: "example data exchange",
    friendly_name: "my_listing",
    location: "US",
  }
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
googleBigqueryDatasetListing.overrideLogicalId("listing");
const googleBigqueryAnalyticsHubListingListing =
  new google.bigqueryAnalyticsHubListing.BigqueryAnalyticsHubListing(
    this,
    "listing_2",
    {
      bigquery_dataset: [
        {
          dataset: googleBigqueryDatasetListing.id,
        },
      ],
      data_exchange_id:
        googleBigqueryAnalyticsHubDataExchangeListing.dataExchangeId,
      description: "example data exchange",
      display_name: "my_listing",
      listing_id: "my_listing",
      location: "US",
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
googleBigqueryAnalyticsHubListingListing.overrideLogicalId("listing");

Argument Reference

The following arguments are supported:

  • dataExchangeId - (Required) 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.

  • listingId - (Required) The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.

  • location - (Required) The name of the location this data exchange listing.

  • displayName - (Required) Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces.

  • bigqueryDataset - (Required) Shared dataset i.e. BigQuery dataset source. Structure is documented below.

The bigqueryDataset block supports:

  • dataset - (Required) Resource name of the dataset source for this listing. e.g. projects/myproject/datasets/123

  • description - (Optional) Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF).

  • primaryContact - (Optional) Email or URL of the primary point of contact of the listing.

  • documentation - (Optional) Documentation describing the listing.

  • icon - (Optional) Base64 encoded image representing the listing.

  • requestAccess - (Optional) Email or URL of the request access of the listing. Subscribers can use this reference to request access.

  • dataProvider - (Optional) Details of the data provider who owns the source data. Structure is documented below.

  • publisher - (Optional) Details of the publisher who owns the listing and who can share the source data. Structure is documented below.

  • categories - (Optional) Categories of the listing. Up to two categories are allowed.

  • project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The dataProvider block supports:

  • name - (Required) Name of the data provider.

  • primaryContact - (Optional) Email or URL of the data provider.

The publisher block supports:

  • name - (Required) Name of the listing publisher.

  • primaryContact - (Optional) Email or URL of the listing publisher.

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

  • id - an identifier for the resource with format projects/{{project}}/locations/{{location}}/dataExchanges/{{dataExchangeId}}/listings/{{listingId}}

  • name - The resource name of the listing. e.g. "projects/myproject/locations/US/dataExchanges/123/listings/456"

Timeouts

This resource provides the following Timeouts configuration options:

  • create - Default is 20 minutes.
  • update - Default is 20 minutes.
  • delete - Default is 20 minutes.

Import

Listing can be imported using any of these accepted formats:

$ terraform import google_bigquery_analytics_hub_listing.default projects/{{project}}/locations/{{location}}/dataExchanges/{{data_exchange_id}}/listings/{{listing_id}}
$ terraform import google_bigquery_analytics_hub_listing.default {{project}}/{{location}}/{{data_exchange_id}}/{{listing_id}}
$ terraform import google_bigquery_analytics_hub_listing.default {{location}}/{{data_exchange_id}}/{{listing_id}}

User Project Overrides

This resource supports User Project Overrides.