Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. analyticshub
  5. analyticshub/v1beta1
  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/v1beta1.DataExchange

Explore with Pulumi AI

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)
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/v1beta1:DataExchange
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DataExchangeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. DataExchangeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DataExchangeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 google_nativeDataExchangeResource = new GoogleNative.AnalyticsHub.V1Beta1.DataExchange("google-nativeDataExchangeResource", new()
{
    DataExchangeId = "string",
    DisplayName = "string",
    Description = "string",
    Documentation = "string",
    Icon = "string",
    Location = "string",
    PrimaryContact = "string",
    Project = "string",
});
Copy
example, err := analyticshubv1beta1.NewDataExchange(ctx, "google-nativeDataExchangeResource", &analyticshubv1beta1.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"),
})
Copy
var google_nativeDataExchangeResource = new DataExchange("google-nativeDataExchangeResource", DataExchangeArgs.builder()
    .dataExchangeId("string")
    .displayName("string")
    .description("string")
    .documentation("string")
    .icon("string")
    .location("string")
    .primaryContact("string")
    .project("string")
    .build());
Copy
google_native_data_exchange_resource = google_native.analyticshub.v1beta1.DataExchange("google-nativeDataExchangeResource",
    data_exchange_id="string",
    display_name="string",
    description="string",
    documentation="string",
    icon="string",
    location="string",
    primary_contact="string",
    project="string")
Copy
const google_nativeDataExchangeResource = new google_native.analyticshub.v1beta1.DataExchange("google-nativeDataExchangeResource", {
    dataExchangeId: "string",
    displayName: "string",
    description: "string",
    documentation: "string",
    icon: "string",
    location: "string",
    primaryContact: "string",
    project: "string",
});
Copy
type: google-native:analyticshub/v1beta1:DataExchange
properties:
    dataExchangeId: string
    description: string
    displayName: string
    documentation: string
    icon: string
    location: string
    primaryContact: string
    project: string
Copy

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
This property is required.
Changes to this property will trigger replacement.
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 This property is required. 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 Changes to this property will trigger replacement. string
PrimaryContact string
Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
Project Changes to this property will trigger replacement. string
DataExchangeId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. 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 Changes to this property will trigger replacement. string
PrimaryContact string
Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
Project Changes to this property will trigger replacement. string
dataExchangeId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. 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 Changes to this property will trigger replacement. String
primaryContact String
Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
project Changes to this property will trigger replacement. String
dataExchangeId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. 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 Changes to this property will trigger replacement. string
primaryContact string
Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
project Changes to this property will trigger replacement. string
data_exchange_id
This property is required.
Changes to this property will trigger replacement.
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 This property is required. 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 Changes to this property will trigger replacement. str
primary_contact str
Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
project Changes to this property will trigger replacement. str
dataExchangeId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. 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 Changes to this property will trigger replacement. String
primaryContact String
Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
project Changes to this property will trigger replacement. String

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.

Package Details

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

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