LakeArgs

data class LakeArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val metastore: Output<LakeMetastoreArgs>? = null, val name: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<LakeArgs>

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",
},
});
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",
})
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" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/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
})
}
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());
}
}
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

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}}
$ pulumi import gcp:dataplex/lake:Lake default {{project}}/{{location}}/{{name}}
$ pulumi import gcp:dataplex/lake:Lake default {{location}}/{{name}}

Constructors

Link copied to clipboard
constructor(description: Output<String>? = null, displayName: Output<String>? = null, labels: Output<Map<String, String>>? = null, location: Output<String>? = null, metastore: Output<LakeMetastoreArgs>? = null, name: Output<String>? = null, project: Output<String>? = null)

Properties

Link copied to clipboard
val description: Output<String>? = null

Optional. Description of the lake.

Link copied to clipboard
val displayName: Output<String>? = null

Optional. User friendly display name.

Link copied to clipboard
val labels: Output<Map<String, String>>? = null

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.

Link copied to clipboard
val location: Output<String>? = null

The location for the resource

Link copied to clipboard
val metastore: Output<LakeMetastoreArgs>? = null

Optional. Settings to manage lake and Dataproc Metastore service instance association.

Link copied to clipboard
val name: Output<String>? = null

The name of the lake.

Link copied to clipboard
val project: Output<String>? = null

The project for the resource

Functions

Link copied to clipboard
open override fun toJava(): LakeArgs