gcp.dataplex.Zone
Explore with Pulumi AI
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={})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/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
})
}
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 = null,
});
});
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.List;
import java.util.ArrayList;
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()
.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
Create Zone Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Zone(name: string, args: ZoneArgs, opts?: CustomResourceOptions);
@overload
def Zone(resource_name: str,
args: ZoneArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Zone(resource_name: str,
opts: Optional[ResourceOptions] = None,
discovery_spec: Optional[ZoneDiscoverySpecArgs] = None,
lake: Optional[str] = None,
location: Optional[str] = None,
resource_spec: Optional[ZoneResourceSpecArgs] = None,
type: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
project: Optional[str] = None)
func NewZone(ctx *Context, name string, args ZoneArgs, opts ...ResourceOption) (*Zone, error)
public Zone(string name, ZoneArgs args, CustomResourceOptions? opts = null)
type: gcp:dataplex:Zone
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ZoneArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ZoneArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ZoneArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ZoneArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ZoneArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var zoneResource = new Gcp.DataPlex.Zone("zoneResource", new()
{
DiscoverySpec = new Gcp.DataPlex.Inputs.ZoneDiscoverySpecArgs
{
Enabled = false,
CsvOptions = new Gcp.DataPlex.Inputs.ZoneDiscoverySpecCsvOptionsArgs
{
Delimiter = "string",
DisableTypeInference = false,
Encoding = "string",
HeaderRows = 0,
},
ExcludePatterns = new[]
{
"string",
},
IncludePatterns = new[]
{
"string",
},
JsonOptions = new Gcp.DataPlex.Inputs.ZoneDiscoverySpecJsonOptionsArgs
{
DisableTypeInference = false,
Encoding = "string",
},
Schedule = "string",
},
Lake = "string",
Location = "string",
ResourceSpec = new Gcp.DataPlex.Inputs.ZoneResourceSpecArgs
{
LocationType = "string",
},
Type = "string",
Description = "string",
DisplayName = "string",
Labels =
{
{ "string", "string" },
},
Name = "string",
Project = "string",
});
example, err := dataplex.NewZone(ctx, "zoneResource", &dataplex.ZoneArgs{
DiscoverySpec: &dataplex.ZoneDiscoverySpecArgs{
Enabled: pulumi.Bool(false),
CsvOptions: &dataplex.ZoneDiscoverySpecCsvOptionsArgs{
Delimiter: pulumi.String("string"),
DisableTypeInference: pulumi.Bool(false),
Encoding: pulumi.String("string"),
HeaderRows: pulumi.Int(0),
},
ExcludePatterns: pulumi.StringArray{
pulumi.String("string"),
},
IncludePatterns: pulumi.StringArray{
pulumi.String("string"),
},
JsonOptions: &dataplex.ZoneDiscoverySpecJsonOptionsArgs{
DisableTypeInference: pulumi.Bool(false),
Encoding: pulumi.String("string"),
},
Schedule: pulumi.String("string"),
},
Lake: pulumi.String("string"),
Location: pulumi.String("string"),
ResourceSpec: &dataplex.ZoneResourceSpecArgs{
LocationType: pulumi.String("string"),
},
Type: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
Project: pulumi.String("string"),
})
var zoneResource = new Zone("zoneResource", ZoneArgs.builder()
.discoverySpec(ZoneDiscoverySpecArgs.builder()
.enabled(false)
.csvOptions(ZoneDiscoverySpecCsvOptionsArgs.builder()
.delimiter("string")
.disableTypeInference(false)
.encoding("string")
.headerRows(0)
.build())
.excludePatterns("string")
.includePatterns("string")
.jsonOptions(ZoneDiscoverySpecJsonOptionsArgs.builder()
.disableTypeInference(false)
.encoding("string")
.build())
.schedule("string")
.build())
.lake("string")
.location("string")
.resourceSpec(ZoneResourceSpecArgs.builder()
.locationType("string")
.build())
.type("string")
.description("string")
.displayName("string")
.labels(Map.of("string", "string"))
.name("string")
.project("string")
.build());
zone_resource = gcp.dataplex.Zone("zoneResource",
discovery_spec={
"enabled": False,
"csv_options": {
"delimiter": "string",
"disable_type_inference": False,
"encoding": "string",
"header_rows": 0,
},
"exclude_patterns": ["string"],
"include_patterns": ["string"],
"json_options": {
"disable_type_inference": False,
"encoding": "string",
},
"schedule": "string",
},
lake="string",
location="string",
resource_spec={
"location_type": "string",
},
type="string",
description="string",
display_name="string",
labels={
"string": "string",
},
name="string",
project="string")
const zoneResource = new gcp.dataplex.Zone("zoneResource", {
discoverySpec: {
enabled: false,
csvOptions: {
delimiter: "string",
disableTypeInference: false,
encoding: "string",
headerRows: 0,
},
excludePatterns: ["string"],
includePatterns: ["string"],
jsonOptions: {
disableTypeInference: false,
encoding: "string",
},
schedule: "string",
},
lake: "string",
location: "string",
resourceSpec: {
locationType: "string",
},
type: "string",
description: "string",
displayName: "string",
labels: {
string: "string",
},
name: "string",
project: "string",
});
type: gcp:dataplex:Zone
properties:
description: string
discoverySpec:
csvOptions:
delimiter: string
disableTypeInference: false
encoding: string
headerRows: 0
enabled: false
excludePatterns:
- string
includePatterns:
- string
jsonOptions:
disableTypeInference: false
encoding: string
schedule: string
displayName: string
labels:
string: string
lake: string
location: string
name: string
project: string
resourceSpec:
locationType: string
type: string
Zone Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Zone resource accepts the following input properties:
- Discovery
Spec ZoneDiscovery Spec - Required. Specification of the discovery feature applied to data in this zone.
- Lake string
- The lake for the resource
- Location string
- The location for the resource
- Resource
Spec ZoneResource Spec - Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
- Type string
- Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
- Description string
- Optional. Description of the zone.
- Display
Name string - Optional. User friendly display name.
- Labels Dictionary<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
effective_labels
for all of the labels present on the resource. - Name string
- The name of the zone.
- Project string
- The project for the resource
- Discovery
Spec ZoneDiscovery Spec Args - Required. Specification of the discovery feature applied to data in this zone.
- Lake string
- The lake for the resource
- Location string
- The location for the resource
- Resource
Spec ZoneResource Spec Args - Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
- Type string
- Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
- Description string
- Optional. Description of the zone.
- Display
Name string - Optional. User friendly display name.
- Labels map[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
effective_labels
for all of the labels present on the resource. - Name string
- The name of the zone.
- Project string
- The project for the resource
- discovery
Spec ZoneDiscovery Spec - Required. Specification of the discovery feature applied to data in this zone.
- lake String
- The lake for the resource
- location String
- The location for the resource
- resource
Spec ZoneResource Spec - Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
- type String
- Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
- description String
- Optional. Description of the zone.
- display
Name String - Optional. User friendly display name.
- labels Map<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
effective_labels
for all of the labels present on the resource. - name String
- The name of the zone.
- project String
- The project for the resource
- discovery
Spec ZoneDiscovery Spec - Required. Specification of the discovery feature applied to data in this zone.
- lake string
- The lake for the resource
- location string
- The location for the resource
- resource
Spec ZoneResource Spec - Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
- type string
- Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
- description string
- Optional. Description of the zone.
- display
Name string - Optional. User friendly display name.
- labels {[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
effective_labels
for all of the labels present on the resource. - name string
- The name of the zone.
- project string
- The project for the resource
- discovery_
spec ZoneDiscovery Spec Args - Required. Specification of the discovery feature applied to data in this zone.
- lake str
- The lake for the resource
- location str
- The location for the resource
- resource_
spec ZoneResource Spec Args - Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
- type str
- Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
- description str
- Optional. Description of the zone.
- display_
name str - Optional. User friendly display name.
- labels Mapping[str, str]
- 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
effective_labels
for all of the labels present on the resource. - name str
- The name of the zone.
- project str
- The project for the resource
- discovery
Spec Property Map - Required. Specification of the discovery feature applied to data in this zone.
- lake String
- The lake for the resource
- location String
- The location for the resource
- resource
Spec Property Map - Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
- type String
- Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
- description String
- Optional. Description of the zone.
- display
Name String - Optional. User friendly display name.
- labels Map<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
effective_labels
for all of the labels present on the resource. - name String
- The name of the zone.
- project String
- The project for the resource
Outputs
All input properties are implicitly available as output properties. Additionally, the Zone resource produces the following output properties:
- Asset
Statuses List<ZoneAsset Status> - Output only. Aggregated status of the underlying assets of the zone.
- Create
Time string - Output only. The time when the zone was created.
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Id string
- The provider-assigned unique ID for this managed resource.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- State string
- Output only. Current state of the zone. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- Uid 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.
- Update
Time string - Output only. The time when the zone was last updated.
- Asset
Statuses []ZoneAsset Status - Output only. Aggregated status of the underlying assets of the zone.
- Create
Time string - Output only. The time when the zone was created.
- Effective
Labels 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- State string
- Output only. Current state of the zone. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- Uid 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.
- Update
Time string - Output only. The time when the zone was last updated.
- asset
Statuses List<ZoneAsset Status> - Output only. Aggregated status of the underlying assets of the zone.
- create
Time String - Output only. The time when the zone was created.
- effective
Labels 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.
- id String
- The provider-assigned unique ID for this managed resource.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- state String
- Output only. Current state of the zone. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- uid 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.
- update
Time String - Output only. The time when the zone was last updated.
- asset
Statuses ZoneAsset Status[] - Output only. Aggregated status of the underlying assets of the zone.
- create
Time string - Output only. The time when the zone was created.
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id string
- The provider-assigned unique ID for this managed resource.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- state string
- Output only. Current state of the zone. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- uid 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.
- update
Time string - Output only. The time when the zone was last updated.
- asset_
statuses Sequence[ZoneAsset Status] - Output only. Aggregated status of the underlying assets of the zone.
- create_
time str - Output only. The time when the zone was created.
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id str
- The provider-assigned unique ID for this managed resource.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- state str
- Output only. Current state of the zone. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- uid str
- 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.
- update_
time str - Output only. The time when the zone was last updated.
- asset
Statuses List<Property Map> - Output only. Aggregated status of the underlying assets of the zone.
- create
Time String - Output only. The time when the zone was created.
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id String
- The provider-assigned unique ID for this managed resource.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- state String
- Output only. Current state of the zone. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- uid 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.
- update
Time String - Output only. The time when the zone was last updated.
Look up Existing Zone Resource
Get an existing Zone resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ZoneState, opts?: CustomResourceOptions): Zone
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
asset_statuses: Optional[Sequence[ZoneAssetStatusArgs]] = None,
create_time: Optional[str] = None,
description: Optional[str] = None,
discovery_spec: Optional[ZoneDiscoverySpecArgs] = None,
display_name: Optional[str] = None,
effective_labels: Optional[Mapping[str, str]] = None,
labels: Optional[Mapping[str, str]] = None,
lake: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None,
pulumi_labels: Optional[Mapping[str, str]] = None,
resource_spec: Optional[ZoneResourceSpecArgs] = None,
state: Optional[str] = None,
type: Optional[str] = None,
uid: Optional[str] = None,
update_time: Optional[str] = None) -> Zone
func GetZone(ctx *Context, name string, id IDInput, state *ZoneState, opts ...ResourceOption) (*Zone, error)
public static Zone Get(string name, Input<string> id, ZoneState? state, CustomResourceOptions? opts = null)
public static Zone get(String name, Output<String> id, ZoneState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Asset
Statuses List<ZoneAsset Status> - Output only. Aggregated status of the underlying assets of the zone.
- Create
Time string - Output only. The time when the zone was created.
- Description string
- Optional. Description of the zone.
- Discovery
Spec ZoneDiscovery Spec - Required. Specification of the discovery feature applied to data in this zone.
- Display
Name string - Optional. User friendly display name.
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Labels Dictionary<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
effective_labels
for all of the labels present on the resource. - Lake string
- The lake for the resource
- Location string
- The location for the resource
- Name string
- The name of the zone.
- Project string
- The project for the resource
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Resource
Spec ZoneResource Spec - Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
- State string
- Output only. Current state of the zone. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- Type string
- Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
- Uid 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.
- Update
Time string - Output only. The time when the zone was last updated.
- Asset
Statuses []ZoneAsset Status Args - Output only. Aggregated status of the underlying assets of the zone.
- Create
Time string - Output only. The time when the zone was created.
- Description string
- Optional. Description of the zone.
- Discovery
Spec ZoneDiscovery Spec Args - Required. Specification of the discovery feature applied to data in this zone.
- Display
Name string - Optional. User friendly display name.
- Effective
Labels 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.
- Labels map[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
effective_labels
for all of the labels present on the resource. - Lake string
- The lake for the resource
- Location string
- The location for the resource
- Name string
- The name of the zone.
- Project string
- The project for the resource
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Resource
Spec ZoneResource Spec Args - Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
- State string
- Output only. Current state of the zone. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- Type string
- Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
- Uid 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.
- Update
Time string - Output only. The time when the zone was last updated.
- asset
Statuses List<ZoneAsset Status> - Output only. Aggregated status of the underlying assets of the zone.
- create
Time String - Output only. The time when the zone was created.
- description String
- Optional. Description of the zone.
- discovery
Spec ZoneDiscovery Spec - Required. Specification of the discovery feature applied to data in this zone.
- display
Name String - Optional. User friendly display name.
- effective
Labels 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.
- labels Map<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
effective_labels
for all of the labels present on the resource. - lake String
- The lake for the resource
- location String
- The location for the resource
- name String
- The name of the zone.
- project String
- The project for the resource
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- resource
Spec ZoneResource Spec - Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
- state String
- Output only. Current state of the zone. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- type String
- Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
- uid 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.
- update
Time String - Output only. The time when the zone was last updated.
- asset
Statuses ZoneAsset Status[] - Output only. Aggregated status of the underlying assets of the zone.
- create
Time string - Output only. The time when the zone was created.
- description string
- Optional. Description of the zone.
- discovery
Spec ZoneDiscovery Spec - Required. Specification of the discovery feature applied to data in this zone.
- display
Name string - Optional. User friendly display name.
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- labels {[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
effective_labels
for all of the labels present on the resource. - lake string
- The lake for the resource
- location string
- The location for the resource
- name string
- The name of the zone.
- project string
- The project for the resource
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- resource
Spec ZoneResource Spec - Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
- state string
- Output only. Current state of the zone. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- type string
- Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
- uid 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.
- update
Time string - Output only. The time when the zone was last updated.
- asset_
statuses Sequence[ZoneAsset Status Args] - Output only. Aggregated status of the underlying assets of the zone.
- create_
time str - Output only. The time when the zone was created.
- description str
- Optional. Description of the zone.
- discovery_
spec ZoneDiscovery Spec Args - Required. Specification of the discovery feature applied to data in this zone.
- display_
name str - Optional. User friendly display name.
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- labels Mapping[str, str]
- 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
effective_labels
for all of the labels present on the resource. - lake str
- The lake for the resource
- location str
- The location for the resource
- name str
- The name of the zone.
- project str
- The project for the resource
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- resource_
spec ZoneResource Spec Args - Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
- state str
- Output only. Current state of the zone. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- type str
- Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
- uid str
- 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.
- update_
time str - Output only. The time when the zone was last updated.
- asset
Statuses List<Property Map> - Output only. Aggregated status of the underlying assets of the zone.
- create
Time String - Output only. The time when the zone was created.
- description String
- Optional. Description of the zone.
- discovery
Spec Property Map - Required. Specification of the discovery feature applied to data in this zone.
- display
Name String - Optional. User friendly display name.
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- labels Map<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
effective_labels
for all of the labels present on the resource. - lake String
- The lake for the resource
- location String
- The location for the resource
- name String
- The name of the zone.
- project String
- The project for the resource
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- resource
Spec Property Map - Required. Immutable. Specification of the resources that are referenced by the assets within this zone.
- state String
- Output only. Current state of the zone. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- type String
- Required. Immutable. The type of the zone. Possible values: TYPE_UNSPECIFIED, RAW, CURATED
- uid 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.
- update
Time String - Output only. The time when the zone was last updated.
Supporting Types
ZoneAssetStatus, ZoneAssetStatusArgs
- Active
Assets int - Number of active assets.
- Security
Policy intApplying Assets - Number of assets that are in process of updating the security policy on attached resources.
- Update
Time string - Output only. The time when the zone was last updated.
- Active
Assets int - Number of active assets.
- Security
Policy intApplying Assets - Number of assets that are in process of updating the security policy on attached resources.
- Update
Time string - Output only. The time when the zone was last updated.
- active
Assets Integer - Number of active assets.
- security
Policy IntegerApplying Assets - Number of assets that are in process of updating the security policy on attached resources.
- update
Time String - Output only. The time when the zone was last updated.
- active
Assets number - Number of active assets.
- security
Policy numberApplying Assets - Number of assets that are in process of updating the security policy on attached resources.
- update
Time string - Output only. The time when the zone was last updated.
- active_
assets int - Number of active assets.
- security_
policy_ intapplying_ assets - Number of assets that are in process of updating the security policy on attached resources.
- update_
time str - Output only. The time when the zone was last updated.
- active
Assets Number - Number of active assets.
- security
Policy NumberApplying Assets - Number of assets that are in process of updating the security policy on attached resources.
- update
Time String - Output only. The time when the zone was last updated.
ZoneDiscoverySpec, ZoneDiscoverySpecArgs
- Enabled bool
- Required. Whether discovery is enabled.
- Csv
Options ZoneDiscovery Spec Csv Options - Optional. Configuration for CSV data.
- Exclude
Patterns List<string> - Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
- Include
Patterns List<string> - Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
- Json
Options ZoneDiscovery Spec Json Options - Optional. Configuration for Json data.
- Schedule string
- Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
- Enabled bool
- Required. Whether discovery is enabled.
- Csv
Options ZoneDiscovery Spec Csv Options - Optional. Configuration for CSV data.
- Exclude
Patterns []string - Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
- Include
Patterns []string - Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
- Json
Options ZoneDiscovery Spec Json Options - Optional. Configuration for Json data.
- Schedule string
- Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
- enabled Boolean
- Required. Whether discovery is enabled.
- csv
Options ZoneDiscovery Spec Csv Options - Optional. Configuration for CSV data.
- exclude
Patterns List<String> - Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
- include
Patterns List<String> - Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
- json
Options ZoneDiscovery Spec Json Options - Optional. Configuration for Json data.
- schedule String
- Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
- enabled boolean
- Required. Whether discovery is enabled.
- csv
Options ZoneDiscovery Spec Csv Options - Optional. Configuration for CSV data.
- exclude
Patterns string[] - Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
- include
Patterns string[] - Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
- json
Options ZoneDiscovery Spec Json Options - Optional. Configuration for Json data.
- schedule string
- Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
- enabled bool
- Required. Whether discovery is enabled.
- csv_
options ZoneDiscovery Spec Csv Options - Optional. Configuration for CSV data.
- exclude_
patterns Sequence[str] - Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
- include_
patterns Sequence[str] - Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
- json_
options ZoneDiscovery Spec Json Options - Optional. Configuration for Json data.
- schedule str
- Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
- enabled Boolean
- Required. Whether discovery is enabled.
- csv
Options Property Map - Optional. Configuration for CSV data.
- exclude
Patterns List<String> - Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
- include
Patterns List<String> - Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
- json
Options Property Map - Optional. Configuration for Json data.
- schedule String
- Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
ZoneDiscoverySpecCsvOptions, ZoneDiscoverySpecCsvOptionsArgs
- Delimiter string
- Optional. The delimiter being used to separate values. This defaults to ','.
- Disable
Type boolInference - Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.
- Encoding string
- Optional. The character encoding of the data. The default is UTF-8.
- Header
Rows int - Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.
- Delimiter string
- Optional. The delimiter being used to separate values. This defaults to ','.
- Disable
Type boolInference - Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.
- Encoding string
- Optional. The character encoding of the data. The default is UTF-8.
- Header
Rows int - Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.
- delimiter String
- Optional. The delimiter being used to separate values. This defaults to ','.
- disable
Type BooleanInference - Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.
- encoding String
- Optional. The character encoding of the data. The default is UTF-8.
- header
Rows Integer - Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.
- delimiter string
- Optional. The delimiter being used to separate values. This defaults to ','.
- disable
Type booleanInference - Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.
- encoding string
- Optional. The character encoding of the data. The default is UTF-8.
- header
Rows number - Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.
- delimiter str
- Optional. The delimiter being used to separate values. This defaults to ','.
- disable_
type_ boolinference - Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.
- encoding str
- Optional. The character encoding of the data. The default is UTF-8.
- header_
rows int - Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.
- delimiter String
- Optional. The delimiter being used to separate values. This defaults to ','.
- disable
Type BooleanInference - Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.
- encoding String
- Optional. The character encoding of the data. The default is UTF-8.
- header
Rows Number - Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.
ZoneDiscoverySpecJsonOptions, ZoneDiscoverySpecJsonOptionsArgs
- Disable
Type boolInference - Optional. Whether to disable the inference of data type for Json data. If true, all columns will be registered as their primitive types (strings, number or boolean).
- Encoding string
- Optional. The character encoding of the data. The default is UTF-8.
- Disable
Type boolInference - Optional. Whether to disable the inference of data type for Json data. If true, all columns will be registered as their primitive types (strings, number or boolean).
- Encoding string
- Optional. The character encoding of the data. The default is UTF-8.
- disable
Type BooleanInference - Optional. Whether to disable the inference of data type for Json data. If true, all columns will be registered as their primitive types (strings, number or boolean).
- encoding String
- Optional. The character encoding of the data. The default is UTF-8.
- disable
Type booleanInference - Optional. Whether to disable the inference of data type for Json data. If true, all columns will be registered as their primitive types (strings, number or boolean).
- encoding string
- Optional. The character encoding of the data. The default is UTF-8.
- disable_
type_ boolinference - Optional. Whether to disable the inference of data type for Json data. If true, all columns will be registered as their primitive types (strings, number or boolean).
- encoding str
- Optional. The character encoding of the data. The default is UTF-8.
- disable
Type BooleanInference - Optional. Whether to disable the inference of data type for Json data. If true, all columns will be registered as their primitive types (strings, number or boolean).
- encoding String
- Optional. The character encoding of the data. The default is UTF-8.
ZoneResourceSpec, ZoneResourceSpecArgs
- Location
Type string - Required. Immutable. The location type of the resources that are allowed to be attached to the assets within this zone. Possible values: LOCATION_TYPE_UNSPECIFIED, SINGLE_REGION, MULTI_REGION
- Location
Type string - Required. Immutable. The location type of the resources that are allowed to be attached to the assets within this zone. Possible values: LOCATION_TYPE_UNSPECIFIED, SINGLE_REGION, MULTI_REGION
- location
Type String - Required. Immutable. The location type of the resources that are allowed to be attached to the assets within this zone. Possible values: LOCATION_TYPE_UNSPECIFIED, SINGLE_REGION, MULTI_REGION
- location
Type string - Required. Immutable. The location type of the resources that are allowed to be attached to the assets within this zone. Possible values: LOCATION_TYPE_UNSPECIFIED, SINGLE_REGION, MULTI_REGION
- location_
type str - Required. Immutable. The location type of the resources that are allowed to be attached to the assets within this zone. Possible values: LOCATION_TYPE_UNSPECIFIED, SINGLE_REGION, MULTI_REGION
- location
Type String - Required. Immutable. The location type of the resources that are allowed to be attached to the assets within this zone. Possible values: LOCATION_TYPE_UNSPECIFIED, SINGLE_REGION, MULTI_REGION
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}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.