Lake class

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/v9/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
	})
}

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

resource "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"
  }
}

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.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var 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

Lake(String name, {LakeArgs? args, CustomResourceOptions? options})

Creates a new Lake. name The Pulumi resource name. args Arguments used to configure this Lake. The set of arguments for Lake. options Resource options controlling this resource's behavior.

Lake.reference(String urn)

Creates a typed reference to an existing Lake resource.

Properties

assetStatuses ↔ Output<List<LakeAssetStatus>>

Output only. Aggregated status of the underlying assets of the lake.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Output only. The time when the lake was created.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

description ↔ Output<String?>

Optional. Description of the lake.

late, final

displayName ↔ Output<String?>

Optional. User friendly display name.

late, final

effectiveLabels ↔ Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>?>

Optional. User-defined labels for the lake.

late, final

location ↔ Output<String>

The location for the resource

late, final

metastore ↔ Output<LakeMetastore?>

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

late, final

metastoreStatuses ↔ Output<List<LakeMetastoreStatus>>

Output only. Metastore status of the lake.

late, final

name ↔ Output<String>

The name of the lake.

late, final

project ↔ Output<String>

The project for the resource

late, final

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serviceAccount ↔ Output<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.

late, final

state ↔ Output<String>

Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<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.

late, final

updateTime ↔ Output<String>

Output only. The time when the lake was last updated.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {LakeState? state, CustomResourceOptions? options}) → Lake

Gets an existing Lake resource's state with the given name and id.