Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. dataplex
  5. Glossary
Google Cloud v8.33.0 published on Wednesday, Jun 4, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.dataplex.Glossary

Explore with Pulumi AI

gcp logo
Google Cloud v8.33.0 published on Wednesday, Jun 4, 2025 by Pulumi
pulumi/pulumi-gcp

    Represents a collection of categories and terms defined by the user. Glossary is a top level resource and is the GCP parent resource of all the categories and terms within it.

    Example Usage

    Dataplex Glossary Basic

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const glossaryTestId = new gcp.dataplex.Glossary("glossary_test_id", {
    glossaryId: "glossary-basic",
    location: "us-central1",
});

    import pulumi
import pulumi_gcp as gcp

glossary_test_id = gcp.dataplex.Glossary("glossary_test_id",
    glossary_id="glossary-basic",
    location="us-central1")

    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.NewGlossary(ctx, "glossary_test_id", &dataplex.GlossaryArgs{
			GlossaryId: pulumi.String("glossary-basic"),
			Location:   pulumi.String("us-central1"),
		})
		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 glossaryTestId = new Gcp.DataPlex.Glossary("glossary_test_id", new()
    {
        GlossaryId = "glossary-basic",
        Location = "us-central1",
    });

});

    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 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 glossaryTestId = new Glossary("glossaryTestId", GlossaryArgs.builder()
            .glossaryId("glossary-basic")
            .location("us-central1")
            .build());

    }
}

    resources:
  glossaryTestId:
    type: gcp:dataplex:Glossary
    name: glossary_test_id
    properties:
      glossaryId: glossary-basic
      location: us-central1

    Dataplex Glossary Full

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const glossaryTestIdFull = new gcp.dataplex.Glossary("glossary_test_id_full", {
    glossaryId: "glossary-full",
    location: "us-central1",
    labels: {
        tag: "test-tf",
    },
    displayName: "terraform glossary",
    description: "glossary created by Terraform",
});

    import pulumi
import pulumi_gcp as gcp

