import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * A data asset resource that can be packaged and shared via a data product. * * > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider. * See Provider Versions for more details on beta resources. * * To get more information about DataAsset, see: * * * [API documentation](https://cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.dataProducts.dataAssets) * * How-to Guides * * [Official Documentation](https://cloud.google.com/dataplex/docs) * * ## Example Usage * * ### Dataplex Data Asset Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example = new gcp.dataplex.DataProduct("example", { * project: "my-project-name", * location: "us-central1", * dataProductId: "tf-test-dp-_95154", * displayName: "Parent Data Product", * ownerEmails: ["gterraformtestuser@gmail.com"], * accessGroups: [{ * id: "analyst", * groupId: "analyst", * displayName: "Data Analyst", * principal: { * googleGroup: "tf-test-analysts-_64336@example.com", * }, * }], * }); * const exampleDataset = new gcp.bigquery.Dataset("example", { * project: "my-project-name", * datasetId: "tf_test_dataset__34962", * location: "us-central1", * }); * const exampleDataAsset = new gcp.dataplex.DataAsset("example", { * project: "my-project-name", * location: "us-central1", * dataProductId: example.dataProductId, * dataAssetId: "data-asset", * resource: pulumi.interpolate`//bigquery.googleapis.com/projects/${exampleDataset.project}/datasets/${exampleDataset.datasetId}`, * }); * ``` * ### Dataplex Data Asset Full * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example = new gcp.dataplex.DataProduct("example", { * project: "my-project-name", * location: "us-central1", * dataProductId: "tf-test-dp-_74000", * displayName: "Full Example Parent DP", * ownerEmails: ["gterraformtestuser@gmail.com"], * accessGroups: [ * { * id: "analyst", * groupId: "analyst", * displayName: "Data Analyst", * principal: { * googleGroup: "dataproduct-terraform-examples@google.com", * }, * }, * { * id: "scientist", * groupId: "scientist", * displayName: "Data Scientist", * principal: { * googleGroup: "dataproduct-terraform-examples-2@google.com", * }, * }, * ], * }); * const exampleDataset = new gcp.bigquery.Dataset("example", { * project: "my-project-name", * datasetId: "tf_test_dataset__75125", * location: "us-central1", * }); * const exampleDataAsset = new gcp.dataplex.DataAsset("example", { * project: "my-project-name", * location: "us-central1", * dataProductId: example.dataProductId, * dataAssetId: "data-asset", * resource: pulumi.interpolate`//bigquery.googleapis.com/projects/${exampleDataset.project}/datasets/${exampleDataset.datasetId}`, * labels: { * env: "prod", * critical: "true", * }, * accessGroupConfigs: [ * { * accessGroup: "analyst", * iamRoles: ["roles/bigquery.dataViewer"], * }, * { * accessGroup: "scientist", * iamRoles: ["roles/bigquery.dataEditor"], * }, * ], * }); * ``` * * ## Import * * DataAsset can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/dataProducts/{{data_product_id}}/dataAssets/{{data_asset_id}}` * * `{{project}}/{{location}}/{{data_product_id}}/{{data_asset_id}}` * * `{{location}}/{{data_product_id}}/{{data_asset_id}}` * * When using the `pulumi import` command, DataAsset can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:dataplex/dataAsset:DataAsset default projects/{{project}}/locations/{{location}}/dataProducts/{{data_product_id}}/dataAssets/{{data_asset_id}} * $ pulumi import gcp:dataplex/dataAsset:DataAsset default {{project}}/{{location}}/{{data_product_id}}/{{data_asset_id}} * $ pulumi import gcp:dataplex/dataAsset:DataAsset default {{location}}/{{data_product_id}}/{{data_asset_id}} * ``` */ export declare class DataAsset extends pulumi.CustomResource { /** * Get an existing DataAsset resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: DataAssetState, opts?: pulumi.CustomResourceOptions): DataAsset; /** * Returns true if the given object is an instance of DataAsset. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is DataAsset; /** * Access groups configurations. * Structure is documented below. */ readonly accessGroupConfigs: pulumi.Output; /** * The ID of the data asset. */ readonly dataAssetId: pulumi.Output; /** * The ID of the parent data product. */ readonly dataProductId: pulumi.Output; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ readonly effectiveLabels: pulumi.Output<{ [key: string]: string; }>; /** * User-defined labels. * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ readonly labels: pulumi.Output<{ [key: string]: string; } | undefined>; /** * The location for the data asset. */ readonly location: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * Full resource name of the cloud resource. */ readonly resource: pulumi.Output; /** * System generated unique ID. */ readonly uid: pulumi.Output; /** * Create a DataAsset resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: DataAssetArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering DataAsset resources. */ export interface DataAssetState { /** * Access groups configurations. * Structure is documented below. */ accessGroupConfigs?: pulumi.Input[]>; /** * The ID of the data asset. */ dataAssetId?: pulumi.Input; /** * The ID of the parent data product. */ dataProductId?: pulumi.Input; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ effectiveLabels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * User-defined labels. * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * The location for the data asset. */ location?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Full resource name of the cloud resource. */ resource?: pulumi.Input; /** * System generated unique ID. */ uid?: pulumi.Input; } /** * The set of arguments for constructing a DataAsset resource. */ export interface DataAssetArgs { /** * Access groups configurations. * Structure is documented below. */ accessGroupConfigs?: pulumi.Input[]>; /** * The ID of the data asset. */ dataAssetId: pulumi.Input; /** * The ID of the parent data product. */ dataProductId: pulumi.Input; /** * User-defined labels. * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * The location for the data asset. */ location: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * Full resource name of the cloud resource. */ resource: pulumi.Input; }