Zone class

The Dataplex Zone resource

Example Usage

Basic_zone

A basic example of a dataplex zone

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 pulumi
import pulumi_gcp as gcp

basic = gcp.dataplex.Lake("basic",
    location="us-west1",
    name="lake",
    description="Lake for DCL",
    display_name="Lake for DCL",
    project="my-project-name",
    labels={
        "my-lake": "exists",
    })
primary = gcp.dataplex.Zone("primary",
    discovery_spec={
        "enabled": False,
    },
    lake=basic.name,
    location="us-west1",
    name="zone",
    resource_spec={
        "location_type": "MULTI_REGION",
    },
    type="RAW",
    description="Zone for DCL",
    display_name="Zone for DCL",
    project="my-project-name",
    labels={})

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var basic = new Gcp.DataPlex.Lake("basic", new()
    {
        Location = "us-west1",
        Name = "lake",
        Description = "Lake for DCL",
        DisplayName = "Lake for DCL",
        Project = "my-project-name",
        Labels =
        {
            { "my-lake", "exists" },
        },
    });

    var primary = new Gcp.DataPlex.Zone("primary", new()
    {
        DiscoverySpec = new Gcp.DataPlex.Inputs.ZoneDiscoverySpecArgs
        {
            Enabled = false,
        },
        Lake = basic.Name,
        Location = "us-west1",
        Name = "zone",
        ResourceSpec = new Gcp.DataPlex.Inputs.ZoneResourceSpecArgs
        {
            LocationType = "MULTI_REGION",
        },
        Type = "RAW",
        Description = "Zone for DCL",
        DisplayName = "Zone for DCL",
        Project = "my-project-name",
        Labels = new() { },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/dataplex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		basic, err := dataplex.NewLake(ctx, "basic", &dataplex.LakeArgs{
			Location:    pulumi.String("us-west1"),
			Name:        pulumi.String("lake"),
			Description: pulumi.String("Lake for DCL"),
			DisplayName: pulumi.String("Lake for DCL"),
			Project:     pulumi.String("my-project-name"),
			Labels: pulumi.StringMap{
				"my-lake": pulumi.String("exists"),
			},
		})
		if err != nil {
			return err
		}
		_, err = dataplex.NewZone(ctx, "primary", &dataplex.ZoneArgs{
			DiscoverySpec: &dataplex.ZoneDiscoverySpecArgs{
				Enabled: pulumi.Bool(false),
			},
			Lake:     basic.Name,
			Location: pulumi.String("us-west1"),
			Name:     pulumi.String("zone"),
			ResourceSpec: &dataplex.ZoneResourceSpecArgs{
				LocationType: pulumi.String("MULTI_REGION"),
			},
			Type:        pulumi.String("RAW"),
			Description: pulumi.String("Zone for DCL"),
			DisplayName: pulumi.String("Zone for DCL"),
			Project:     pulumi.String("my-project-name"),
			Labels:      pulumi.StringMap{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_dataplex_zone" "primary" {
  discovery_spec = {
    enabled = false
  }
  lake     = gcp_dataplex_lake.basic.name
  location = "us-west1"
  name     = "zone"
  resource_spec = {
    location_type = "MULTI_REGION"
  }
  type         = "RAW"
  description  = "Zone for DCL"
  display_name = "Zone for DCL"
  project      = "my-project-name"
  labels       = {}
}
resource "gcp_dataplex_lake" "basic" {
  location     = "us-west1"
  name         = "lake"
  description  = "Lake for DCL"
  display_name = "Lake for DCL"
  project      = "my-project-name"
  labels = {
    "my-lake" = "exists"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.dataplex.Lake;
import com.pulumi.gcp.dataplex.LakeArgs;
import com.pulumi.gcp.dataplex.Zone;
import com.pulumi.gcp.dataplex.ZoneArgs;
import com.pulumi.gcp.dataplex.inputs.ZoneDiscoverySpecArgs;
import com.pulumi.gcp.dataplex.inputs.ZoneResourceSpecArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var basic = new Lake("basic", LakeArgs.builder()
            .location("us-west1")
            .name("lake")
            .description("Lake for DCL")
            .displayName("Lake for DCL")
            .project("my-project-name")
            .labels(Map.of("my-lake", "exists"))
            .build());

        var primary = new Zone("primary", ZoneArgs.builder()
            .discoverySpec(ZoneDiscoverySpecArgs.builder()
                .enabled(false)
                .build())
            .lake(basic.name())
            .location("us-west1")
            .name("zone")
            .resourceSpec(ZoneResourceSpecArgs.builder()
                .locationType("MULTI_REGION")
                .build())
            .type("RAW")
            .description("Zone for DCL")
            .displayName("Zone for DCL")
            .project("my-project-name")
            .labels(Map.ofEntries(
            ))
            .build());

    }
}

resources:
  primary:
    type: gcp:dataplex:Zone
    properties:
      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: {}
  basic:
    type: gcp:dataplex:Lake
    properties:
      location: us-west1
      name: lake
      description: Lake for DCL
      displayName: Lake for DCL
      project: my-project-name
      labels:
        my-lake: exists

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:

$ 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}}

Constructors

Zone(String name, {ZoneArgs? args, CustomResourceOptions? options}): Creates a new Zone. name The Pulumi resource name. args Arguments used to configure this Zone. The set of arguments for Zone. options Resource options controlling this resource's behavior.
Zone.reference(String urn): Creates a typed reference to an existing Zone resource.

Properties

assetStatuses ↔ Output<List<ZoneAssetStatus>>: Output only. Aggregated status of the underlying assets of the zone.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
createTime ↔ Output<String>: Output only. The time when the zone was created.
latefinal
deletionPolicy ↔ 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.
latefinal
description ↔ Output<String?>: Optional. Description of the zone.
latefinal
discoverySpec ↔ Output<ZoneDiscoverySpec>: Required. Specification of the discovery feature applied to data in this zone.
latefinal
displayName ↔ Output<String?>: Optional. User friendly display name.
latefinal
effectiveLabels ↔ Output<Map<String, String>>: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
labels ↔ Output<Map<String, String>?>: Optional. User defined labels for the zone.
latefinal
lake ↔ Output<String>: The lake for the resource
latefinal
location ↔ Output<String>: The location for the resource
latefinal
name ↔ Output<String>: The name of the zone.
latefinal
project ↔ Output<String>: The project for the resource
latefinal
pulumiLabels ↔ Output<Map<String, String>>: The combination of labels configured directly on the resource and default labels configured on the provider.
latefinal
resourceSpec ↔ Output<ZoneResourceSpec>: Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
state ↔ Output<String>: Output only. Current state of the zone. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
type ↔ Output<String>: Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
latefinal
uid ↔ 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.
latefinal
updateTime ↔ Output<String>: Output only. The time when the zone was last updated.
latefinal
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ZoneState? state, CustomResourceOptions? options}) → Zone: Gets an existing Zone resource's state with the given name and id.