com.pulumi.gcp.dataplex.kotlin.Lake.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 8.20.1.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.dataplex.kotlin

import com.pulumi.core.Output
import com.pulumi.gcp.dataplex.kotlin.outputs.LakeAssetStatus
import com.pulumi.gcp.dataplex.kotlin.outputs.LakeMetastore
import com.pulumi.gcp.dataplex.kotlin.outputs.LakeMetastoreStatus
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import com.pulumi.gcp.dataplex.kotlin.outputs.LakeAssetStatus.Companion.toKotlin as lakeAssetStatusToKotlin
import com.pulumi.gcp.dataplex.kotlin.outputs.LakeMetastore.Companion.toKotlin as lakeMetastoreToKotlin
import com.pulumi.gcp.dataplex.kotlin.outputs.LakeMetastoreStatus.Companion.toKotlin as lakeMetastoreStatusToKotlin

/**
 * Builder for [Lake].
 */
@PulumiTagMarker
public class LakeResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: LakeArgs = LakeArgs()

    public var opts: CustomResourceOptions = CustomResourceOptions()

    /**
     * @param name The _unique_ name of the resulting resource.
     */
    public fun name(`value`: String) {
        this.name = value
    }

    /**
     * @param block The arguments to use to populate this resource's properties.
     */
    public suspend fun args(block: suspend LakeArgsBuilder.() -> Unit) {
        val builder = LakeArgsBuilder()
        block(builder)
        this.args = builder.build()
    }

    /**
     * @param block A bag of options that control this resource's behavior.
     */
    public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
        this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
    }

    internal fun build(): Lake {
        val builtJavaResource = com.pulumi.gcp.dataplex.Lake(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return Lake(builtJavaResource)
    }
}

/**
 * The Dataplex Lake resource
 * ## Example Usage
 * ### Basic_lake
 * A basic example of a dataplex lake
 * 
 * ```typescript
 * 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",
 *     },
 * });
 * ```
 * ```python
 * 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",
 *     })
 * ```
 * ```csharp
 * 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" },
 *         },
 *     });
 * });
 * ```
 * ```go
 * 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
 * 	})
 * }
 * ```
 * ```java
 * 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());
 *     }
 * }
 * ```
 * ```yaml
 * 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:
 * ```sh
 * $ pulumi import gcp:dataplex/lake:Lake default projects/{{project}}/locations/{{location}}/lakes/{{name}}
 * ```
 * ```sh
 * $ pulumi import gcp:dataplex/lake:Lake default {{project}}/{{location}}/{{name}}
 * ```
 * ```sh
 * $ pulumi import gcp:dataplex/lake:Lake default {{location}}/{{name}}
 * ```
 */
public class Lake internal constructor(
    override val javaResource: com.pulumi.gcp.dataplex.Lake,
) : KotlinCustomResource(javaResource, LakeMapper) {
    /**
     * Output only. Aggregated status of the underlying assets of the lake.
     */
    public val assetStatuses: Output>
        get() = javaResource.assetStatuses().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 -> lakeAssetStatusToKotlin(args0) })
            })
        })

    /**
     * Output only. The time when the lake was created.
     */
    public val createTime: Output
        get() = javaResource.createTime().applyValue({ args0 -> args0 })

    /**
     * Optional. Description of the lake.
     */
    public val description: Output?
        get() = javaResource.description().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Optional. User friendly display name.
     */
    public val displayName: Output?
        get() = javaResource.displayName().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    public val effectiveLabels: Output>
        get() = javaResource.effectiveLabels().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.key.to(args0.value)
            }).toMap()
        })

    /**
     * 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.
     */
    public val labels: Output>?
        get() = javaResource.labels().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.key.to(args0.value)
                }).toMap()
            }).orElse(null)
        })

    /**
     * The location for the resource
     */
    public val location: Output
        get() = javaResource.location().applyValue({ args0 -> args0 })

    /**
     * Optional. Settings to manage lake and Dataproc Metastore service instance association.
     */
    public val metastore: Output?
        get() = javaResource.metastore().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    lakeMetastoreToKotlin(args0)
                })
            }).orElse(null)
        })

    /**
     * Output only. Metastore status of the lake.
     */
    public val metastoreStatuses: Output>
        get() = javaResource.metastoreStatuses().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 -> lakeMetastoreStatusToKotlin(args0) })
            })
        })

    /**
     * The name of the lake.
     * - - -
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The project for the resource
     */
    public val project: Output
        get() = javaResource.project().applyValue({ args0 -> args0 })

    /**
     * The combination of labels configured directly on the resource and default labels configured on the provider.
     */
    public val pulumiLabels: Output>
        get() = javaResource.pulumiLabels().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.key.to(args0.value)
            }).toMap()
        })

    /**
     * Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
     */
    public val serviceAccount: Output
        get() = javaResource.serviceAccount().applyValue({ args0 -> args0 })

    /**
     * Output only. Current state of the lake. Possible values: STATE_UNSPECIFIED, ACTIVE, CREATING, DELETING, ACTION_REQUIRED
     */
    public val state: Output
        get() = javaResource.state().applyValue({ args0 -> args0 })

    /**
     * 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.
     */
    public val uid: Output
        get() = javaResource.uid().applyValue({ args0 -> args0 })

    /**
     * Output only. The time when the lake was last updated.
     */
    public val updateTime: Output
        get() = javaResource.updateTime().applyValue({ args0 -> args0 })
}

public object LakeMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gcp.dataplex.Lake::class == javaResource::class

    override fun map(javaResource: Resource): Lake = Lake(
        javaResource as
            com.pulumi.gcp.dataplex.Lake,
    )
}

/**
 * @see [Lake].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [Lake].
 */
public suspend fun lake(name: String, block: suspend LakeResourceBuilder.() -> Unit): Lake {
    val builder = LakeResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [Lake].
 * @param name The _unique_ name of the resulting resource.
 */
public fun lake(name: String): Lake {
    val builder = LakeResourceBuilder()
    builder.name(name)
    return builder.build()
}