com.pulumi.gcp.datacatalog.kotlin.TaxonomyArgs.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
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.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.datacatalog.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.datacatalog.TaxonomyArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* A collection of policy tags that classify data along a common axis.
* To get more information about Taxonomy, see:
* * [API documentation](https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.taxonomies)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/data-catalog/docs)
* ## Example Usage
* ### Data Catalog Taxonomy Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const basicTaxonomy = new gcp.datacatalog.Taxonomy("basic_taxonomy", {
* displayName: "my_taxonomy",
* description: "A collection of policy tags",
* activatedPolicyTypes: ["FINE_GRAINED_ACCESS_CONTROL"],
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* basic_taxonomy = gcp.datacatalog.Taxonomy("basic_taxonomy",
* display_name="my_taxonomy",
* description="A collection of policy tags",
* activated_policy_types=["FINE_GRAINED_ACCESS_CONTROL"])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var basicTaxonomy = new Gcp.DataCatalog.Taxonomy("basic_taxonomy", new()
* {
* DisplayName = "my_taxonomy",
* Description = "A collection of policy tags",
* ActivatedPolicyTypes = new[]
* {
* "FINE_GRAINED_ACCESS_CONTROL",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/datacatalog"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := datacatalog.NewTaxonomy(ctx, "basic_taxonomy", &datacatalog.TaxonomyArgs{
* DisplayName: pulumi.String("my_taxonomy"),
* Description: pulumi.String("A collection of policy tags"),
* ActivatedPolicyTypes: pulumi.StringArray{
* pulumi.String("FINE_GRAINED_ACCESS_CONTROL"),
* },
* })
* 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.datacatalog.Taxonomy;
* import com.pulumi.gcp.datacatalog.TaxonomyArgs;
* 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 basicTaxonomy = new Taxonomy("basicTaxonomy", TaxonomyArgs.builder()
* .displayName("my_taxonomy")
* .description("A collection of policy tags")
* .activatedPolicyTypes("FINE_GRAINED_ACCESS_CONTROL")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* basicTaxonomy:
* type: gcp:datacatalog:Taxonomy
* name: basic_taxonomy
* properties:
* displayName: my_taxonomy
* description: A collection of policy tags
* activatedPolicyTypes:
* - FINE_GRAINED_ACCESS_CONTROL
* ```
*
* ## Import
* Taxonomy can be imported using any of these accepted formats:
* * `{{name}}`
* When using the `pulumi import` command, Taxonomy can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:datacatalog/taxonomy:Taxonomy default {{name}}
* ```
* @property activatedPolicyTypes A list of policy types that are activated for this taxonomy. If not set,
* defaults to an empty list.
* Each value may be one of: `POLICY_TYPE_UNSPECIFIED`, `FINE_GRAINED_ACCESS_CONTROL`.
* @property description Description of this taxonomy. It must: contain only unicode characters,
* tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes
* long when encoded in UTF-8. If not set, defaults to an empty description.
* @property displayName User defined name of this taxonomy.
* The taxonomy display name must be unique within an organization.
* It must: contain only unicode letters, numbers, underscores, dashes
* and spaces; not start or end with spaces; and be at most 200 bytes
* long when encoded in UTF-8.
* - - -
* @property project The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
* @property region Taxonomy location region.
*/
public data class TaxonomyArgs(
public val activatedPolicyTypes: Output>? = null,
public val description: Output? = null,
public val displayName: Output? = null,
public val project: Output? = null,
public val region: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.datacatalog.TaxonomyArgs =
com.pulumi.gcp.datacatalog.TaxonomyArgs.builder()
.activatedPolicyTypes(activatedPolicyTypes?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.description(description?.applyValue({ args0 -> args0 }))
.displayName(displayName?.applyValue({ args0 -> args0 }))
.project(project?.applyValue({ args0 -> args0 }))
.region(region?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [TaxonomyArgs].
*/
@PulumiTagMarker
public class TaxonomyArgsBuilder internal constructor() {
private var activatedPolicyTypes: Output>? = null
private var description: Output? = null
private var displayName: Output? = null
private var project: Output? = null
private var region: Output? = null
/**
* @param value A list of policy types that are activated for this taxonomy. If not set,
* defaults to an empty list.
* Each value may be one of: `POLICY_TYPE_UNSPECIFIED`, `FINE_GRAINED_ACCESS_CONTROL`.
*/
@JvmName("ipsgtdbipgwbrmlv")
public suspend fun activatedPolicyTypes(`value`: Output>) {
this.activatedPolicyTypes = value
}
@JvmName("amjdphxllhgescqu")
public suspend fun activatedPolicyTypes(vararg values: Output) {
this.activatedPolicyTypes = Output.all(values.asList())
}
/**
* @param values A list of policy types that are activated for this taxonomy. If not set,
* defaults to an empty list.
* Each value may be one of: `POLICY_TYPE_UNSPECIFIED`, `FINE_GRAINED_ACCESS_CONTROL`.
*/
@JvmName("qeshjpoqvlxujfvk")
public suspend fun activatedPolicyTypes(values: List>) {
this.activatedPolicyTypes = Output.all(values)
}
/**
* @param value Description of this taxonomy. It must: contain only unicode characters,
* tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes
* long when encoded in UTF-8. If not set, defaults to an empty description.
*/
@JvmName("dycebnknjycjulfc")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value User defined name of this taxonomy.
* The taxonomy display name must be unique within an organization.
* It must: contain only unicode letters, numbers, underscores, dashes
* and spaces; not start or end with spaces; and be at most 200 bytes
* long when encoded in UTF-8.
* - - -
*/
@JvmName("gmdgnyqqufrdxtjv")
public suspend fun displayName(`value`: Output) {
this.displayName = value
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("dqvvhecxokytcmij")
public suspend fun project(`value`: Output) {
this.project = value
}
/**
* @param value Taxonomy location region.
*/
@JvmName("hvvvqysighputwut")
public suspend fun region(`value`: Output) {
this.region = value
}
/**
* @param value A list of policy types that are activated for this taxonomy. If not set,
* defaults to an empty list.
* Each value may be one of: `POLICY_TYPE_UNSPECIFIED`, `FINE_GRAINED_ACCESS_CONTROL`.
*/
@JvmName("slrsutixnlifjscf")
public suspend fun activatedPolicyTypes(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.activatedPolicyTypes = mapped
}
/**
* @param values A list of policy types that are activated for this taxonomy. If not set,
* defaults to an empty list.
* Each value may be one of: `POLICY_TYPE_UNSPECIFIED`, `FINE_GRAINED_ACCESS_CONTROL`.
*/
@JvmName("rakucwmjrcrsloxl")
public suspend fun activatedPolicyTypes(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.activatedPolicyTypes = mapped
}
/**
* @param value Description of this taxonomy. It must: contain only unicode characters,
* tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes
* long when encoded in UTF-8. If not set, defaults to an empty description.
*/
@JvmName("degeuvyukrikrtgx")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value User defined name of this taxonomy.
* The taxonomy display name must be unique within an organization.
* It must: contain only unicode letters, numbers, underscores, dashes
* and spaces; not start or end with spaces; and be at most 200 bytes
* long when encoded in UTF-8.
* - - -
*/
@JvmName("jdhsuytpglrmixou")
public suspend fun displayName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.displayName = mapped
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("ttdewhltonluijee")
public suspend fun project(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.project = mapped
}
/**
* @param value Taxonomy location region.
*/
@JvmName("gpugkjbniumvxcjc")
public suspend fun region(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.region = mapped
}
internal fun build(): TaxonomyArgs = TaxonomyArgs(
activatedPolicyTypes = activatedPolicyTypes,
description = description,
displayName = displayName,
project = project,
region = region,
)
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy