Docs
Packagesgcp.bigqueryanalyticshub.DataExchange
Explore with Pulumi AI
A Bigquery Analytics Hub data exchange
To get more information about DataExchange, see:
- API documentation
- How-to Guides
Example Usage
Bigquery Analyticshub Data Exchange Basic
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var dataExchange = new Gcp.BigQueryAnalyticsHub.DataExchange("dataExchange", new()
{
DataExchangeId = "my_data_exchange",
Description = "example data exchange",
DisplayName = "my_data_exchange",
Location = "US",
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/bigqueryanalyticshub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := bigqueryanalyticshub.NewDataExchange(ctx, "dataExchange", &bigqueryanalyticshub.DataExchangeArgs{
DataExchangeId: pulumi.String("my_data_exchange"),
Description: pulumi.String("example data exchange"),
DisplayName: pulumi.String("my_data_exchange"),
Location: pulumi.String("US"),
})
if err != nil {
return err
}
return nil
})
}
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()
.dataExchangeId("my_data_exchange")
.description("example data exchange")
.displayName("my_data_exchange")
.location("US")
.build());
}
}
import pulumi
import pulumi_gcp as gcp
data_exchange = gcp.bigqueryanalyticshub.DataExchange("dataExchange",
data_exchange_id="my_data_exchange",
description="example data exchange",
display_name="my_data_exchange",
location="US")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const dataExchange = new gcp.bigqueryanalyticshub.DataExchange("dataExchange", {
dataExchangeId: "my_data_exchange",
description: "example data exchange",
displayName: "my_data_exchange",
location: "US",
});
resources:
dataExchange:
type: gcp:bigqueryanalyticshub:DataExchange
properties:
dataExchangeId: my_data_exchange
description: example data exchange
displayName: my_data_exchange
location: US
Create DataExchange Resource
new DataExchange(name: string, args: DataExchangeArgs, opts?: CustomResourceOptions);@overload
def DataExchange(resource_name: 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,
location: Optional[str] = None,
primary_contact: Optional[str] = None,
project: Optional[str] = None)
@overload
def DataExchange(resource_name: str,
args: DataExchangeArgs,
opts: Optional[ResourceOptions] = 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.
- name string
- The unique name of the resource.
- args DataExchangeArgs
- 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 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 string
- The unique name of the resource.
- args DataExchangeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DataExchangeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DataExchangeArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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
The DataExchange 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.
- Display
Name 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 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.
- Primary
Contact string Email or URL of the primary point of contact of the data exchange.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- 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.
- Display
Name 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 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.
- Primary
Contact string Email or URL of the primary point of contact of the data exchange.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- 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.
- display
Name 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 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.
- primary
Contact String Email or URL of the primary point of contact of the data exchange.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- 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.
- display
Name 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 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.
- primary
Contact string Email or URL of the primary point of contact of the data exchange.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- 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.
- 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.
- location 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 str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- 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.
- display
Name 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 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.
- primary
Contact String Email or URL of the primary point of contact of the data exchange.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
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.
- Listing
Count 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.
- Listing
Count 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.
- listing
Count 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.
- listing
Count 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.
- listing
Count 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) -> DataExchangefunc 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)Resource lookup is not supported in YAML- 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.
- 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.
- Description string
Description of the data exchange.
- Display
Name 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.
- Listing
Count int Number of listings contained in the data exchange.
- Location 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"
- Primary
Contact string Email or URL of the primary point of contact of the data exchange.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- 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.
- Description string
Description of the data exchange.
- Display
Name 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.
- Listing
Count int Number of listings contained in the data exchange.
- Location 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"
- Primary
Contact string Email or URL of the primary point of contact of the data exchange.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- 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.
- description String
Description of the data exchange.
- display
Name 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.
- listing
Count Integer Number of listings contained in the data exchange.
- location 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"
- primary
Contact String Email or URL of the primary point of contact of the data exchange.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- 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.
- description string
Description of the data exchange.
- display
Name 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.
- listing
Count number Number of listings contained in the data exchange.
- location 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"
- primary
Contact string Email or URL of the primary point of contact of the data exchange.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- 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.
- 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 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 str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- 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.
- description String
Description of the data exchange.
- display
Name 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.
- listing
Count Number Number of listings contained in the data exchange.
- location 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"
- primary
Contact String Email or URL of the primary point of contact of the data exchange.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Import
DataExchange can be imported using any of these accepted formats
$ pulumi import gcp:bigqueryanalyticshub/dataExchange:DataExchange default projects/{{project}}/locations/{{location}}/dataExchanges/{{data_exchange_id}}
$ pulumi import gcp:bigqueryanalyticshub/dataExchange:DataExchange default {{project}}/{{location}}/{{data_exchange_id}}
$ pulumi import gcp:bigqueryanalyticshub/dataExchange:DataExchange default {{location}}/{{data_exchange_id}}
$ pulumi import gcp:bigqueryanalyticshub/dataExchange:DataExchange default {{data_exchange_id}}
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-betaTerraform Provider.