@pulumi/databricks/entityTagAssignment.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * [![Public Preview](https://img.shields.io/badge/Release_Stage-Public_Preview-yellowgreen)](https://docs.databricks.com/aws/en/release-notes/release-types)
 *
 * This resource allows you to create, update, list, and delete tag assignments on Unity Catalog entities.
 *
 * ## Example Usage
 *
 * ### Basic tag assignment to a catalog
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const catalogTag = new databricks.EntityTagAssignment("catalog_tag", {
 *     entityType: "catalogs",
 *     entityName: "production_catalog",
 *     tagKey: "environment",
 *     tagValue: "production",
 * });
 * const schemaTag = new databricks.EntityTagAssignment("schema_tag", {
 *     entityType: "schemas",
 *     entityName: "production_catalog.sales_data",
 *     tagKey: "owner",
 *     tagValue: "sales-team",
 * });
 * const tableTag = new databricks.EntityTagAssignment("table_tag", {
 *     entityType: "tables",
 *     entityName: "production_catalog.sales_data.customer_orders",
 *     tagKey: "data_classification",
 *     tagValue: "confidential",
 * });
 * const columnTag = new databricks.EntityTagAssignment("column_tag", {
 *     entityType: "columns",
 *     entityName: "production_catalog.sales_data.customers.email_address",
 *     tagKey: "pii",
 *     tagValue: "email",
 * });
 * const volumeTag = new databricks.EntityTagAssignment("volume_tag", {
 *     entityType: "volumes",
 *     entityName: "production_catalog.raw_data.landing_zone",
 *     tagKey: "purpose",
 *     tagValue: "data_ingestion",
 * });
 * ```
 *
 * ## Import
 *
 * As of Pulumi v1.5, resources can be imported through configuration.
 *
 * hcl
 *
 * import {
 *
 *   id = "entity_type,entity_name,tag_key"
 *
 *   to = databricks_entity_tag_assignment.this
 *
 * }
 *
 * If you are using an older version of Pulumi, import the resource using the `pulumi import` command as follows:
 *
 * ```sh
 * $ pulumi import databricks:index/entityTagAssignment:EntityTagAssignment this "entity_type,entity_name,tag_key"
 * ```
 */
export declare class EntityTagAssignment extends pulumi.CustomResource {
    /**
     * Get an existing EntityTagAssignment 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?: EntityTagAssignmentState, opts?: pulumi.CustomResourceOptions): EntityTagAssignment;
    /**
     * Returns true if the given object is an instance of EntityTagAssignment.  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 EntityTagAssignment;
    /**
     * The fully qualified name of the entity to which the tag is assigned
     */
    readonly entityName: pulumi.Output<string>;
    /**
     * The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
     */
    readonly entityType: pulumi.Output<string>;
    /**
     * The key of the tag
     */
    readonly tagKey: pulumi.Output<string>;
    /**
     * The value of the tag
     */
    readonly tagValue: pulumi.Output<string | undefined>;
    /**
     * Create a EntityTagAssignment 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: EntityTagAssignmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering EntityTagAssignment resources.
 */
export interface EntityTagAssignmentState {
    /**
     * The fully qualified name of the entity to which the tag is assigned
     */
    entityName?: pulumi.Input<string>;
    /**
     * The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
     */
    entityType?: pulumi.Input<string>;
    /**
     * The key of the tag
     */
    tagKey?: pulumi.Input<string>;
    /**
     * The value of the tag
     */
    tagValue?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a EntityTagAssignment resource.
 */
export interface EntityTagAssignmentArgs {
    /**
     * The fully qualified name of the entity to which the tag is assigned
     */
    entityName: pulumi.Input<string>;
    /**
     * The type of the entity to which the tag is assigned. Allowed values are: catalogs, schemas, tables, columns, volumes
     */
    entityType: pulumi.Input<string>;
    /**
     * The key of the tag
     */
    tagKey: pulumi.Input<string>;
    /**
     * The value of the tag
     */
    tagValue?: pulumi.Input<string>;
}