com.pulumi.gcp.dataplex.kotlin.EntryGroup.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.13.1.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.dataplex.kotlin

import com.pulumi.core.Output
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.Map

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

    public var args: EntryGroupArgs = EntryGroupArgs()

    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 EntryGroupArgsBuilder.() -> Unit) {
        val builder = EntryGroupArgsBuilder()
        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(): EntryGroup {
        val builtJavaResource = com.pulumi.gcp.dataplex.EntryGroup(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return EntryGroup(builtJavaResource)
    }
}

/**
 * An Entry Group represents a logical grouping of one or more Entries.
 * ## Example Usage
 * ### Dataplex Entry Group Basic
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const testEntryGroupBasic = new gcp.dataplex.EntryGroup("test_entry_group_basic", {
 *     entryGroupId: "entry-group-basic",
 *     project: "my-project-name",
 *     location: "us-central1",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * test_entry_group_basic = gcp.dataplex.EntryGroup("test_entry_group_basic",
 *     entry_group_id="entry-group-basic",
 *     project="my-project-name",
 *     location="us-central1")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var testEntryGroupBasic = new Gcp.DataPlex.EntryGroup("test_entry_group_basic", new()
 *     {
 *         EntryGroupId = "entry-group-basic",
 *         Project = "my-project-name",
 *         Location = "us-central1",
 *     });
 * });
 * ```
 * ```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.NewEntryGroup(ctx, "test_entry_group_basic", &dataplex.EntryGroupArgs{
 * 			EntryGroupId: pulumi.String("entry-group-basic"),
 * 			Project:      pulumi.String("my-project-name"),
 * 			Location:     pulumi.String("us-central1"),
 * 		})
 * 		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.EntryGroup;
 * import com.pulumi.gcp.dataplex.EntryGroupArgs;
 * 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 testEntryGroupBasic = new EntryGroup("testEntryGroupBasic", EntryGroupArgs.builder()
 *             .entryGroupId("entry-group-basic")
 *             .project("my-project-name")
 *             .location("us-central1")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   testEntryGroupBasic:
 *     type: gcp:dataplex:EntryGroup
 *     name: test_entry_group_basic
 *     properties:
 *       entryGroupId: entry-group-basic
 *       project: my-project-name
 *       location: us-central1
 * ```
 * 
 * ### Dataplex Entry Group Full
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const testEntryGroupFull = new gcp.dataplex.EntryGroup("test_entry_group_full", {
 *     entryGroupId: "entry-group-full",
 *     project: "my-project-name",
 *     location: "us-central1",
 *     labels: {
 *         tag: "test-tf",
 *     },
 *     displayName: "terraform entry group",
 *     description: "entry group created by Terraform",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * test_entry_group_full = gcp.dataplex.EntryGroup("test_entry_group_full",
 *     entry_group_id="entry-group-full",
 *     project="my-project-name",
 *     location="us-central1",
 *     labels={
 *         "tag": "test-tf",
 *     },
 *     display_name="terraform entry group",
 *     description="entry group created by Terraform")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var testEntryGroupFull = new Gcp.DataPlex.EntryGroup("test_entry_group_full", new()
 *     {
 *         EntryGroupId = "entry-group-full",
 *         Project = "my-project-name",
 *         Location = "us-central1",
 *         Labels =
 *         {
 *             { "tag", "test-tf" },
 *         },
 *         DisplayName = "terraform entry group",
 *         Description = "entry group created by Terraform",
 *     });
 * });
 * ```
 * ```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.NewEntryGroup(ctx, "test_entry_group_full", &dataplex.EntryGroupArgs{
 * 			EntryGroupId: pulumi.String("entry-group-full"),
 * 			Project:      pulumi.String("my-project-name"),
 * 			Location:     pulumi.String("us-central1"),
 * 			Labels: pulumi.StringMap{
 * 				"tag": pulumi.String("test-tf"),
 * 			},
 * 			DisplayName: pulumi.String("terraform entry group"),
 * 			Description: pulumi.String("entry group created by Terraform"),
 * 		})
 * 		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.EntryGroup;
 * import com.pulumi.gcp.dataplex.EntryGroupArgs;
 * 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 testEntryGroupFull = new EntryGroup("testEntryGroupFull", EntryGroupArgs.builder()
 *             .entryGroupId("entry-group-full")
 *             .project("my-project-name")
 *             .location("us-central1")
 *             .labels(Map.of("tag", "test-tf"))
 *             .displayName("terraform entry group")
 *             .description("entry group created by Terraform")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   testEntryGroupFull:
 *     type: gcp:dataplex:EntryGroup
 *     name: test_entry_group_full
 *     properties:
 *       entryGroupId: entry-group-full
 *       project: my-project-name
 *       location: us-central1
 *       labels:
 *         tag: test-tf
 *       displayName: terraform entry group
 *       description: entry group created by Terraform
 * ```
 * 
 * ## Import
 * EntryGroup can be imported using any of these accepted formats:
 * * `projects/{{project}}/locations/{{location}}/entryGroups/{{entry_group_id}}`
 * * `{{project}}/{{location}}/{{entry_group_id}}`
 * * `{{location}}/{{entry_group_id}}`
 * When using the `pulumi import` command, EntryGroup can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:dataplex/entryGroup:EntryGroup default projects/{{project}}/locations/{{location}}/entryGroups/{{entry_group_id}}
 * ```
 * ```sh
 * $ pulumi import gcp:dataplex/entryGroup:EntryGroup default {{project}}/{{location}}/{{entry_group_id}}
 * ```
 * ```sh
 * $ pulumi import gcp:dataplex/entryGroup:EntryGroup default {{location}}/{{entry_group_id}}
 * ```
 */
public class EntryGroup internal constructor(
    override val javaResource: com.pulumi.gcp.dataplex.EntryGroup,
) : KotlinCustomResource(javaResource, EntryGroupMapper) {
    /**
     * The time when the EntryGroup was created.
     */
    public val createTime: Output
        get() = javaResource.createTime().applyValue({ args0 -> args0 })

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

    /**
     * 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()
        })

    /**
     * The entry group id of the entry group.
     */
    public val entryGroupId: Output?
        get() = javaResource.entryGroupId().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * User-defined labels for the EntryGroup.
     * **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 where entry group will be created in.
     */
    public val location: Output?
        get() = javaResource.location().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    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()
        })

    /**
     * Denotes the transfer status of the Entry Group. It is unspecified
     * for Entry Group created from Dataplex API.
     */
    public val transferStatus: Output
        get() = javaResource.transferStatus().applyValue({ args0 -> args0 })

    /**
     * System generated globally unique ID for the EntryGroup. This ID will be different if the EntryGroup is deleted and re-created with the same name.
     */
    public val uid: Output
        get() = javaResource.uid().applyValue({ args0 -> args0 })

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

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

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

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

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