Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dataplex
  5. dataplex/v1
  6. Lake

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.dataplex/v1.Lake

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a lake resource. Auto-naming is currently not supported for this resource.

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,
         lake_id: Optional[str] = None,
         description: Optional[str] = None,
         display_name: Optional[str] = None,
         labels: Optional[Mapping[str, str]] = None,
         location: Optional[str] = None,
         metastore: Optional[GoogleCloudDataplexV1LakeMetastoreArgs] = 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: google-native:dataplex/v1: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 GoogleNative.Dataplex.V1.Lake("lakeResource", new()
{
    LakeId = "string",
    Description = "string",
    DisplayName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Metastore = new GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1LakeMetastoreArgs
    {
        Service = "string",
    },
    Project = "string",
});
Copy
example, err := dataplex.NewLake(ctx, "lakeResource", &dataplex.LakeArgs{
	LakeId:      pulumi.String("string"),
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Metastore: &dataplex.GoogleCloudDataplexV1LakeMetastoreArgs{
		Service: pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})
Copy
var lakeResource = new Lake("lakeResource", LakeArgs.builder()
    .lakeId("string")
    .description("string")
    .displayName("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .metastore(GoogleCloudDataplexV1LakeMetastoreArgs.builder()
        .service("string")
        .build())
    .project("string")
    .build());
Copy
lake_resource = google_native.dataplex.v1.Lake("lakeResource",
    lake_id="string",
    description="string",
    display_name="string",
    labels={
        "string": "string",
    },
    location="string",
    metastore={
        "service": "string",
    },
    project="string")
Copy
const lakeResource = new google_native.dataplex.v1.Lake("lakeResource", {
    lakeId: "string",
    description: "string",
    displayName: "string",
    labels: {
        string: "string",
    },
    location: "string",
    metastore: {
        service: "string",
    },
    project: "string",
});
Copy
type: google-native:dataplex/v1:Lake
properties:
    description: string
    displayName: string
    labels:
        string: string
    lakeId: string
    location: string
    metastore:
        service: 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:

LakeId
This property is required.
Changes to this property will trigger replacement.
string
Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.
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.
Location Changes to this property will trigger replacement. string
Metastore Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1LakeMetastore
Optional. Settings to manage lake and Dataproc Metastore service instance association.
Project Changes to this property will trigger replacement. string
LakeId
This property is required.
Changes to this property will trigger replacement.
string
Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.
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.
Location Changes to this property will trigger replacement. string
Metastore GoogleCloudDataplexV1LakeMetastoreArgs
Optional. Settings to manage lake and Dataproc Metastore service instance association.
Project Changes to this property will trigger replacement. string
lakeId
This property is required.
Changes to this property will trigger replacement.
String
Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.
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.
location Changes to this property will trigger replacement. String
metastore GoogleCloudDataplexV1LakeMetastore
Optional. Settings to manage lake and Dataproc Metastore service instance association.
project Changes to this property will trigger replacement. String
lakeId
This property is required.
Changes to this property will trigger replacement.
string
Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.
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.
location Changes to this property will trigger replacement. string
metastore GoogleCloudDataplexV1LakeMetastore
Optional. Settings to manage lake and Dataproc Metastore service instance association.
project Changes to this property will trigger replacement. string
lake_id
This property is required.
Changes to this property will trigger replacement.
str
Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.
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 Changes to this property will trigger replacement. str
metastore GoogleCloudDataplexV1LakeMetastoreArgs
Optional. Settings to manage lake and Dataproc Metastore service instance association.
project Changes to this property will trigger replacement. str
lakeId
This property is required.
Changes to this property will trigger replacement.
String
Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location.
description String
Optional. Description of the lake.
displayName String
Optional. User friendly display name.
labels Map<String>
Optional. User-defined labels for the lake.
location Changes to this property will trigger replacement. String
metastore Property Map
Optional. Settings to manage lake and Dataproc Metastore service instance association.
project Changes to this property will trigger replacement. String

Outputs

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

AssetStatus Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1AssetStatusResponse
Aggregated status of the underlying assets of the lake.
CreateTime string
The time when the lake was created.
Id string
The provider-assigned unique ID for this managed resource.
MetastoreStatus Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1LakeMetastoreStatusResponse
Metastore status of the lake.
Name string
The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.
ServiceAccount string
Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
State string
Current state of the lake.
Uid string
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
The time when the lake was last updated.
AssetStatus GoogleCloudDataplexV1AssetStatusResponse
Aggregated status of the underlying assets of the lake.
CreateTime string
The time when the lake was created.
Id string
The provider-assigned unique ID for this managed resource.
MetastoreStatus GoogleCloudDataplexV1LakeMetastoreStatusResponse
Metastore status of the lake.
Name string
The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.
ServiceAccount string
Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
State string
Current state of the lake.
Uid string
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
The time when the lake was last updated.
assetStatus GoogleCloudDataplexV1AssetStatusResponse
Aggregated status of the underlying assets of the lake.
createTime String
The time when the lake was created.
id String
The provider-assigned unique ID for this managed resource.
metastoreStatus GoogleCloudDataplexV1LakeMetastoreStatusResponse
Metastore status of the lake.
name String
The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.
serviceAccount String
Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
state String
Current state of the lake.
uid String
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
The time when the lake was last updated.
assetStatus GoogleCloudDataplexV1AssetStatusResponse
Aggregated status of the underlying assets of the lake.
createTime string
The time when the lake was created.
id string
The provider-assigned unique ID for this managed resource.
metastoreStatus GoogleCloudDataplexV1LakeMetastoreStatusResponse
Metastore status of the lake.
name string
The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.
serviceAccount string
Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
state string
Current state of the lake.
uid string
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
The time when the lake was last updated.
asset_status GoogleCloudDataplexV1AssetStatusResponse
Aggregated status of the underlying assets of the lake.
create_time str
The time when the lake was created.
id str
The provider-assigned unique ID for this managed resource.
metastore_status GoogleCloudDataplexV1LakeMetastoreStatusResponse
Metastore status of the lake.
name str
The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.
service_account str
Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
state str
Current state of the lake.
uid str
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
The time when the lake was last updated.
assetStatus Property Map
Aggregated status of the underlying assets of the lake.
createTime String
The time when the lake was created.
id String
The provider-assigned unique ID for this managed resource.
metastoreStatus Property Map
Metastore status of the lake.
name String
The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.
serviceAccount String
Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
state String
Current state of the lake.
uid String
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
The time when the lake was last updated.

Supporting Types

GoogleCloudDataplexV1AssetStatusResponse
, GoogleCloudDataplexV1AssetStatusResponseArgs

ActiveAssets This property is required. int
Number of active assets.
SecurityPolicyApplyingAssets This property is required. int
Number of assets that are in process of updating the security policy on attached resources.
UpdateTime This property is required. string
Last update time of the status.
ActiveAssets This property is required. int
Number of active assets.
SecurityPolicyApplyingAssets This property is required. int
Number of assets that are in process of updating the security policy on attached resources.
UpdateTime This property is required. string
Last update time of the status.
activeAssets This property is required. Integer
Number of active assets.
securityPolicyApplyingAssets This property is required. Integer
Number of assets that are in process of updating the security policy on attached resources.
updateTime This property is required. String
Last update time of the status.
activeAssets This property is required. number
Number of active assets.
securityPolicyApplyingAssets This property is required. number
Number of assets that are in process of updating the security policy on attached resources.
updateTime This property is required. string
Last update time of the status.
active_assets This property is required. int
Number of active assets.
security_policy_applying_assets This property is required. int
Number of assets that are in process of updating the security policy on attached resources.
update_time This property is required. str
Last update time of the status.
activeAssets This property is required. Number
Number of active assets.
securityPolicyApplyingAssets This property is required. Number
Number of assets that are in process of updating the security policy on attached resources.
updateTime This property is required. String
Last update time of the status.

GoogleCloudDataplexV1LakeMetastore
, GoogleCloudDataplexV1LakeMetastoreArgs

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}