glossary_test_id_full = gcp.dataplex.Glossary("glossary_test_id_full",
    glossary_id="glossary-full",
    location="us-central1",
    labels={
        "tag": "test-tf",
    },
    display_name="terraform glossary",
    description="glossary created by Terraform")

    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.NewGlossary(ctx, "glossary_test_id_full", &dataplex.GlossaryArgs{
			GlossaryId: pulumi.String("glossary-full"),
			Location:   pulumi.String("us-central1"),
			Labels: pulumi.StringMap{
				"tag": pulumi.String("test-tf"),
			},
			DisplayName: pulumi.String("terraform glossary"),
			Description: pulumi.String("glossary 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 glossaryTestIdFull = new Gcp.DataPlex.Glossary("glossary_test_id_full", new()
    {
        GlossaryId = "glossary-full",
        Location = "us-central1",
        Labels = 
        {
            { "tag", "test-tf" },
        },
        DisplayName = "terraform glossary",
        Description = "glossary 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 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 glossaryTestIdFull = new Glossary("glossaryTestIdFull", GlossaryArgs.builder()
            .glossaryId("glossary-full")
            .location("us-central1")
            .labels(Map.of("tag", "test-tf"))
            .displayName("terraform glossary")
            .description("glossary created by Terraform")
            .build());

    }
}

    resources:
  glossaryTestIdFull:
    type: gcp:dataplex:Glossary
    name: glossary_test_id_full
    properties:
      glossaryId: glossary-full
      location: us-central1
      labels:
        tag: test-tf
      displayName: terraform glossary
      description: glossary created by Terraform

    Create Glossary Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Glossary(name: string, args: GlossaryArgs, opts?: CustomResourceOptions);
    @overload
def Glossary(resource_name: str,
             args: GlossaryArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Glossary(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             glossary_id: Optional[str] = None,
             location: Optional[str] = None,
             description: Optional[str] = None,
             display_name: Optional[str] = None,
             labels: Optional[Mapping[str, str]] = None,
             project: Optional[str] = None)
    func NewGlossary(ctx *Context, name string, args GlossaryArgs, opts ...ResourceOption) (*Glossary, error)
    public Glossary(string name, GlossaryArgs args, CustomResourceOptions? opts = null)
    public Glossary(String name, GlossaryArgs args)
public Glossary(String name, GlossaryArgs args, CustomResourceOptions options)

    type: gcp:dataplex:Glossary
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 GlossaryArgs
    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 GlossaryArgs
    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 GlossaryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GlossaryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GlossaryArgs
    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 glossaryResource = new Gcp.DataPlex.Glossary("glossaryResource", new()
{
    GlossaryId = "string",
    Location = "string",
    Description = "string",
    DisplayName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Project = "string",
});

    example, err := dataplex.NewGlossary(ctx, "glossaryResource", &dataplex.GlossaryArgs{
	GlossaryId:  pulumi.String("string"),
	Location:    pulumi.String("string"),
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})

    var glossaryResource = new Glossary("glossaryResource", GlossaryArgs.builder()
    .glossaryId("string")
    .location("string")
    .description("string")
    .displayName("string")
    .labels(Map.of("string", "string"))
    .project("string")
    .build());

    glossary_resource = gcp.dataplex.Glossary("glossaryResource",
    glossary_id="string",
    location="string",
    description="string",
    display_name="string",
    labels={
        "string": "string",
    },
    project="string")

    const glossaryResource = new gcp.dataplex.Glossary("glossaryResource", {
    glossaryId: "string",
    location: "string",
    description: "string",
    displayName: "string",
    labels: {
        string: "string",
    },
    project: "string",
});

    type: gcp:dataplex:Glossary
properties:
    description: string
    displayName: string
    glossaryId: string
    labels:
        string: string
    location: string
    project: string

    Glossary 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 Glossary resource accepts the following input properties:

    GlossaryId string
    The glossary id for creation.

    Location string
    The location where the glossary should reside.
    Description string
    The user-mutable description of the glossary.
    DisplayName string
    User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
    Labels Dictionary<string, string>

    User-defined labels for the Glossary.

    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.

    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    GlossaryId string
    The glossary id for creation.

    Location string
    The location where the glossary should reside.
    Description string
    The user-mutable description of the glossary.
    DisplayName string
    User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
    Labels map[string]string

    User-defined labels for the Glossary.

    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.

    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    glossaryId String
    The glossary id for creation.

    location String
    The location where the glossary should reside.
    description String
    The user-mutable description of the glossary.
    displayName String
    User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
    labels Map<String,String>

    User-defined labels for the Glossary.

    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.

    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    glossaryId string
    The glossary id for creation.

    location string
    The location where the glossary should reside.
    description string
    The user-mutable description of the glossary.
    displayName string
    User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
    labels {[key: string]: string}

    User-defined labels for the Glossary.

    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.

    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    glossary_id str
    The glossary id for creation.

    location str
    The location where the glossary should reside.
    description str
    The user-mutable description of the glossary.
    display_name str
    User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
    labels Mapping[str, str]

    User-defined labels for the Glossary.

    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.

    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    glossaryId String
    The glossary id for creation.

    location String
    The location where the glossary should reside.
    description String
    The user-mutable description of the glossary.
    displayName String
    User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
    labels Map<String>

    User-defined labels for the Glossary.

    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.

    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 Glossary resource produces the following output properties:

    CategoryCount int
    The number of categories in the glossary.
    CreateTime string
    The time at which the glossary was created.
    EffectiveLabels 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 Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    TermCount int
    The number of terms in the glossary.
    Uid string
    System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
    UpdateTime string
    The time at which the glossary was last updated.
    CategoryCount int
    The number of categories in the glossary.
    CreateTime string
    The time at which the glossary was created.
    EffectiveLabels 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 Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    TermCount int
    The number of terms in the glossary.
    Uid string
    System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
    UpdateTime string
    The time at which the glossary was last updated.
    categoryCount Integer
    The number of categories in the glossary.
    createTime String
    The time at which the glossary was created.
    effectiveLabels 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 Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    termCount Integer
    The number of terms in the glossary.
    uid String
    System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
    updateTime String
    The time at which the glossary was last updated.
    categoryCount number
    The number of categories in the glossary.
    createTime string
    The time at which the glossary was created.
    effectiveLabels {[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 Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    termCount number
    The number of terms in the glossary.
    uid string
    System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
    updateTime string
    The time at which the glossary was last updated.
    category_count int
    The number of categories in the glossary.
    create_time str
    The time at which the glossary 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 Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    term_count int
    The number of terms in the glossary.
    uid str
    System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
    update_time str
    The time at which the glossary was last updated.
    categoryCount Number
    The number of categories in the glossary.
    createTime String
    The time at which the glossary was created.
    effectiveLabels 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 Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    termCount Number
    The number of terms in the glossary.
    uid String
    System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
    updateTime String
    The time at which the glossary was last updated.

    Look up Existing Glossary Resource

    Get an existing Glossary 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?: GlossaryState, opts?: CustomResourceOptions): Glossary
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        category_count: Optional[int] = 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,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        term_count: Optional[int] = None,
        uid: Optional[str] = None,
        update_time: Optional[str] = None) -> Glossary
    func GetGlossary(ctx *Context, name string, id IDInput, state *GlossaryState, opts ...ResourceOption) (*Glossary, error)
    public static Glossary Get(string name, Input<string> id, GlossaryState? state, CustomResourceOptions? opts = null)
    public static Glossary get(String name, Output<String> id, GlossaryState state, CustomResourceOptions options)
    resources:  _:    type: gcp:dataplex:Glossary    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.
    The following state arguments are supported:
    CategoryCount int
    The number of categories in the glossary.
    CreateTime string
    The time at which the glossary was created.
    Description string
    The user-mutable description of the glossary.
    DisplayName string
    User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
    EffectiveLabels 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.
    GlossaryId string
    The glossary id for creation.

    Labels Dictionary<string, string>

    User-defined labels for the Glossary.

    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.

    Location string
    The location where the glossary should reside.
    Name string
    The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    TermCount int
    The number of terms in the glossary.
    Uid string
    System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
    UpdateTime string
    The time at which the glossary was last updated.
    CategoryCount int
    The number of categories in the glossary.
    CreateTime string
    The time at which the glossary was created.
    Description string
    The user-mutable description of the glossary.
    DisplayName string
    User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
    EffectiveLabels 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.
    GlossaryId string
    The glossary id for creation.

    Labels map[string]string

    User-defined labels for the Glossary.

    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.

    Location string
    The location where the glossary should reside.
    Name string
    The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    TermCount int
    The number of terms in the glossary.
    Uid string
    System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
    UpdateTime string
    The time at which the glossary was last updated.
    categoryCount Integer
    The number of categories in the glossary.
    createTime String
    The time at which the glossary was created.
    description String
    The user-mutable description of the glossary.
    displayName String
    User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
    effectiveLabels 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.
    glossaryId String
    The glossary id for creation.

    labels Map<String,String>

    User-defined labels for the Glossary.

    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.

    location String
    The location where the glossary should reside.
    name String
    The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    termCount Integer
    The number of terms in the glossary.
    uid String
    System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
    updateTime String
    The time at which the glossary was last updated.
    categoryCount number
    The number of categories in the glossary.
    createTime string
    The time at which the glossary was created.
    description string
    The user-mutable description of the glossary.
    displayName string
    User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
    effectiveLabels {[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.
    glossaryId string
    The glossary id for creation.

    labels {[key: string]: string}

    User-defined labels for the Glossary.

    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.

    location string
    The location where the glossary should reside.
    name string
    The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    termCount number
    The number of terms in the glossary.
    uid string
    System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
    updateTime string
    The time at which the glossary was last updated.
    category_count int
    The number of categories in the glossary.
    create_time str
    The time at which the glossary was created.
    description str
    The user-mutable description of the glossary.
    display_name str
    User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, 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 Glossary.

    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.

    location str
    The location where the glossary should reside.
    name str
    The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
    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.
    term_count int
    The number of terms in the glossary.
    uid str
    System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
    update_time str
    The time at which the glossary was last updated.
    categoryCount Number
    The number of categories in the glossary.
    createTime String
    The time at which the glossary was created.
    description String
    The user-mutable description of the glossary.
    displayName String
    User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    glossaryId String
    The glossary id for creation.

    labels Map<String>

    User-defined labels for the Glossary.

    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.

    location String
    The location where the glossary should reside.
    name String
    The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    termCount Number
    The number of terms in the glossary.
    uid String
    System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
    updateTime String
    The time at which the glossary was last updated.

    Import

    Glossary can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}

    • {{project}}/{{location}}/{{glossary_id}}

    • {{location}}/{{glossary_id}}

    When using the pulumi import command, Glossary can be imported using one of the formats above. For example:

    $ pulumi import gcp:dataplex/glossary:Glossary default projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}

    $ pulumi import gcp:dataplex/glossary:Glossary default {{project}}/{{location}}/{{glossary_id}}

    $ pulumi import gcp:dataplex/glossary:Glossary default {{location}}/{{glossary_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-beta Terraform Provider.
    gcp logo
    Google Cloud v8.33.0 published on Wednesday, Jun 4, 2025 by Pulumi
    pulumi/pulumi-gcp