@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
337 lines • 12.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A data product is a curated collection of data assets, packaged to address
* specific use cases.
*
* > **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 DataProduct, see:
*
* * [API documentation](https://cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.dataProducts)
* * How-to Guides
* * [Introduction to Data Products](https://cloud.google.com/dataplex/docs/data-products-overview)
*
* ## Example Usage
*
* ### Dataplex Data Product 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: "data-product-basic",
* displayName: "terraform data product",
* ownerEmails: ["gterraformtestuser@gmail.com"],
* accessGroups: [{
* id: "analyst",
* groupId: "analyst",
* displayName: "Data Analyst",
* principal: {
* googleGroup: "tf-test-analysts-_79169@example.com",
* },
* }],
* });
* ```
* ### Dataplex Data Product 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: "data-product-full",
* displayName: "DP Full Test: Special Chars !@#$",
* description: "Updated with emojis 🚀 and brackets {test}",
* ownerEmails: ["gterraformtestuser@gmail.com"],
* labels: {
* env: "manual-test",
* },
* accessGroups: [
* {
* id: "analyst",
* groupId: "analyst",
* displayName: "Data Analyst - Updated",
* description: "In-place update verified",
* principal: {
* googleGroup: "tf-test-analysts-_56529@example.com",
* },
* },
* {
* id: "scientist",
* groupId: "scientist",
* displayName: "Data Scientist",
* principal: {
* googleGroup: "tf-test-scientists-_75413@example.com",
* },
* },
* ],
* });
* ```
*
* ## Import
*
* DataProduct can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/dataProducts/{{data_product_id}}`
* * `{{project}}/{{location}}/{{data_product_id}}`
* * `{{location}}/{{data_product_id}}`
*
* When using the `pulumi import` command, DataProduct can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:dataplex/dataProduct:DataProduct default projects/{{project}}/locations/{{location}}/dataProducts/{{data_product_id}}
* $ pulumi import gcp:dataplex/dataProduct:DataProduct default {{project}}/{{location}}/{{data_product_id}}
* $ pulumi import gcp:dataplex/dataProduct:DataProduct default {{location}}/{{data_product_id}}
* ```
*/
export declare class DataProduct extends pulumi.CustomResource {
/**
* Get an existing DataProduct 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?: DataProductState, opts?: pulumi.CustomResourceOptions): DataProduct;
/**
* Returns true if the given object is an instance of DataProduct. 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 DataProduct;
/**
* Custom user defined access groups at the data product level.
* Structure is documented below.
*/
readonly accessGroups: pulumi.Output<outputs.dataplex.DataProductAccessGroup[] | undefined>;
/**
* Number of associated data assets.
*/
readonly assetCount: pulumi.Output<number>;
/**
* Creation timestamp.
*/
readonly createTime: pulumi.Output<string>;
/**
* The ID of the 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>;
/**
* Description of the data product.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* User-friendly display name.
*/
readonly displayName: 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;
}>;
/**
* Checksum for concurrency control.
*/
readonly etag: pulumi.Output<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 product.
*/
readonly location: pulumi.Output<string>;
/**
* Emails of the owners.
*/
readonly ownerEmails: 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;
}>;
/**
* System generated unique ID.
*/
readonly uid: pulumi.Output<string>;
/**
* Last update timestamp.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a DataProduct 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: DataProductArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DataProduct resources.
*/
export interface DataProductState {
/**
* Custom user defined access groups at the data product level.
* Structure is documented below.
*/
accessGroups?: pulumi.Input<pulumi.Input<inputs.dataplex.DataProductAccessGroup>[] | undefined>;
/**
* Number of associated data assets.
*/
assetCount?: pulumi.Input<number | undefined>;
/**
* Creation timestamp.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* The ID of the 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>;
/**
* Description of the data product.
*/
description?: pulumi.Input<string | undefined>;
/**
* User-friendly display name.
*/
displayName?: 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>;
/**
* Checksum for concurrency control.
*/
etag?: 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 product.
*/
location?: pulumi.Input<string | undefined>;
/**
* Emails of the owners.
*/
ownerEmails?: pulumi.Input<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>;
/**
* System generated unique ID.
*/
uid?: pulumi.Input<string | undefined>;
/**
* Last update timestamp.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a DataProduct resource.
*/
export interface DataProductArgs {
/**
* Custom user defined access groups at the data product level.
* Structure is documented below.
*/
accessGroups?: pulumi.Input<pulumi.Input<inputs.dataplex.DataProductAccessGroup>[] | undefined>;
/**
* The ID of the 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>;
/**
* Description of the data product.
*/
description?: pulumi.Input<string | undefined>;
/**
* User-friendly display name.
*/
displayName: pulumi.Input<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.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The location for the data product.
*/
location: pulumi.Input<string>;
/**
* Emails of the owners.
*/
ownerEmails: pulumi.Input<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>;
}
//# sourceMappingURL=dataProduct.d.ts.map