gcp.dataplex.Lake
Explore with Pulumi AI
The Dataplex Lake resource
Example Usage
Basic_lake
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()
{
Description = "Lake for DCL",
DisplayName = "Lake for DCL",
Labels =
{
{ "my-lake", "exists" },
},
Location = "us-west1",
Project = "my-project-name",
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/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{
Description: pulumi.String("Lake for DCL"),
DisplayName: pulumi.String("Lake for DCL"),
Labels: pulumi.StringMap{
"my-lake": pulumi.String("exists"),
},
Location: pulumi.String("us-west1"),
Project: pulumi.String("my-project-name"),
})
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()
.description("Lake for DCL")
.displayName("Lake for DCL")
.labels(Map.of("my-lake", "exists"))
.location("us-west1")
.project("my-project-name")
.build());
}
}
import pulumi
import pulumi_gcp as gcp
primary = gcp.dataplex.Lake("primary",
description="Lake for DCL",
display_name="Lake for DCL",
labels={
"my-lake": "exists",
},
location="us-west1",
project="my-project-name")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const primary = new gcp.dataplex.Lake("primary", {
description: "Lake for DCL",
displayName: "Lake for DCL",
labels: {
"my-lake": "exists",
},
location: "us-west1",
project: "my-project-name",
});
resources:
primary:
type: gcp:dataplex:Lake
properties:
description: Lake for DCL
displayName: Lake for DCL
labels:
my-lake: exists
location: us-west1
project: my-project-name
Create Lake Resource
new Lake(name: string, args: LakeArgs, opts?: CustomResourceOptions);
@overload
def Lake(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
metastore: Optional[LakeMetastoreArgs] = None,
name: Optional[str] = None,
project: Optional[str] = None)
@overload
def Lake(resource_name: str,
args: LakeArgs,
opts: Optional[ResourceOptions] = None)
func NewLake(ctx *Context, name string, args LakeArgs, opts ...ResourceOption) (*Lake, error)
public Lake(string name, LakeArgs args, CustomResourceOptions? opts = null)
type: gcp:dataplex:Lake
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LakeArgs
- 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 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 string
- The unique name of the resource.
- args LakeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LakeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LakeArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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
The Lake resource accepts the following input properties:
- Location string
The location for the resource
- Description string
Optional. Description of the lake.
- Display
Name string Optional. User friendly display name.
- Labels Dictionary<string, string>
Optional. User-defined labels for the lake.
- Metastore
Lake
Metastore Optional. Settings to manage lake and Dataproc Metastore service instance association.
- Name string
The name of the lake.
- Project string
The project for the resource
- Location string
The location for the resource
- Description string
Optional. Description of the lake.
- Display
Name string Optional. User friendly display name.
- Labels map[string]string
Optional. User-defined labels for the lake.
- Metastore
Lake
Metastore Args Optional. Settings to manage lake and Dataproc Metastore service instance association.
- Name string
The name of the lake.
- Project string
The project for the resource
- location String
The location for the resource
- description String
Optional. Description of the lake.
- display
Name String Optional. User friendly display name.
- labels Map<String,String>
Optional. User-defined labels for the lake.
- metastore
Lake
Metastore Optional. Settings to manage lake and Dataproc Metastore service instance association.
- name String
The name of the lake.
- project String
The project for the resource
- location string
The location for the resource
- description string
Optional. Description of the lake.
- display
Name string Optional. User friendly display name.
- labels {[key: string]: string}
Optional. User-defined labels for the lake.
- metastore
Lake
Metastore Optional. Settings to manage lake and Dataproc Metastore service instance association.
- name string
The name of the lake.
- project string
The project for the resource
- location 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.
- metastore
Lake
Metastore Args Optional. Settings to manage lake and Dataproc Metastore service instance association.
- name str
The name of the lake.
- project str
The project for the resource
- location String
The location for the resource
- description String
Optional. Description of the lake.
- display
Name String Optional. User friendly display name.
- labels Map<String>
Optional. User-defined labels for the lake.
- metastore Property Map
Optional. Settings to manage lake and Dataproc Metastore service instance association.
- name String
The name of the lake.
- project 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:
- Asset
Statuses List<LakeAsset Status> Output only. Aggregated status of the underlying assets of the lake.
- Create
Time string Output only. The time when the lake was created.
- Id string
The provider-assigned unique ID for this managed resource.
- Metastore
Statuses List<LakeMetastore Status> Output only. Metastore status of the lake.
- Service
Account 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.
- Update
Time string Output only. The time when the lake was last updated.
- Asset
Statuses []LakeAsset Status Output only. Aggregated status of the underlying assets of the lake.
- Create
Time string Output only. The time when the lake was created.
- Id string
The provider-assigned unique ID for this managed resource.
- Metastore
Statuses []LakeMetastore Status Output only. Metastore status of the lake.
- Service
Account 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.
- Update
Time string Output only. The time when the lake was last updated.
- asset
Statuses List<LakeAsset Status> Output only. Aggregated status of the underlying assets of the lake.
- create
Time String Output only. The time when the lake was created.
- id String
The provider-assigned unique ID for this managed resource.
- metastore
Statuses List<LakeMetastore Status> Output only. Metastore status of the lake.
- service
Account 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.
- update
Time String Output only. The time when the lake was last updated.
- asset
Statuses LakeAsset Status[] Output only. Aggregated status of the underlying assets of the lake.
- create
Time string Output only. The time when the lake was created.
- id string
The provider-assigned unique ID for this managed resource.
- metastore
Statuses LakeMetastore Status[] Output only. Metastore status of the lake.
- service
Account 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.
- update
Time string Output only. The time when the lake was last updated.
- asset_
statuses Sequence[LakeAsset Status] Output only. Aggregated status of the underlying assets of the lake.
- create_
time str Output only. The time when the lake was created.
- id str
The provider-assigned unique ID for this managed resource.
- metastore_
statuses Sequence[LakeMetastore Status] Output only. Metastore status of the lake.
- 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.
- asset
Statuses List<Property Map> Output only. Aggregated status of the underlying assets of the lake.
- create
Time String Output only. The time when the lake was created.
- id String
The provider-assigned unique ID for this managed resource.
- metastore
Statuses List<Property Map> Output only. Metastore status of the lake.
- service
Account 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.
- update
Time 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,
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,
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)
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<LakeAsset Status> Output only. Aggregated status of the underlying assets of the lake.
- Create
Time string Output only. The time when the lake was created.
- Description string
Optional. Description of the lake.
- Display
Name string Optional. User friendly display name.
- Labels Dictionary<string, string>
Optional. User-defined labels for the lake.
- Location string
The location for the resource
- Metastore
Lake
Metastore Optional. Settings to manage lake and Dataproc Metastore service instance association.
- Metastore
Statuses List<LakeMetastore Status> Output only. Metastore status of the lake.
- Name string
The name of the lake.
- Project string
The project for the resource
- Service
Account 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.
- Update
Time string Output only. The time when the lake was last updated.
- Asset
Statuses []LakeAsset Status Args Output only. Aggregated status of the underlying assets of the lake.
- Create
Time string Output only. The time when the lake was created.
- Description string
Optional. Description of the lake.
- Display
Name string Optional. User friendly display name.
- Labels map[string]string
Optional. User-defined labels for the lake.
- Location string
The location for the resource
- Metastore
Lake
Metastore Args Optional. Settings to manage lake and Dataproc Metastore service instance association.
- Metastore
Statuses []LakeMetastore Status Args Output only. Metastore status of the lake.
- Name string
The name of the lake.
- Project string
The project for the resource
- Service
Account 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.
- Update
Time string Output only. The time when the lake was last updated.
- asset
Statuses List<LakeAsset Status> Output only. Aggregated status of the underlying assets of the lake.
- create
Time String Output only. The time when the lake was created.
- description String
Optional. Description of the lake.
- display
Name String Optional. User friendly display name.
- labels Map<String,String>
Optional. User-defined labels for the lake.
- location String
The location for the resource
- metastore
Lake
Metastore Optional. Settings to manage lake and Dataproc Metastore service instance association.
- metastore
Statuses List<LakeMetastore Status> Output only. Metastore status of the lake.
- name String
The name of the lake.
- project String
The project for the resource
- service
Account 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.
- update
Time String Output only. The time when the lake was last updated.
- asset
Statuses LakeAsset Status[] Output only. Aggregated status of the underlying assets of the lake.
- create
Time string Output only. The time when the lake was created.
- description string
Optional. Description of the lake.
- display
Name string Optional. User friendly display name.
- labels {[key: string]: string}
Optional. User-defined labels for the lake.
- location string
The location for the resource
- metastore
Lake
Metastore Optional. Settings to manage lake and Dataproc Metastore service instance association.
- metastore
Statuses LakeMetastore Status[] Output only. Metastore status of the lake.
- name string
The name of the lake.
- project string
The project for the resource
- service
Account 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.
- update
Time string Output only. The time when the lake was last updated.
- asset_
statuses Sequence[LakeAsset Status Args] 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.
- labels Mapping[str, str]
Optional. User-defined labels for the lake.
- location str
The location for the resource
- metastore
Lake
Metastore Args Optional. Settings to manage lake and Dataproc Metastore service instance association.
- metastore_
statuses Sequence[LakeMetastore Status Args] Output only. Metastore status of the lake.
- name str
The name of the lake.
- project str
The project for the resource
- 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.
- asset
Statuses List<Property Map> Output only. Aggregated status of the underlying assets of the lake.
- create
Time String Output only. The time when the lake was created.
- description String
Optional. Description of the lake.
- display
Name String Optional. User friendly display name.
- labels Map<String>
Optional. User-defined labels for the lake.
- location String
The location for the resource
- metastore Property Map
Optional. Settings to manage lake and Dataproc Metastore service instance association.
- metastore
Statuses List<Property Map> Output only. Metastore status of the lake.
- name String
The name of the lake.
- project String
The project for the resource
- service
Account 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.
- update
Time String Output only. The time when the lake was last updated.
Supporting Types
LakeAssetStatus, LakeAssetStatusArgs
- Active
Assets int - Security
Policy intApplying Assets - Update
Time string Output only. The time when the lake was last updated.
- Active
Assets int - Security
Policy intApplying Assets - Update
Time string Output only. The time when the lake was last updated.
- active
Assets Integer - security
Policy IntegerApplying Assets - update
Time String Output only. The time when the lake was last updated.
- active
Assets number - security
Policy numberApplying Assets - update
Time string Output only. The time when the lake was last updated.
- active_
assets int - security_
policy_ intapplying_ assets - update_
time str Output only. The time when the lake was last updated.
- active
Assets Number - security
Policy NumberApplying Assets - update
Time 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
- Message string
- State string
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- Update
Time string Output only. The time when the lake was last updated.
- Endpoint string
- Message string
- State string
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- Update
Time string Output only. The time when the lake was last updated.
- endpoint String
- message String
- state String
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- update
Time String Output only. The time when the lake was last updated.
- endpoint string
- message string
- state string
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- update
Time string Output only. The time when the lake was last updated.
- endpoint str
- message str
- 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
- message String
- state String
Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
- update
Time String Output only. The time when the lake was last updated.
Import
Lake can be imported using any of these accepted formats
$ 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}}
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.