@pulumi/gcp/dataplex/zone.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";
/**
 * The Dataplex Zone resource
 *
 * ## Example Usage
 *
 * ### Basic_zone
 * A basic example of a dataplex zone
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const basic = new gcp.dataplex.Lake("basic", {
 *     location: "us-west1",
 *     name: "lake",
 *     description: "Lake for DCL",
 *     displayName: "Lake for DCL",
 *     project: "my-project-name",
 *     labels: {
 *         "my-lake": "exists",
 *     },
 * });
 * const primary = new gcp.dataplex.Zone("primary", {
 *     discoverySpec: {
 *         enabled: false,
 *     },
 *     lake: basic.name,
 *     location: "us-west1",
 *     name: "zone",
 *     resourceSpec: {
 *         locationType: "MULTI_REGION",
 *     },
 *     type: "RAW",
 *     description: "Zone for DCL",
 *     displayName: "Zone for DCL",
 *     project: "my-project-name",
 *     labels: {},
 * });
 * ```
 *
 * ## Import
 *
 * Zone can be imported using any of these accepted formats:
 * * `projects/{{project}}/locations/{{location}}/lakes/{{lake}}/zones/{{name}}`
 * * `{{project}}/{{location}}/{{lake}}/{{name}}`
 * * `{{location}}/{{lake}}/{{name}}`
 *
 * When using the `pulumi import` command, Zone can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:dataplex/zone:Zone default projects/{{project}}/locations/{{location}}/lakes/{{lake}}/zones/{{name}}
 * $ pulumi import gcp:dataplex/zone:Zone default {{project}}/{{location}}/{{lake}}/{{name}}
 * $ pulumi import gcp:dataplex/zone:Zone default {{location}}/{{lake}}/{{name}}
 * ```
 */
export declare class Zone extends pulumi.CustomResource {
    /**
     * Get an existing Zone 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?: ZoneState, opts?: pulumi.CustomResourceOptions): Zone;
    /**
     * Returns true if the given object is an instance of Zone.  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 Zone;
    /**
     * Output only. Aggregated status of the underlying assets of the zone.
     */
    readonly assetStatuses: pulumi.Output<outputs.dataplex.ZoneAssetStatus[]>;
    /**
     * Output only. The time when the zone was created.
     */
    readonly createTime: 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>;
    /**
     * Optional. Description of the zone.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Required. Specification of the discovery feature applied to data in this zone.
     */
    readonly discoverySpec: pulumi.Output<outputs.dataplex.ZoneDiscoverySpec>;
    /**
     * Optional. User friendly display name.
     */
    readonly displayName: pulumi.Output<string | undefined>;
    /**
     * 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;
    }>;
    /**
     * Optional. User defined labels for the zone.
     *
     * **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 lake for the resource
     */
    readonly lake: pulumi.Output<string>;
    /**
     * The location for the resource
     */
    readonly location: pulumi.Output<string>;
    /**
     * The name of the zone.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The project for the resource
     */
    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;
    }>;
    /**
     * Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
     */
    readonly resourceSpec: pulumi.Output<outputs.dataplex.ZoneResourceSpec>;
    /**
     * Output only. Current state of the zone. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
     */
    readonly state: pulumi.Output<string>;
    /**
     * Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
     */
    readonly type: pulumi.Output<string>;
    /**
     * Output only. System generated globally unique ID for the zone. This ID will be different if the zone is deleted and re-created with the same name.
     */
    readonly uid: pulumi.Output<string>;
    /**
     * Output only. The time when the zone was last updated.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a Zone 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: ZoneArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Zone resources.
 */
export interface ZoneState {
    /**
     * Output only. Aggregated status of the underlying assets of the zone.
     */
    assetStatuses?: pulumi.Input<pulumi.Input<inputs.dataplex.ZoneAssetStatus>[] | undefined>;
    /**
     * Output only. The time when the zone was created.
     */
    createTime?: 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>;
    /**
     * Optional. Description of the zone.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * Required. Specification of the discovery feature applied to data in this zone.
     */
    discoverySpec?: pulumi.Input<inputs.dataplex.ZoneDiscoverySpec | undefined>;
    /**
     * Optional. 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>;
    /**
     * Optional. User defined labels for the zone.
     *
     * **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 lake for the resource
     */
    lake?: pulumi.Input<string | undefined>;
    /**
     * The location for the resource
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * The name of the zone.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The project for the resource
     */
    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>;
    /**
     * Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
     */
    resourceSpec?: pulumi.Input<inputs.dataplex.ZoneResourceSpec | undefined>;
    /**
     * Output only. Current state of the zone. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
     */
    state?: pulumi.Input<string | undefined>;
    /**
     * Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
     */
    type?: pulumi.Input<string | undefined>;
    /**
     * Output only. System generated globally unique ID for the zone. This ID will be different if the zone is deleted and re-created with the same name.
     */
    uid?: pulumi.Input<string | undefined>;
    /**
     * Output only. The time when the zone was last updated.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a Zone resource.
 */
export interface ZoneArgs {
    /**
     * 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>;
    /**
     * Optional. Description of the zone.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * Required. Specification of the discovery feature applied to data in this zone.
     */
    discoverySpec: pulumi.Input<inputs.dataplex.ZoneDiscoverySpec>;
    /**
     * Optional. User friendly display name.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * Optional. User defined labels for the zone.
     *
     * **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 lake for the resource
     */
    lake: pulumi.Input<string>;
    /**
     * The location for the resource
     */
    location: pulumi.Input<string>;
    /**
     * The name of the zone.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The project for the resource
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
     */
    resourceSpec: pulumi.Input<inputs.dataplex.ZoneResourceSpec>;
    /**
     * Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
     */
    type: pulumi.Input<string>;
}
//# sourceMappingURL=zone.d.ts.map