@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
327 lines • 12.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* > **Warning:** `gcp.dataplex.DataAsset` is deprecated and will be removed in a future major release. Please use `gcp.dataplex.DataProductDataAsset` resource instead.
*
* 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-_22375",
* displayName: "Parent Data Product",
* ownerEmails: ["gterraformtestuser@gmail.com"],
* accessGroups: [{
* id: "analyst",
* groupId: "analyst",
* displayName: "Data Analyst",
* principal: {
* googleGroup: "tf-test-analysts-_29439@example.com",
* },
* }],
* });
* const exampleDataset = new gcp.bigquery.Dataset("example", {
* project: "my-project-name",
* datasetId: "tf_test_dataset__87786",
* 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-_2067",
* 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__40785",
* 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<pulumi.ID>, 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<outputs.dataplex.DataAssetAccessGroupConfig[] | undefined>;
/**
* The ID of the data asset.
*/
readonly dataAssetId: pulumi.Output<string>;
/**
* The ID of the parent data product.
*/
readonly dataProductId: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* 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<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* 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<string>;
/**
* System generated unique ID.
*/
readonly uid: pulumi.Output<string>;
/**
* 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<pulumi.Input<inputs.dataplex.DataAssetAccessGroupConfig>[] | undefined>;
/**
* The ID of the data asset.
*/
dataAssetId?: pulumi.Input<string | undefined>;
/**
* The ID of the parent data product.
*/
dataProductId?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* 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<string>;
} | undefined>;
/**
* 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<string>;
} | undefined>;
/**
* The location for the data asset.
*/
location?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Full resource name of the cloud resource.
*/
resource?: pulumi.Input<string | undefined>;
/**
* System generated unique ID.
*/
uid?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a DataAsset resource.
*/
export interface DataAssetArgs {
/**
* Access groups configurations.
* Structure is documented below.
*/
accessGroupConfigs?: pulumi.Input<pulumi.Input<inputs.dataplex.DataAssetAccessGroupConfig>[] | undefined>;
/**
* The ID of the data asset.
*/
dataAssetId: pulumi.Input<string>;
/**
* The ID of the parent data product.
*/
dataProductId: pulumi.Input<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* 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<string>;
} | undefined>;
/**
* The location for the data asset.
*/
location: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* Full resource name of the cloud resource.
*/
resource: pulumi.Input<string>;
}
//# sourceMappingURL=dataAsset.d.ts.map