1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. dataplex
  5. Lake
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi

gcp.dataplex.Lake

Explore with Pulumi AI

The Dataplex Lake resource

Example Usage

Basic_lake

A basic example of a dataplex lake

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const primary = new gcp.dataplex.Lake("primary", {
    location: "us-west1",
    name: "lake",
    description: "Lake for DCL",
    displayName: "Lake for DCL",
    project: "my-project-name",
    labels: {
        "my-lake": "exists",
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

primary = gcp.dataplex.Lake("primary",
    location="us-west1",
    name="lake",
    description="Lake for DCL",
    display_name="Lake for DCL",
    project="my-project-name",
    labels={
        "my-lake": "exists",
    })
Copy
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 {
		_, err := dataplex.NewLake(ctx, "primary", &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
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

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

});
Copy
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 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 primary = new Lake("primary", 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());

    }
}
Copy
resources:
  primary:
    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
Copy

Create Lake Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Lake(name: string, args: LakeArgs, opts?: CustomResourceOptions);
@overload
def Lake(resource_name: str,
         args: LakeArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Lake(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         location: Optional[str] = None,
         description: Optional[str] = None,
         display_name: Optional[str] = None,
         labels: Optional[Mapping[str, str]] = None,
         metastore: Optional[LakeMetastoreArgs] = None,
         name: Optional[str] = None,
         project: Optional[str] = None)
func NewLake(ctx *Context, name string, args LakeArgs, opts ...ResourceOption) (*Lake, error)
public Lake(string name, LakeArgs args, CustomResourceOptions? opts = null)
public Lake(String name, LakeArgs args)
public Lake(String name, LakeArgs args, CustomResourceOptions options)
type: gcp:dataplex:Lake
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. LakeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. LakeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. LakeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. LakeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LakeArgs
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 lakeResource = new Gcp.DataPlex.Lake("lakeResource", new()
{
    Location = "string",
    Description = "string",
    DisplayName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Metastore = new Gcp.DataPlex.Inputs.LakeMetastoreArgs
    {
        Service = "string",
    },
    Name = "string",
    Project = "string",
});
Copy
example, err := dataplex.NewLake(ctx, "lakeResource", &dataplex.LakeArgs{
	Location:    pulumi.String("string"),
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Metastore: &dataplex.LakeMetastoreArgs{
		Service: pulumi.String("string"),
	},
	Name:    pulumi.String("string"),
	Project: pulumi.String("string"),
})
Copy
var lakeResource = new Lake("lakeResource", LakeArgs.builder()
    .location("string")
    .description("string")
    .displayName("string")
    .labels(Map.of("string", "string"))
    .metastore(LakeMetastoreArgs.builder()
        .service("string")
        .build())
    .name("string")
    .project("string")
    .build());
Copy
lake_resource = gcp.dataplex.Lake("lakeResource",
    location="string",
    description="string",
    display_name="string",
    labels={
        "string": "string",
    },
    metastore={
        "service": "string",
    },
    name="string",
    project="string")
Copy
const lakeResource = new gcp.dataplex.Lake("lakeResource", {
    location: "string",
    description: "string",
    displayName: "string",
    labels: {
        string: "string",
    },
    metastore: {
        service: "string",
    },
    name: "string",
    project: "string",
});
Copy
type: gcp:dataplex:Lake
properties:
    description: string
    displayName: string
    labels:
        string: string
    location: string
    metastore:
        service: string
    name: string
    project: string
Copy

Lake 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 Lake resource accepts the following input properties:

Location
This property is required.
Changes to this property will trigger replacement.
string
The location for the resource
Description string
Optional. Description of the lake.
DisplayName string
Optional. User friendly display name.
Labels Dictionary<string, string>

Optional. User-defined labels for the lake.

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.

Metastore LakeMetastore
Optional. Settings to manage lake and Dataproc Metastore service instance association.
Name string
The name of the lake.


Project Changes to this property will trigger replacement. string
The project for the resource
Location
This property is required.
Changes to this property will trigger replacement.
string
The location for the resource
Description string
Optional. Description of the lake.
DisplayName string
Optional. User friendly display name.
Labels map[string]string

Optional. User-defined labels for the lake.

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.

Metastore LakeMetastoreArgs
Optional. Settings to manage lake and Dataproc Metastore service instance association.
Name string
The name of the lake.


Project Changes to this property will trigger replacement. string
The project for the resource
location
This property is required.
Changes to this property will trigger replacement.
String
The location for the resource
description String
Optional. Description of the lake.
displayName String
Optional. User friendly display name.
labels Map<String,String>

Optional. User-defined labels for the lake.

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.

metastore LakeMetastore
Optional. Settings to manage lake and Dataproc Metastore service instance association.
name String
The name of the lake.


project Changes to this property will trigger replacement. String
The project for the resource
location
This property is required.
Changes to this property will trigger replacement.
string
The location for the resource
description string
Optional. Description of the lake.
displayName string
Optional. User friendly display name.
labels {[key: string]: string}

Optional. User-defined labels for the lake.

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.

metastore LakeMetastore
Optional. Settings to manage lake and Dataproc Metastore service instance association.
name string
The name of the lake.


project Changes to this property will trigger replacement. string
The project for the resource
location
This property is required.
Changes to this property will trigger replacement.
str
The location for the resource
description str
Optional. Description of the lake.
display_name str
Optional. User friendly display name.
labels Mapping[str, str]

Optional. User-defined labels for the lake.

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.

metastore LakeMetastoreArgs
Optional. Settings to manage lake and Dataproc Metastore service instance association.
name str
The name of the lake.


project Changes to this property will trigger replacement. str
The project for the resource
location
This property is required.
Changes to this property will trigger replacement.
String
The location for the resource
description String
Optional. Description of the lake.
displayName String
Optional. User friendly display name.
labels Map<String>

Optional. User-defined labels for the lake.

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.

metastore Property Map
Optional. Settings to manage lake and Dataproc Metastore service instance association.
name String
The name of the lake.


project Changes to this property will trigger replacement. String
The project for the resource

Outputs

All input properties are implicitly available as output properties. Additionally, the Lake resource produces the following output properties:

AssetStatuses List<LakeAssetStatus>
Output only. Aggregated status of the underlying assets of the lake.
CreateTime string
Output only. The time when the lake was created.
EffectiveLabels 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.
MetastoreStatuses List<LakeMetastoreStatus>
Output only. Metastore status of the lake.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
ServiceAccount string
Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
State string
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
Uid string
Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.
UpdateTime string
Output only. The time when the lake was last updated.
AssetStatuses []LakeAssetStatus
Output only. Aggregated status of the underlying assets of the lake.
CreateTime string
Output only. The time when the lake was created.
EffectiveLabels 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.
MetastoreStatuses []LakeMetastoreStatus
Output only. Metastore status of the lake.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
ServiceAccount string
Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
State string
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
Uid string
Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.
UpdateTime string
Output only. The time when the lake was last updated.
assetStatuses List<LakeAssetStatus>
Output only. Aggregated status of the underlying assets of the lake.
createTime String
Output only. The time when the lake was created.
effectiveLabels 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.
metastoreStatuses List<LakeMetastoreStatus>
Output only. Metastore status of the lake.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
serviceAccount String
Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
state String
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
uid String
Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.
updateTime String
Output only. The time when the lake was last updated.
assetStatuses LakeAssetStatus[]
Output only. Aggregated status of the underlying assets of the lake.
createTime string
Output only. The time when the lake was created.
effectiveLabels {[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.
metastoreStatuses LakeMetastoreStatus[]
Output only. Metastore status of the lake.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
serviceAccount string
Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
state string
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
uid string
Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.
updateTime string
Output only. The time when the lake was last updated.
asset_statuses Sequence[LakeAssetStatus]
Output only. Aggregated status of the underlying assets of the lake.
create_time str
Output only. The time when the lake 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.
metastore_statuses Sequence[LakeMetastoreStatus]
Output only. Metastore status of the lake.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
service_account str
Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
state str
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
uid str
Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.
update_time str
Output only. The time when the lake was last updated.
assetStatuses List<Property Map>
Output only. Aggregated status of the underlying assets of the lake.
createTime String
Output only. The time when the lake was created.
effectiveLabels 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.
metastoreStatuses List<Property Map>
Output only. Metastore status of the lake.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
serviceAccount String
Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
state String
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
uid String
Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.
updateTime String
Output only. The time when the lake was last updated.

Look up Existing Lake Resource

Get an existing Lake 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?: LakeState, opts?: CustomResourceOptions): Lake
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        asset_statuses: Optional[Sequence[LakeAssetStatusArgs]] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        metastore: Optional[LakeMetastoreArgs] = None,
        metastore_statuses: Optional[Sequence[LakeMetastoreStatusArgs]] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        service_account: Optional[str] = None,
        state: Optional[str] = None,
        uid: Optional[str] = None,
        update_time: Optional[str] = None) -> Lake
func GetLake(ctx *Context, name string, id IDInput, state *LakeState, opts ...ResourceOption) (*Lake, error)
public static Lake Get(string name, Input<string> id, LakeState? state, CustomResourceOptions? opts = null)
public static Lake get(String name, Output<String> id, LakeState state, CustomResourceOptions options)
resources:  _:    type: gcp:dataplex:Lake    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
AssetStatuses List<LakeAssetStatus>
Output only. Aggregated status of the underlying assets of the lake.
CreateTime string
Output only. The time when the lake was created.
Description string
Optional. Description of the lake.
DisplayName string
Optional. User friendly display name.
EffectiveLabels 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 lake.

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.

Location Changes to this property will trigger replacement. string
The location for the resource
Metastore LakeMetastore
Optional. Settings to manage lake and Dataproc Metastore service instance association.
MetastoreStatuses List<LakeMetastoreStatus>
Output only. Metastore status of the lake.
Name string
The name of the lake.


Project Changes to this property will trigger replacement. string
The project for the resource
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
ServiceAccount string
Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
State string
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
Uid string
Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.
UpdateTime string
Output only. The time when the lake was last updated.
AssetStatuses []LakeAssetStatusArgs
Output only. Aggregated status of the underlying assets of the lake.
CreateTime string
Output only. The time when the lake was created.
Description string
Optional. Description of the lake.
DisplayName string
Optional. User friendly display name.
EffectiveLabels 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 lake.

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.

Location Changes to this property will trigger replacement. string
The location for the resource
Metastore LakeMetastoreArgs
Optional. Settings to manage lake and Dataproc Metastore service instance association.
MetastoreStatuses []LakeMetastoreStatusArgs
Output only. Metastore status of the lake.
Name string
The name of the lake.


Project Changes to this property will trigger replacement. string
The project for the resource
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
ServiceAccount string
Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
State string
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
Uid string
Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.
UpdateTime string
Output only. The time when the lake was last updated.
assetStatuses List<LakeAssetStatus>
Output only. Aggregated status of the underlying assets of the lake.
createTime String
Output only. The time when the lake was created.
description String
Optional. Description of the lake.
displayName String
Optional. User friendly display name.
effectiveLabels 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 lake.

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.

location Changes to this property will trigger replacement. String
The location for the resource
metastore LakeMetastore
Optional. Settings to manage lake and Dataproc Metastore service instance association.
metastoreStatuses List<LakeMetastoreStatus>
Output only. Metastore status of the lake.
name String
The name of the lake.


project Changes to this property will trigger replacement. String
The project for the resource
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
serviceAccount String
Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
state String
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
uid String
Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.
updateTime String
Output only. The time when the lake was last updated.
assetStatuses LakeAssetStatus[]
Output only. Aggregated status of the underlying assets of the lake.
createTime string
Output only. The time when the lake was created.
description string
Optional. Description of the lake.
displayName string
Optional. User friendly display name.
effectiveLabels {[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 lake.

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.

location Changes to this property will trigger replacement. string
The location for the resource
metastore LakeMetastore
Optional. Settings to manage lake and Dataproc Metastore service instance association.
metastoreStatuses LakeMetastoreStatus[]
Output only. Metastore status of the lake.
name string
The name of the lake.


project Changes to this property will trigger replacement. string
The project for the resource
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
serviceAccount string
Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
state string
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
uid string
Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.
updateTime string
Output only. The time when the lake was last updated.
asset_statuses Sequence[LakeAssetStatusArgs]
Output only. Aggregated status of the underlying assets of the lake.
create_time str
Output only. The time when the lake was created.
description str
Optional. Description of the lake.
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 lake.

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.

location Changes to this property will trigger replacement. str
The location for the resource
metastore LakeMetastoreArgs
Optional. Settings to manage lake and Dataproc Metastore service instance association.
metastore_statuses Sequence[LakeMetastoreStatusArgs]
Output only. Metastore status of the lake.
name str
The name of the lake.


project Changes to this property will trigger replacement. 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.
service_account str
Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
state str
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
uid str
Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.
update_time str
Output only. The time when the lake was last updated.
assetStatuses List<Property Map>
Output only. Aggregated status of the underlying assets of the lake.
createTime String
Output only. The time when the lake was created.
description String
Optional. Description of the lake.
displayName String
Optional. User friendly display name.
effectiveLabels 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 lake.

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.

location Changes to this property will trigger replacement. String
The location for the resource
metastore Property Map
Optional. Settings to manage lake and Dataproc Metastore service instance association.
metastoreStatuses List<Property Map>
Output only. Metastore status of the lake.
name String
The name of the lake.


project Changes to this property will trigger replacement. String
The project for the resource
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
serviceAccount String
Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
state String
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
uid String
Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.
updateTime String
Output only. The time when the lake was last updated.

Supporting Types

LakeAssetStatus
, LakeAssetStatusArgs

ActiveAssets int
Number of active assets.
SecurityPolicyApplyingAssets int
Number of assets that are in process of updating the security policy on attached resources.
UpdateTime string
Output only. The time when the lake was last updated.
ActiveAssets int
Number of active assets.
SecurityPolicyApplyingAssets int
Number of assets that are in process of updating the security policy on attached resources.
UpdateTime string
Output only. The time when the lake was last updated.
activeAssets Integer
Number of active assets.
securityPolicyApplyingAssets Integer
Number of assets that are in process of updating the security policy on attached resources.
updateTime String
Output only. The time when the lake was last updated.
activeAssets number
Number of active assets.
securityPolicyApplyingAssets number
Number of assets that are in process of updating the security policy on attached resources.
updateTime string
Output only. The time when the lake was last updated.
active_assets int
Number of active assets.
security_policy_applying_assets int
Number of assets that are in process of updating the security policy on attached resources.
update_time str
Output only. The time when the lake was last updated.
activeAssets Number
Number of active assets.
securityPolicyApplyingAssets Number
Number of assets that are in process of updating the security policy on attached resources.
updateTime String
Output only. The time when the lake was last updated.

LakeMetastore
, LakeMetastoreArgs

Service string
Optional. A relative reference to the Dataproc Metastore (https://cloud.google.com/dataproc-metastore/docs) service associated with the lake: projects/{project_id}/locations/{location_id}/services/{service_id}
Service string
Optional. A relative reference to the Dataproc Metastore (https://cloud.google.com/dataproc-metastore/docs) service associated with the lake: projects/{project_id}/locations/{location_id}/services/{service_id}
service String
Optional. A relative reference to the Dataproc Metastore (https://cloud.google.com/dataproc-metastore/docs) service associated with the lake: projects/{project_id}/locations/{location_id}/services/{service_id}
service string
Optional. A relative reference to the Dataproc Metastore (https://cloud.google.com/dataproc-metastore/docs) service associated with the lake: projects/{project_id}/locations/{location_id}/services/{service_id}
service str
Optional. A relative reference to the Dataproc Metastore (https://cloud.google.com/dataproc-metastore/docs) service associated with the lake: projects/{project_id}/locations/{location_id}/services/{service_id}
service String
Optional. A relative reference to the Dataproc Metastore (https://cloud.google.com/dataproc-metastore/docs) service associated with the lake: projects/{project_id}/locations/{location_id}/services/{service_id}

LakeMetastoreStatus
, LakeMetastoreStatusArgs

Endpoint string
The URI of the endpoint used to access the Metastore service.
Message string
Additional information about the current status.
State string
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
UpdateTime string
Output only. The time when the lake was last updated.
Endpoint string
The URI of the endpoint used to access the Metastore service.
Message string
Additional information about the current status.
State string
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
UpdateTime string
Output only. The time when the lake was last updated.
endpoint String
The URI of the endpoint used to access the Metastore service.
message String
Additional information about the current status.
state String
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
updateTime String
Output only. The time when the lake was last updated.
endpoint string
The URI of the endpoint used to access the Metastore service.
message string
Additional information about the current status.
state string
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
updateTime string
Output only. The time when the lake was last updated.
endpoint str
The URI of the endpoint used to access the Metastore service.
message str
Additional information about the current status.
state str
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
update_time str
Output only. The time when the lake was last updated.
endpoint String
The URI of the endpoint used to access the Metastore service.
message String
Additional information about the current status.
state String
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
updateTime String
Output only. The time when the lake was last updated.

Import

Lake can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{location}}/lakes/{{name}}

  • {{project}}/{{location}}/{{name}}

  • {{location}}/{{name}}

When using the pulumi import command, Lake can be imported using one of the formats above. For example:

$ pulumi import gcp:dataplex/lake:Lake default projects/{{project}}/locations/{{location}}/lakes/{{name}}
Copy
$ pulumi import gcp:dataplex/lake:Lake default {{project}}/{{location}}/{{name}}
Copy
$ pulumi import gcp:dataplex/lake:Lake default {{location}}/{{name}}
Copy

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.