GoogleCloudDataplexV1LakeMetastoreResponse
, GoogleCloudDataplexV1LakeMetastoreResponseArgs

Service This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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}

GoogleCloudDataplexV1LakeMetastoreStatusResponse
, GoogleCloudDataplexV1LakeMetastoreStatusResponseArgs

Endpoint This property is required. string
The URI of the endpoint used to access the Metastore service.
Message This property is required. string
Additional information about the current status.
State This property is required. string
Current state of association.
UpdateTime This property is required. string
Last update time of the metastore status of the lake.
Endpoint This property is required. string
The URI of the endpoint used to access the Metastore service.
Message This property is required. string
Additional information about the current status.
State This property is required. string
Current state of association.
UpdateTime This property is required. string
Last update time of the metastore status of the lake.
endpoint This property is required. String
The URI of the endpoint used to access the Metastore service.
message This property is required. String
Additional information about the current status.
state This property is required. String
Current state of association.
updateTime This property is required. String
Last update time of the metastore status of the lake.
endpoint This property is required. string
The URI of the endpoint used to access the Metastore service.
message This property is required. string
Additional information about the current status.
state This property is required. string
Current state of association.
updateTime This property is required. string
Last update time of the metastore status of the lake.
endpoint This property is required. str
The URI of the endpoint used to access the Metastore service.
message This property is required. str
Additional information about the current status.
state This property is required. str
Current state of association.
update_time This property is required. str
Last update time of the metastore status of the lake.
endpoint This property is required. String
The URI of the endpoint used to access the Metastore service.
message This property is required. String
Additional information about the current status.
state This property is required. String
Current state of association.
updateTime This property is required. String
Last update time of the metastore status of the lake.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native