Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. analyticshub
  5. analyticshub/v1
  6. DataExchange

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.analyticshub/v1.DataExchange

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a new data exchange. Auto-naming is currently not supported for this resource.

    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,
                 description: Optional[str] = None,
                 documentation: Optional[str] = None,
                 icon: Optional[str] = None,
                 location: Optional[str] = None,
                 primary_contact: Optional[str] = None,
                 project: Optional[str] = None,
                 sharing_environment_config: Optional[SharingEnvironmentConfigArgs] = 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: google-native:analyticshub/v1: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.

    Constructor example

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

    var dataExchangeResource = new GoogleNative.AnalyticsHub.V1.DataExchange("dataExchangeResource", new()
{
    DataExchangeId = "string",
    DisplayName = "string",
    Description = "string",
    Documentation = "string",
    Icon = "string",
    Location = "string",
    PrimaryContact = "string",
    Project = "string",
    SharingEnvironmentConfig = new GoogleNative.AnalyticsHub.V1.Inputs.SharingEnvironmentConfigArgs
    {
        DcrExchangeConfig = null,
        DefaultExchangeConfig = null,
    },
});

    example, err := analyticshub.NewDataExchange(ctx, "dataExchangeResource", &analyticshub.DataExchangeArgs{
	DataExchangeId: pulumi.String("string"),
	DisplayName:    pulumi.String("string"),
	Description:    pulumi.String("string"),
	Documentation:  pulumi.String("string"),
	Icon:           pulumi.String("string"),
	Location:       pulumi.String("string"),
	PrimaryContact: pulumi.String("string"),
	Project:        pulumi.String("string"),
	SharingEnvironmentConfig: &analyticshub.SharingEnvironmentConfigArgs{
		DcrExchangeConfig:     &analyticshub.DcrExchangeConfigArgs{},
		DefaultExchangeConfig: &analyticshub.DefaultExchangeConfigArgs{},
	},
})

    var dataExchangeResource = new DataExchange("dataExchangeResource", DataExchangeArgs.builder()
    .dataExchangeId("string")
    .displayName("string")
    .description("string")
    .documentation("string")
    .icon("string")
    .location("string")
    .primaryContact("string")
    .project("string")
    .sharingEnvironmentConfig(SharingEnvironmentConfigArgs.builder()
        .dcrExchangeConfig()
        .defaultExchangeConfig()
        .build())
    .build());

    data_exchange_resource = google_native.analyticshub.v1.DataExchange("dataExchangeResource",
    data_exchange_id="string",
    display_name="string",
    description="string",
    documentation="string",
    icon="string",
    location="string",
    primary_contact="string",
    project="string",
    sharing_environment_config={
        "dcr_exchange_config": {},
        "default_exchange_config": {},
    })

    const dataExchangeResource = new google_native.analyticshub.v1.DataExchange("dataExchangeResource", {
    dataExchangeId: "string",
    displayName: "string",
    description: "string",
    documentation: "string",
    icon: "string",
    location: "string",
    primaryContact: "string",
    project: "string",
    sharingEnvironmentConfig: {
        dcrExchangeConfig: {},
        defaultExchangeConfig: {},
    },
});

    type: google-native:analyticshub/v1:DataExchange
