1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. bigqueryanalyticshub
  5. DataExchange
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

gcp.bigqueryanalyticshub.DataExchange

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi

    A Bigquery Analytics Hub data exchange

    To get more information about DataExchange, see:

    Example Usage

    Bigquery Analyticshub Data Exchange Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const dataExchange = new gcp.bigqueryanalyticshub.DataExchange("data_exchange", {
        location: "US",
        dataExchangeId: "my_data_exchange",
        displayName: "my_data_exchange",
        description: "example data exchange",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    data_exchange = gcp.bigqueryanalyticshub.DataExchange("data_exchange",
        location="US",
        data_exchange_id="my_data_exchange",
        display_name="my_data_exchange",
        description="example data exchange")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/bigqueryanalyticshub"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := bigqueryanalyticshub.NewDataExchange(ctx, "data_exchange", &bigqueryanalyticshub.DataExchangeArgs{
    			Location:       pulumi.String("US"),
    			DataExchangeId: pulumi.String("my_data_exchange"),
    			DisplayName:    pulumi.String("my_data_exchange"),
    			Description:    pulumi.String("example data exchange"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var dataExchange = new Gcp.BigQueryAnalyticsHub.DataExchange("data_exchange", new()
        {
            Location = "US",
            DataExchangeId = "my_data_exchange",
            DisplayName = "my_data_exchange",
            Description = "example data exchange",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.bigqueryanalyticshub.DataExchange;
    import com.pulumi.gcp.bigqueryanalyticshub.DataExchangeArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var dataExchange = new DataExchange("dataExchange", DataExchangeArgs.builder()
                .location("US")
                .dataExchangeId("my_data_exchange")
                .displayName("my_data_exchange")
                .description("example data exchange")
                .build());
    
        }
    }
    
    resources:
      dataExchange:
        type: gcp:bigqueryanalyticshub:DataExchange
        name: data_exchange
        properties:
          location: US
          dataExchangeId: my_data_exchange
          displayName: my_data_exchange
          description: example data exchange
    

    Create DataExchange Resource

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

    Constructor syntax

    new DataExchange(name: string, args: DataExchangeArgs, opts?: CustomResourceOptions);
    @overload
    def DataExchange(resource_name: str,
                     args: DataExchangeArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def DataExchange(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     data_exchange_id: Optional[str] = None,
                     display_name: Optional[str] = None,
                     location: Optional[str] = None,
                     description: Optional[str] = None,
                     documentation: Optional[str] = None,
                     icon: Optional[str] = None,
                     primary_contact: Optional[str] = None,
                     project: Optional[str] = None)
    func NewDataExchange(ctx *Context, name string, args DataExchangeArgs, opts ...ResourceOption) (*DataExchange, error)
    public DataExchange(string name, DataExchangeArgs args, CustomResourceOptions? opts = null)
    public DataExchange(String name, DataExchangeArgs args)
    public DataExchange(String name, DataExchangeArgs args, CustomResourceOptions options)
    
    type: gcp:bigqueryanalyticshub:DataExchange
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name 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.

    Example

    The following reference example uses placeholder values for all input properties.

    var dataExchangeResource = new Gcp.BigQueryAnalyticsHub.DataExchange("dataExchangeResource", new()
    {
        DataExchangeId = "string",
        DisplayName = "string",
        Location = "string",
        Description = "string",
        Documentation = "string",
        Icon = "string",
        PrimaryContact = "string",
        Project = "string",
    });
    
    example, err := bigqueryanalyticshub.NewDataExchange(ctx, "dataExchangeResource", &bigqueryanalyticshub.DataExchangeArgs{
    	DataExchangeId: pulumi.String("string"),
    	DisplayName:    pulumi.String("string"),
    	Location:       pulumi.String("string"),
    	Description:    pulumi.String("string"),
    	Documentation:  pulumi.String("string"),
    	Icon:           pulumi.String("string"),
    	PrimaryContact: pulumi.String("string"),
    	Project:        pulumi.String("string"),
    })
    
    var dataExchangeResource = new DataExchange("dataExchangeResource", DataExchangeArgs.builder()
        .dataExchangeId("string")
        .displayName("string")
        .location("string")
        .description("string")
        .documentation("string")
        .icon("string")
        .primaryContact("string")
        .project("string")
        .build());
    
    data_exchange_resource = gcp.bigqueryanalyticshub.DataExchange("dataExchangeResource",
        data_exchange_id="string",
        display_name="string",
        location="string",
        description="string",
        documentation="string",
        icon="string",
        primary_contact="string",
        project="string")
    
    const dataExchangeResource = new gcp.bigqueryanalyticshub.DataExchange("dataExchangeResource", {
        dataExchangeId: "string",
        displayName: "string",
        location: "string",
        description: "string",
        documentation: "string",
        icon: "string",
        primaryContact: "string",
        project: "string",
    });
    
    type: gcp:bigqueryanalyticshub:DataExchange
    properties:
        dataExchangeId: string
        description: string
        displayName: string
        documentation: string
        icon: string
        location: string
        primaryContact: string
        project: string
    

    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:

    DataExchangeId string
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    DisplayName 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.
    PrimaryContact 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.
    DataExchangeId string
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    DisplayName 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.
    PrimaryContact 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.
    dataExchangeId String
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    displayName 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.
    primaryContact 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.
    dataExchangeId string
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    displayName 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.
    primaryContact 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_id str
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    display_name 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.
    dataExchangeId String
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    displayName 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.
    primaryContact 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.
    ListingCount int
    Number of listings contained in the data exchange.
    Name string
    The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
    Id string
    The provider-assigned unique ID for this managed resource.
    ListingCount int
    Number of listings contained in the data exchange.
    Name string
    The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
    id String
    The provider-assigned unique ID for this managed resource.
    listingCount Integer
    Number of listings contained in the data exchange.
    name String
    The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
    id string
    The provider-assigned unique ID for this managed resource.
    listingCount number
    Number of listings contained in the data exchange.
    name string
    The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
    id str
    The provider-assigned unique ID for this managed resource.
    listing_count int
    Number of listings contained in the data exchange.
    name str
    The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
    id String
    The provider-assigned unique ID for this managed resource.
    listingCount Number
    Number of listings contained in the data exchange.
    name String
    The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"

    Look up Existing DataExchange Resource

    Get an existing DataExchange resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DataExchangeState, opts?: CustomResourceOptions): DataExchange
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            data_exchange_id: Optional[str] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            documentation: Optional[str] = None,
            icon: Optional[str] = None,
            listing_count: Optional[int] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            primary_contact: Optional[str] = None,
            project: Optional[str] = None) -> DataExchange
    func GetDataExchange(ctx *Context, name string, id IDInput, state *DataExchangeState, opts ...ResourceOption) (*DataExchange, error)
    public static DataExchange Get(string name, Input<string> id, DataExchangeState? state, CustomResourceOptions? opts = null)
    public static DataExchange get(String name, Output<String> id, DataExchangeState state, CustomResourceOptions options)
    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.
    The following state arguments are supported:
    DataExchangeId string
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    Description string
    Description of the data exchange.
    DisplayName string
    Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.


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


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


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


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


    documentation str
    Documentation describing the data exchange.
    icon str
    Base64 encoded image representing the data exchange.
    listing_count int
    Number of listings contained in the data exchange.
    location 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.
    dataExchangeId String
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    description String
    Description of the data exchange.
    displayName String
    Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and must not start or end with spaces.


    documentation String
    Documentation describing the data exchange.
    icon String
    Base64 encoded image representing the data exchange.
    listingCount Number
    Number of listings contained in the data exchange.
    location String
    The name of the location this data exchange.
    name String
    The resource name of the data exchange, for example: "projects/myproject/locations/US/dataExchanges/123"
    primaryContact String
    Email or URL of the primary point of contact of the data exchange.
    project 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:

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

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

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

    • {{data_exchange_id}}

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

    $ pulumi import gcp:bigqueryanalyticshub/dataExchange:DataExchange default projects/{{project}}/locations/{{location}}/dataExchanges/{{data_exchange_id}}
    
    $ 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}}
    

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

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.27.0 published on Thursday, Jun 13, 2024 by Pulumi