Docs Home
Google Cloud v8.33.0 published on Wednesday, Jun 4, 2025 by Pulumi
gcp.dataplex.GlossaryCategory
Explore with Pulumi AI
Represents a collection of categories and terms within a Glossary that are related to each other.
Example Usage
Dataplex Glossary Category Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const categoryTestId = new gcp.dataplex.Glossary("category_test_id", {
glossaryId: "tf-test-glossary_72490",
location: "us-central1",
});
const categoryTestIdGlossaryCategory = new gcp.dataplex.GlossaryCategory("category_test_id", {
parent: pulumi.interpolate`projects/${categoryTestId.project}/locations/us-central1/glossaries/${categoryTestId.glossaryId}`,
glossaryId: categoryTestId.glossaryId,
location: "us-central1",
categoryId: "tf-test-category-basic_89605",
});
import pulumi
import pulumi_gcp as gcp
category_test_id = gcp.dataplex.Glossary("category_test_id",
glossary_id="tf-test-glossary_72490",
location="us-central1")
category_test_id_glossary_category = gcp.dataplex.GlossaryCategory("category_test_id",
parent=pulumi.Output.all(
project=category_test_id.project,
glossary_id=category_test_id.glossary_id
).apply(lambda resolved_outputs: f"projects/{resolved_outputs['project']}/locations/us-central1/glossaries/{resolved_outputs['glossary_id']}")
,
glossary_id=category_test_id.glossary_id,
location="us-central1",
category_id="tf-test-category-basic_89605")
package main
import (
"fmt"
"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 {
categoryTestId, err := dataplex.NewGlossary(ctx, "category_test_id", &dataplex.GlossaryArgs{
GlossaryId: pulumi.String("tf-test-glossary_72490"),
Location: pulumi.String("us-central1"),
})
if err != nil {
return err
}
_, err = dataplex.NewGlossaryCategory(ctx, "category_test_id", &dataplex.GlossaryCategoryArgs{
Parent: pulumi.All(categoryTestId.Project, categoryTestId.GlossaryId).ApplyT(func(_args []interface{}) (string, error) {
project := _args[0].(string)
glossaryId := _args[1].(string)
return fmt.Sprintf("projects/%v/locations/us-central1/glossaries/%v", project, glossaryId), nil
}).(pulumi.StringOutput),
GlossaryId: categoryTestId.GlossaryId,
Location: pulumi.String("us-central1"),
CategoryId: pulumi.String("tf-test-category-basic_89605"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var categoryTestId = new Gcp.DataPlex.Glossary("category_test_id", new()
{
GlossaryId = "tf-test-glossary_72490",
Location = "us-central1",
});
var categoryTestIdGlossaryCategory = new Gcp.DataPlex.GlossaryCategory("category_test_id", new()
{
Parent = Output.Tuple(categoryTestId.Project, categoryTestId.GlossaryId).Apply(values =>
{
var project = values.Item1;
var glossaryId = values.Item2;
return $"projects/{project}/locations/us-central1/glossaries/{glossaryId}";
}),
GlossaryId = categoryTestId.GlossaryId,
Location = "us-central1",
CategoryId = "tf-test-category-basic_89605",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.dataplex.Glossary;
import com.pulumi.gcp.dataplex.GlossaryArgs;
import com.pulumi.gcp.dataplex.GlossaryCategory;
import com.pulumi.gcp.dataplex.GlossaryCategoryArgs;
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 categoryTestId = new Glossary("categoryTestId", GlossaryArgs.builder()
.glossaryId("tf-test-glossary_72490")
.location("us-central1")
.build());
var categoryTestIdGlossaryCategory = new GlossaryCategory("categoryTestIdGlossaryCategory", GlossaryCategoryArgs.builder()
.parent(Output.tuple(categoryTestId.project(), categoryTestId.glossaryId()).applyValue(values -> {
var project = values.t1;
var glossaryId = values.t2;
return String.format("projects/%s/locations/us-central1/glossaries/%s", project,glossaryId);
}))
.glossaryId(categoryTestId.glossaryId())
.location("us-central1")
.categoryId("tf-test-category-basic_89605")
.build());
}
}
resources:
categoryTestId:
type: gcp:dataplex:Glossary
name: category_test_id
properties:
glossaryId: tf-test-glossary_72490
location: us-central1
categoryTestIdGlossaryCategory:
type: gcp:dataplex:GlossaryCategory
name: category_test_id
properties:
parent: projects/${categoryTestId.project}/locations/us-central1/glossaries/${categoryTestId.glossaryId}
glossaryId: ${categoryTestId.glossaryId}
location: us-central1
categoryId: tf-test-category-basic_89605
Dataplex Glossary Category Full
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const categoryTestIdFull = new gcp.dataplex.Glossary("category_test_id_full", {
glossaryId: "tf-test-glossary_56730",
location: "us-central1",
});
const categoryTestIdFullGlossaryCategory = new gcp.dataplex.GlossaryCategory("category_test_id_full", {
parent: pulumi.interpolate`projects/${categoryTestIdFull.project}/locations/us-central1/glossaries/${categoryTestIdFull.glossaryId}`,
glossaryId: categoryTestIdFull.glossaryId,
location: "us-central1",
categoryId: "tf-test-category-full_95154",
labels: {
tag: "test-tf",
},
displayName: "terraform category",
description: "category created by Terraform",
});
import pulumi
import pulumi_gcp as gcp
category_test_id_full = gcp.dataplex.Glossary("category_test_id_full",
glossary_id="tf-test-glossary_56730",
location="us-central1")
category_test_id_full_glossary_category = gcp.dataplex.GlossaryCategory("category_test_id_full",
parent=pulumi.Output.all(
project=category_test_id_full.project,
glossary_id=category_test_id_full.glossary_id
).apply(lambda resolved_outputs: f"projects/{resolved_outputs['project']}/locations/us-central1/glossaries/{resolved_outputs['glossary_id']}")
,
glossary_id=category_test_id_full.glossary_id,
location="us-central1",
category_id="tf-test-category-full_95154",
labels={
"tag": "test-tf",
},
display_name="terraform category",
description="category created by Terraform")
package main
import (
"fmt"
"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 {
categoryTestIdFull, err := dataplex.NewGlossary(ctx, "category_test_id_full", &dataplex.GlossaryArgs{
GlossaryId: pulumi.String("tf-test-glossary_56730"),
Location: pulumi.String("us-central1"),
})
if err != nil {
return err
}
_, err = dataplex.NewGlossaryCategory(ctx, "category_test_id_full", &dataplex.GlossaryCategoryArgs{
Parent: pulumi.All(categoryTestIdFull.Project, categoryTestIdFull.GlossaryId).ApplyT(func(_args []interface{}) (string, error) {
project := _args[0].(string)
glossaryId := _args[1].(string)
return fmt.Sprintf("projects/%v/locations/us-central1/glossaries/%v", project, glossaryId), nil
}).(pulumi.StringOutput),
GlossaryId: categoryTestIdFull.GlossaryId,
Location: pulumi.String("us-central1"),
CategoryId: pulumi.String("tf-test-category-full_95154"),
Labels: pulumi.StringMap{
"tag": pulumi.String("test-tf"),
},
DisplayName: pulumi.String("terraform category"),
Description: pulumi.String("category created by Terraform"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var categoryTestIdFull = new Gcp.DataPlex.Glossary("category_test_id_full", new()
{
GlossaryId = "tf-test-glossary_56730",
Location = "us-central1",
});
var categoryTestIdFullGlossaryCategory = new Gcp.DataPlex.GlossaryCategory("category_test_id_full", new()
{
Parent = Output.Tuple(categoryTestIdFull.Project, categoryTestIdFull.GlossaryId).Apply(values =>
{
var project = values.Item1;
var glossaryId = values.Item2;
return $"projects/{project}/locations/us-central1/glossaries/{glossaryId}";
}),
GlossaryId = categoryTestIdFull.GlossaryId,
Location = "us-central1",
CategoryId = "tf-test-category-full_95154",
Labels =
{
{ "tag", "test-tf" },
},
DisplayName = "terraform category",
Description = "category created by Terraform",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.dataplex.Glossary;
import com.pulumi.gcp.dataplex.GlossaryArgs;
import com.pulumi.gcp.dataplex.GlossaryCategory;
import com.pulumi.gcp.dataplex.GlossaryCategoryArgs;
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 categoryTestIdFull = new Glossary("categoryTestIdFull", GlossaryArgs.builder()
.glossaryId("tf-test-glossary_56730")
.location("us-central1")
.build());
var categoryTestIdFullGlossaryCategory = new GlossaryCategory("categoryTestIdFullGlossaryCategory", GlossaryCategoryArgs.builder()
.parent(Output.tuple(categoryTestIdFull.project(), categoryTestIdFull.glossaryId()).applyValue(values -> {
var project = values.t1;
var glossaryId = values.t2;
return String.format("projects/%s/locations/us-central1/glossaries/%s", project,glossaryId);
}))
.glossaryId(categoryTestIdFull.glossaryId())
.location("us-central1")
.categoryId("tf-test-category-full_95154")
.labels(Map.of("tag", "test-tf"))
.displayName("terraform category")
.description("category created by Terraform")
.build());
}
}
resources:
categoryTestIdFull:
type: gcp:dataplex:Glossary
name: category_test_id_full
properties:
glossaryId: tf-test-glossary_56730
location: us-central1
categoryTestIdFullGlossaryCategory:
type: gcp:dataplex:GlossaryCategory
name: category_test_id_full
properties:
parent: projects/${categoryTestIdFull.project}/locations/us-central1/glossaries/${categoryTestIdFull.glossaryId}
glossaryId: ${categoryTestIdFull.glossaryId}
location: us-central1
categoryId: tf-test-category-full_95154
labels:
tag: test-tf
displayName: terraform category
description: category created by Terraform
Create GlossaryCategory Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GlossaryCategory(name: string, args: GlossaryCategoryArgs, opts?: CustomResourceOptions);@overload
def GlossaryCategory(resource_name: str,
args: GlossaryCategoryArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GlossaryCategory(resource_name: str,
opts: Optional[ResourceOptions] = None,
location: Optional[str] = None,
parent: Optional[str] = None,
category_id: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
glossary_id: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
project: Optional[str] = None)func NewGlossaryCategory(ctx *Context, name string, args GlossaryCategoryArgs, opts ...ResourceOption) (*GlossaryCategory, error)public GlossaryCategory(string name, GlossaryCategoryArgs args, CustomResourceOptions? opts = null)
public GlossaryCategory(String name, GlossaryCategoryArgs args)
public GlossaryCategory(String name, GlossaryCategoryArgs args, CustomResourceOptions options)
type: gcp:dataplex:GlossaryCategory
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GlossaryCategoryArgs
- 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 GlossaryCategoryArgs
- 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 GlossaryCategoryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GlossaryCategoryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GlossaryCategoryArgs
- 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 glossaryCategoryResource = new Gcp.DataPlex.GlossaryCategory("glossaryCategoryResource", new()
{
Location = "string",
Parent = "string",
CategoryId = "string",
Description = "string",
DisplayName = "string",
GlossaryId = "string",
Labels =
{
{ "string", "string" },
},
Project = "string",
});
example, err := dataplex.NewGlossaryCategory(ctx, "glossaryCategoryResource", &dataplex.GlossaryCategoryArgs{
Location: pulumi.String("string"),
Parent: pulumi.String("string"),
CategoryId: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
GlossaryId: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Project: pulumi.String("string"),
})
var glossaryCategoryResource = new GlossaryCategory("glossaryCategoryResource", GlossaryCategoryArgs.builder()
.location("string")
.parent("string")
.categoryId("string")
.description("string")
.displayName("string")
.glossaryId("string")
.labels(Map.of("string", "string"))
.project("string")
.build());
glossary_category_resource = gcp.dataplex.GlossaryCategory("glossaryCategoryResource",
location="string",
parent="string",
category_id="string",
description="string",
display_name="string",
glossary_id="string",
labels={
"string": "string",
},
project="string")
const glossaryCategoryResource = new gcp.dataplex.GlossaryCategory("glossaryCategoryResource", {
location: "string",
parent: "string",
categoryId: "string",
description: "string",
displayName: "string",
glossaryId: "string",
labels: {
string: "string",
},
project: "string",
});
type: gcp:dataplex:GlossaryCategory
properties:
categoryId: string
description: string
displayName: string
glossaryId: string
labels:
string: string
location: string
parent: string
project: string
GlossaryCategory 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 GlossaryCategory resource accepts the following input properties:
- Location string
- The location where the glossary category should reside.
- Parent string
- The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- Category
Id string - The category id for creation.
- Description string
- The user-mutable description of the GlossaryCategory.
- Display
Name string - User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified.
- Glossary
Id string - The glossary id for creation.
- Labels Dictionary<string, string>
User-defined labels for the GlossaryCategory.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labelsfor all of the labels present on the resource.- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Location string
- The location where the glossary category should reside.
- Parent string
- The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- Category
Id string - The category id for creation.
- Description string
- The user-mutable description of the GlossaryCategory.
- Display
Name string - User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified.
- Glossary
Id string - The glossary id for creation.
- Labels map[string]string
User-defined labels for the GlossaryCategory.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labelsfor all of the labels present on the resource.- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- location String
- The location where the glossary category should reside.
- parent String
- The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- category
Id String - The category id for creation.
- description String
- The user-mutable description of the GlossaryCategory.
- display
Name String - User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified.
- glossary
Id String - The glossary id for creation.
- labels Map<String,String>
User-defined labels for the GlossaryCategory.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labelsfor all of the labels present on the resource.- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- location string
- The location where the glossary category should reside.
- parent string
- The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- category
Id string - The category id for creation.
- description string
- The user-mutable description of the GlossaryCategory.
- display
Name string - User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified.
- glossary
Id string - The glossary id for creation.
- labels {[key: string]: string}
User-defined labels for the GlossaryCategory.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labelsfor all of the labels present on the resource.- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- location str
- The location where the glossary category should reside.
- parent str
- The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- category_
id str - The category id for creation.
- description str
- The user-mutable description of the GlossaryCategory.
- display_
name str - User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified.
- glossary_
id str - The glossary id for creation.
- labels Mapping[str, str]
User-defined labels for the GlossaryCategory.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labelsfor all of the labels present on the resource.- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- location String
- The location where the glossary category should reside.
- parent String
- The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- category
Id String - The category id for creation.
- description String
- The user-mutable description of the GlossaryCategory.
- display
Name String - User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified.
- glossary
Id String - The glossary id for creation.
- labels Map<String>
User-defined labels for the GlossaryCategory.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labelsfor all of the labels present on the resource.- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the GlossaryCategory resource produces the following output properties:
- Create
Time string - The time at which the GlossaryCategory was created.
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Uid string
- System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
- Update
Time string - The time at which the GlossaryCategory was last updated.
- Create
Time string - The time at which the GlossaryCategory was created.
- Effective
Labels map[string]string - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Uid string
- System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
- Update
Time string - The time at which the GlossaryCategory was last updated.
- create
Time String - The time at which the GlossaryCategory was created.
- effective
Labels Map<String,String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- uid String
- System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
- update
Time String - The time at which the GlossaryCategory was last updated.
- create
Time string - The time at which the GlossaryCategory was created.
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- uid string
- System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
- update
Time string - The time at which the GlossaryCategory was last updated.
- create_
time str - The time at which the GlossaryCategory was created.
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- uid str
- System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
- update_
time str - The time at which the GlossaryCategory was last updated.
- create
Time String - The time at which the GlossaryCategory was created.
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- uid String
- System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
- update
Time String - The time at which the GlossaryCategory was last updated.
Look up Existing GlossaryCategory Resource
Get an existing GlossaryCategory 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?: GlossaryCategoryState, opts?: CustomResourceOptions): GlossaryCategory@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
category_id: Optional[str] = None,
create_time: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
effective_labels: Optional[Mapping[str, str]] = None,
glossary_id: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
name: Optional[str] = None,
parent: Optional[str] = None,
project: Optional[str] = None,
pulumi_labels: Optional[Mapping[str, str]] = None,
uid: Optional[str] = None,
update_time: Optional[str] = None) -> GlossaryCategoryfunc GetGlossaryCategory(ctx *Context, name string, id IDInput, state *GlossaryCategoryState, opts ...ResourceOption) (*GlossaryCategory, error)public static GlossaryCategory Get(string name, Input<string> id, GlossaryCategoryState? state, CustomResourceOptions? opts = null)public static GlossaryCategory get(String name, Output<String> id, GlossaryCategoryState state, CustomResourceOptions options)resources: _: type: gcp:dataplex:GlossaryCategory get: id: ${id}- 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.
- Category
Id string - The category id for creation.
- Create
Time string - The time at which the GlossaryCategory was created.
- Description string
- The user-mutable description of the GlossaryCategory.
- Display
Name string - User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified.
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Glossary
Id string - The glossary id for creation.
- Labels Dictionary<string, string>
User-defined labels for the GlossaryCategory.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labelsfor all of the labels present on the resource.- Location string
- The location where the glossary category should reside.
- Name string
- The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- Parent string
- The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Uid string
- System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
- Update
Time string - The time at which the GlossaryCategory was last updated.
- Category
Id string - The category id for creation.
- Create
Time string - The time at which the GlossaryCategory was created.
- Description string
- The user-mutable description of the GlossaryCategory.
- Display
Name string - User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified.
- Effective
Labels map[string]string - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Glossary
Id string - The glossary id for creation.
- Labels map[string]string
User-defined labels for the GlossaryCategory.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labelsfor all of the labels present on the resource.- Location string
- The location where the glossary category should reside.
- Name string
- The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- Parent string
- The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Uid string
- System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
- Update
Time string - The time at which the GlossaryCategory was last updated.
- category
Id String - The category id for creation.
- create
Time String - The time at which the GlossaryCategory was created.
- description String
- The user-mutable description of the GlossaryCategory.
- display
Name String - User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified.
- effective
Labels Map<String,String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- glossary
Id String - The glossary id for creation.
- labels Map<String,String>
User-defined labels for the GlossaryCategory.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labelsfor all of the labels present on the resource.- location String
- The location where the glossary category should reside.
- name String
- The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- parent String
- The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- uid String
- System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
- update
Time String - The time at which the GlossaryCategory was last updated.
- category
Id string - The category id for creation.
- create
Time string - The time at which the GlossaryCategory was created.
- description string
- The user-mutable description of the GlossaryCategory.
- display
Name string - User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified.
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- glossary
Id string - The glossary id for creation.
- labels {[key: string]: string}
User-defined labels for the GlossaryCategory.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labelsfor all of the labels present on the resource.- location string
- The location where the glossary category should reside.
- name string
- The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- parent string
- The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- uid string
- System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
- update
Time string - The time at which the GlossaryCategory was last updated.
- category_
id str - The category id for creation.
- create_
time str - The time at which the GlossaryCategory was created.
- description str
- The user-mutable description of the GlossaryCategory.
- display_
name str - User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified.
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- glossary_
id str - The glossary id for creation.
- labels Mapping[str, str]
User-defined labels for the GlossaryCategory.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labelsfor all of the labels present on the resource.- location str
- The location where the glossary category should reside.
- name str
- The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- parent str
- The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- uid str
- System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
- update_
time str - The time at which the GlossaryCategory was last updated.
- category
Id String - The category id for creation.
- create
Time String - The time at which the GlossaryCategory was created.
- description String
- The user-mutable description of the GlossaryCategory.
- display
Name String - User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified.
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- glossary
Id String - The glossary id for creation.
- labels Map<String>
User-defined labels for the GlossaryCategory.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labelsfor all of the labels present on the resource.- location String
- The location where the glossary category should reside.
- name String
- The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- parent String
- The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- uid String
- System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
- update
Time String - The time at which the GlossaryCategory was last updated.
Import
GlossaryCategory can be imported using any of these accepted formats:
projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/categories/{{category_id}}{{project}}/{{location}}/{{glossary_id}}/{{category_id}}{{location}}/{{glossary_id}}/{{category_id}}
When using the pulumi import command, GlossaryCategory can be imported using one of the formats above. For example:
$ pulumi import gcp:dataplex/glossaryCategory:GlossaryCategory default projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/categories/{{category_id}}
$ pulumi import gcp:dataplex/glossaryCategory:GlossaryCategory default {{project}}/{{location}}/{{glossary_id}}/{{category_id}}
$ pulumi import gcp:dataplex/glossaryCategory:GlossaryCategory default {{location}}/{{glossary_id}}/{{category_id}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.