@pulumi/gcp/datalineage/config.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Configuration for Data Lineage.
 *
 * Defines configuration options for Lineage customers to control behavior of
 * lineage systems.
 *
 * To get more information about Config, see:
 *
 * * [API documentation](https://docs.cloud.google.com/dataplex/docs/reference/data-lineage/rest/v1/folders.locations.config)
 * * How-to Guides
 *     * [Official Documentation](https://docs.cloud.google.com/dataplex/docs/about-data-lineage#control-lineage-ingestion)
 *
 * ## Example Usage
 *
 * ### Data Lineage Config Project
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * import * as time from "@pulumiverse/time";
 *
 * const project = new gcp.organizations.Project("project", {
 *     projectId: "tf-test_16511",
 *     name: "tf-test_8493",
 *     orgId: "123456789",
 *     deletionPolicy: "DELETE",
 * });
 * const waitForProject = new time.Sleep("wait_for_project", {createDuration: "60s"}, {
 *     dependsOn: [project],
 * });
 * const datalineageApi = new gcp.projects.Service("datalineage_api", {
 *     project: project.projectId,
 *     service: "datalineage.googleapis.com",
 * }, {
 *     dependsOn: [waitForProject],
 * });
 * const _default = new gcp.datalineage.Config("default", {
 *     parent: pulumi.interpolate`projects/${project.projectId}`,
 *     location: "global",
 *     ingestion: {
 *         rules: [{
 *             integrationSelector: {
 *                 integration: "DATAPROC",
 *             },
 *             lineageEnablement: {
 *                 enabled: true,
 *             },
 *         }],
 *     },
 * }, {
 *     dependsOn: [datalineageApi],
 * });
 * ```
 * ### Data Lineage Config Folder
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * import * as time from "@pulumiverse/time";
 *
 * const integration = new gcp.organizations.Folder("integration", {
 *     displayName: "config-f",
 *     parent: "organizations/123456789",
 *     deletionProtection: false,
 * });
 * const datalineageAdmin = new gcp.folder.IAMMember("datalineage_admin", {
 *     folder: integration.folderId,
 *     role: "roles/datalineage.admin",
 *     member: "serviceAccount:my@service-account.com",
 * });
 * const waitForFolderIam = new time.Sleep("wait_for_folder_iam", {createDuration: "60s"}, {
 *     dependsOn: [datalineageAdmin],
 * });
 * const _default = new gcp.datalineage.Config("default", {
 *     parent: integration.name,
 *     location: "global",
 *     ingestion: {
 *         rules: [{
 *             integrationSelector: {
 *                 integration: "DATAPROC",
 *             },
 *             lineageEnablement: {
 *                 enabled: true,
 *             },
 *         }],
 *     },
 * }, {
 *     dependsOn: [waitForFolderIam],
 * });
 * ```
 * ### Data Lineage Config Organization
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const _default = new gcp.datalineage.Config("default", {
 *     parent: "organizations/123456789",
 *     location: "global",
 *     ingestion: {
 *         rules: [{
 *             integrationSelector: {
 *                 integration: "LOOKER_CORE",
 *             },
 *             lineageEnablement: {
 *                 enabled: true,
 *             },
 *         }],
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * Config can be imported using any of these accepted formats:
 *
 * * `{{parent}}/locations/{{location}}/config`
 *
 * When using the `pulumi import` command, Config can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:datalineage/config:Config default {{parent}}/locations/{{location}}/config
 * ```
 */
export declare class Config extends pulumi.CustomResource {
    /**
     * Get an existing Config 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?: ConfigState, opts?: pulumi.CustomResourceOptions): Config;
    /**
     * Returns true if the given object is an instance of Config.  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 Config;
    /**
     * 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>;
    /**
     * Used for optimistic concurrency control when patching config.
     */
    readonly etag: pulumi.Output<string>;
    /**
     * Defines how Lineage should be ingested for this resource.
     * Structure is documented below.
     */
    readonly ingestion: pulumi.Output<outputs.datalineage.ConfigIngestion>;
    /**
     * The region of the data lineage configuration for integration.
     */
    readonly location: pulumi.Output<string>;
    /**
     * Identifier. The resource name of the config.
     * Format: organizations/{organization_id}/locations/{location}/config,
     * folders/{folder_id}/locations/{location}/config,
     * projects/{project_id}/locations/{location}/config,
     * or projects/{project_number}/locations/{location}/config.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Parent scope for the config.
     * Format: projects/{project-id|project-number} or folders/{folder-number} or organizations/{organization-number}.
     */
    readonly parent: pulumi.Output<string>;
    /**
     * Create a Config 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: ConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Config resources.
 */
export interface ConfigState {
    /**
     * 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>;
    /**
     * Used for optimistic concurrency control when patching config.
     */
    etag?: pulumi.Input<string | undefined>;
    /**
     * Defines how Lineage should be ingested for this resource.
     * Structure is documented below.
     */
    ingestion?: pulumi.Input<inputs.datalineage.ConfigIngestion | undefined>;
    /**
     * The region of the data lineage configuration for integration.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * Identifier. The resource name of the config.
     * Format: organizations/{organization_id}/locations/{location}/config,
     * folders/{folder_id}/locations/{location}/config,
     * projects/{project_id}/locations/{location}/config,
     * or projects/{project_number}/locations/{location}/config.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Parent scope for the config.
     * Format: projects/{project-id|project-number} or folders/{folder-number} or organizations/{organization-number}.
     */
    parent?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a Config resource.
 */
export interface ConfigArgs {
    /**
     * 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>;
    /**
     * Defines how Lineage should be ingested for this resource.
     * Structure is documented below.
     */
    ingestion: pulumi.Input<inputs.datalineage.ConfigIngestion>;
    /**
     * The region of the data lineage configuration for integration.
     */
    location: pulumi.Input<string>;
    /**
     * Parent scope for the config.
     * Format: projects/{project-id|project-number} or folders/{folder-number} or organizations/{organization-number}.
     */
    parent: pulumi.Input<string>;
}
//# sourceMappingURL=config.d.ts.map