properties:
    dataExchangeId: string
    description: string
    displayName: string
    documentation: string
    icon: string
    location: string
    primaryContact: string
    project: string
    sharingEnvironmentConfig:
        dcrExchangeConfig: {}
        defaultExchangeConfig: {}

    DataExchange Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DataExchange resource accepts the following input properties:

    DataExchangeId string
    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. Max length: 100 bytes.
    DisplayName string
    Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
    Description string
    Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
    Documentation string
    Optional. Documentation describing the data exchange.
    Icon string
    Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
    Location string
    PrimaryContact string
    Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
    Project string
    SharingEnvironmentConfig Pulumi.GoogleNative.AnalyticsHub.V1.Inputs.SharingEnvironmentConfig
    Optional. Configurable data sharing environment option for a data exchange.
    DataExchangeId string
    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. Max length: 100 bytes.
    DisplayName string
    Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
    Description string
    Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
    Documentation string
    Optional. Documentation describing the data exchange.
    Icon string
    Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
    Location string
    PrimaryContact string
    Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
    Project string
    SharingEnvironmentConfig SharingEnvironmentConfigArgs
    Optional. Configurable data sharing environment option for a data exchange.
    dataExchangeId String
    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. Max length: 100 bytes.
    displayName String
    Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
    description String
    Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
    documentation String
    Optional. Documentation describing the data exchange.
    icon String
    Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
    location String
    primaryContact String
    Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
    project String
    sharingEnvironmentConfig SharingEnvironmentConfig
    Optional. Configurable data sharing environment option for a data exchange.
    dataExchangeId string
    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. Max length: 100 bytes.
    displayName string
    Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
    description string
    Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
    documentation string
    Optional. Documentation describing the data exchange.
    icon string
    Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
    location string
    primaryContact string
    Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
    project string
    sharingEnvironmentConfig SharingEnvironmentConfig
    Optional. Configurable data sharing environment option for a data exchange.
    data_exchange_id str
    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. Max length: 100 bytes.
    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 ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
    description str
    Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
    documentation str
    Optional. Documentation describing the data exchange.
    icon str
    Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
    location str
    primary_contact str
    Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
    project str
    sharing_environment_config SharingEnvironmentConfigArgs
    Optional. Configurable data sharing environment option for a data exchange.
    dataExchangeId String
    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. Max length: 100 bytes.
    displayName String
    Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
    description String
    Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
    documentation String
    Optional. Documentation describing the data exchange.
    icon String
    Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
    location String
    primaryContact String
    Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
    project String
    sharingEnvironmentConfig Property Map
    Optional. Configurable data sharing environment option for a data exchange.

    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. e.g. 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. e.g. 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. e.g. 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. e.g. 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. e.g. 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. e.g. projects/myproject/locations/US/dataExchanges/123.

    Supporting Types

    SharingEnvironmentConfig, SharingEnvironmentConfigArgs

    DcrExchangeConfig Pulumi.GoogleNative.AnalyticsHub.V1.Inputs.DcrExchangeConfig
    Data Clean Room (DCR), used for privacy-safe and secured data sharing.
    DefaultExchangeConfig Pulumi.GoogleNative.AnalyticsHub.V1.Inputs.DefaultExchangeConfig
    Default Analytics Hub data exchange, used for secured data sharing.
    DcrExchangeConfig DcrExchangeConfig
    Data Clean Room (DCR), used for privacy-safe and secured data sharing.
    DefaultExchangeConfig DefaultExchangeConfig
    Default Analytics Hub data exchange, used for secured data sharing.
    dcrExchangeConfig DcrExchangeConfig
    Data Clean Room (DCR), used for privacy-safe and secured data sharing.
    defaultExchangeConfig DefaultExchangeConfig
    Default Analytics Hub data exchange, used for secured data sharing.
    dcrExchangeConfig DcrExchangeConfig
    Data Clean Room (DCR), used for privacy-safe and secured data sharing.
    defaultExchangeConfig DefaultExchangeConfig
    Default Analytics Hub data exchange, used for secured data sharing.
    dcr_exchange_config DcrExchangeConfig
    Data Clean Room (DCR), used for privacy-safe and secured data sharing.
    default_exchange_config DefaultExchangeConfig
    Default Analytics Hub data exchange, used for secured data sharing.
    dcrExchangeConfig Property Map
    Data Clean Room (DCR), used for privacy-safe and secured data sharing.
    defaultExchangeConfig Property Map
    Default Analytics Hub data exchange, used for secured data sharing.

    SharingEnvironmentConfigResponse, SharingEnvironmentConfigResponseArgs

    DcrExchangeConfig Pulumi.GoogleNative.AnalyticsHub.V1.Inputs.DcrExchangeConfigResponse
    Data Clean Room (DCR), used for privacy-safe and secured data sharing.
    DefaultExchangeConfig Pulumi.GoogleNative.AnalyticsHub.V1.Inputs.DefaultExchangeConfigResponse
    Default Analytics Hub data exchange, used for secured data sharing.
    DcrExchangeConfig DcrExchangeConfigResponse
    Data Clean Room (DCR), used for privacy-safe and secured data sharing.
    DefaultExchangeConfig DefaultExchangeConfigResponse
    Default Analytics Hub data exchange, used for secured data sharing.
    dcrExchangeConfig DcrExchangeConfigResponse
    Data Clean Room (DCR), used for privacy-safe and secured data sharing.
    defaultExchangeConfig DefaultExchangeConfigResponse
    Default Analytics Hub data exchange, used for secured data sharing.
    dcrExchangeConfig DcrExchangeConfigResponse
    Data Clean Room (DCR), used for privacy-safe and secured data sharing.
    defaultExchangeConfig DefaultExchangeConfigResponse
    Default Analytics Hub data exchange, used for secured data sharing.
    dcr_exchange_config DcrExchangeConfigResponse
    Data Clean Room (DCR), used for privacy-safe and secured data sharing.
    default_exchange_config DefaultExchangeConfigResponse
    Default Analytics Hub data exchange, used for secured data sharing.
    dcrExchangeConfig Property Map
    Data Clean Room (DCR), used for privacy-safe and secured data sharing.
    defaultExchangeConfig Property Map
    Default Analytics Hub data exchange, used for secured data sharing.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native