Docs Home
Google Cloud v8.33.0 published on Wednesday, Jun 4, 2025 by Pulumi
gcp.dataplex.GlossaryTerm
Explore with Pulumi AI
Represents a collection of terms within a Glossary that are related to each other.
Example Usage
Dataplex Glossary Term Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const termTestId = new gcp.dataplex.Glossary("term_test_id", {
glossaryId: "tf-test-glossary_64336",
location: "us-central1",
});
const termTestIdGlossaryTerm = new gcp.dataplex.GlossaryTerm("term_test_id", {
parent: pulumi.interpolate`projects/${termTestId.project}/locations/us-central1/glossaries/${termTestId.glossaryId}`,
glossaryId: termTestId.glossaryId,
location: "us-central1",
termId: "tf-test-term-basic_34962",
});
import pulumi
import pulumi_gcp as gcp
term_test_id = gcp.dataplex.Glossary("term_test_id",
glossary_id="tf-test-glossary_64336",
location="us-central1")
term_test_id_glossary_term = gcp.dataplex.GlossaryTerm("term_test_id",
parent=pulumi.Output.all(
project=term_test_id.project,
glossary_id=term_test_id.glossary_id
).apply(lambda resolved_outputs: f"projects/{resolved_outputs['project']}/locations/us-central1/glossaries/{resolved_outputs['glossary_id']}")
,
glossary_id=term_test_id.glossary_id,
location="us-central1",
term_id="tf-test-term-basic_34962")
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 {
termTestId, err := dataplex.NewGlossary(ctx, "term_test_id", &dataplex.GlossaryArgs{
GlossaryId: pulumi.String("tf-test-glossary_64336"),
Location: pulumi.String("us-central1"),
})
if err != nil {
return err
}
_, err = dataplex.NewGlossaryTerm(ctx, "term_test_id", &dataplex.GlossaryTermArgs{
Parent: pulumi.All(termTestId.Project, termTestId.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: termTestId.GlossaryId,
Location: pulumi.String("us-central1"),
TermId: pulumi.String("tf-test-term-basic_34962"),
})
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 termTestId = new Gcp.DataPlex.Glossary("term_test_id", new()
{
GlossaryId = "tf-test-glossary_64336",
Location = "us-central1",
});
var termTestIdGlossaryTerm = new Gcp.DataPlex.GlossaryTerm("term_test_id", new()
{
Parent = Output.Tuple(termTestId.Project, termTestId.GlossaryId).Apply(values =>
{
var project = values.Item1;
var glossaryId = values.Item2;
return $"projects/{project}/locations/us-central1/glossaries/{glossaryId}";
}),
GlossaryId = termTestId.GlossaryId,
Location = "us-central1",
TermId = "tf-test-term-basic_34962",
});
});
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.GlossaryTerm;
import com.pulumi.gcp.dataplex.GlossaryTermArgs;
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 termTestId = new Glossary("termTestId", GlossaryArgs.builder()
.glossaryId("tf-test-glossary_64336")
.location("us-central1")
.build());
var termTestIdGlossaryTerm = new GlossaryTerm("termTestIdGlossaryTerm", GlossaryTermArgs.builder()
.parent(Output.tuple(termTestId.project(), termTestId.glossaryId()).applyValue(values -> {
var project = values.t1;
var glossaryId = values.t2;
return String.format("projects/%s/locations/us-central1/glossaries/%s", project,glossaryId);
}))
.glossaryId(termTestId.glossaryId())
.location("us-central1")
.termId("tf-test-term-basic_34962")
.build());
}
}
resources:
termTestId:
type: gcp:dataplex:Glossary
name: term_test_id
properties:
glossaryId: tf-test-glossary_64336
location: us-central1
termTestIdGlossaryTerm:
type: gcp:dataplex:GlossaryTerm
name: term_test_id
properties:
parent: projects/${termTestId.project}/locations/us-central1/glossaries/${termTestId.glossaryId}
glossaryId: ${termTestId.glossaryId}
location: us-central1
termId: tf-test-term-basic_34962
Dataplex Glossary Term Full
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const termTestIdFull = new gcp.dataplex.Glossary("term_test_id_full", {
glossaryId: "tf-test-glossary_74000",
location: "us-central1",
});
const termTestIdFullGlossaryTerm = new gcp.dataplex.GlossaryTerm("term_test_id_full", {
parent: pulumi.interpolate`projects/${termTestIdFull.project}/locations/us-central1/glossaries/${termTestIdFull.glossaryId}`,
glossaryId: termTestIdFull.glossaryId,
location: "us-central1",
termId: "tf-test-term-full_75125",
labels: {
tag: "test-tf",
},
displayName: "terraform term",
description: "term created by Terraform",
});
import pulumi
import pulumi_gcp as gcp
term_test_id_full = gcp.dataplex.Glossary("term_test_id_full",
glossary_id="tf-test-glossary_74000",
location="us-central1")
term_test_id_full_glossary_term = gcp.dataplex.GlossaryTerm("term_test_id_full",
parent=pulumi.Output.all(
project=term_test_id_full.project,
glossary_id=term_test_id_full.glossary_id
).apply(lambda resolved_outputs: f"projects/{resolved_outputs['project']}/locations/us-central1/glossaries/{resolved_outputs['glossary_id']}")
,
glossary_id=term_test_id_full.glossary_id,
location="us-central1",
term_id="tf-test-term-full_75125",
labels={
"tag": "test-tf",
},
display_name="terraform term",
description="term 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 {
termTestIdFull, err := dataplex.NewGlossary(ctx, "term_test_id_full", &dataplex.GlossaryArgs{
GlossaryId: pulumi.String("tf-test-glossary_74000"),
Location: pulumi.String("us-central1"),
})
if err != nil {
return err
}
_, err = dataplex.NewGlossaryTerm(ctx, "term_test_id_full", &dataplex.GlossaryTermArgs{
Parent: pulumi.All(termTestIdFull.Project, termTestIdFull.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: termTestIdFull.GlossaryId,
Location: pulumi.String("us-central1"),
TermId: pulumi.String("tf-test-term-full_75125"),
Labels: pulumi.StringMap{
"tag": pulumi.String("test-tf"),
},
DisplayName: pulumi.String("terraform term"),
Description: pulumi.String("term 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 termTestIdFull = new Gcp.DataPlex.Glossary("term_test_id_full", new()
{
GlossaryId = "tf-test-glossary_74000",
Location = "us-central1",
});
var termTestIdFullGlossaryTerm = new Gcp.DataPlex.GlossaryTerm("term_test_id_full", new()
{
Parent = Output.Tuple(termTestIdFull.Project, termTestIdFull.GlossaryId).Apply(values =>
{
var project = values.Item1;
var glossaryId = values.Item2;
return $"projects/{project}/locations/us-central1/glossaries/{glossaryId}";
}),
GlossaryId = termTestIdFull.GlossaryId,
Location = "us-central1",
TermId = "tf-test-term-full_75125",
Labels =
{
{ "tag", "test-tf" },
},
DisplayName = "terraform term",
Description = "term 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.GlossaryTerm;
import com.pulumi.gcp.dataplex.GlossaryTermArgs;
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 termTestIdFull = new Glossary("termTestIdFull", GlossaryArgs.builder()
.glossaryId("tf-test-glossary_74000")
.location("us-central1")
.build());
var termTestIdFullGlossaryTerm = new GlossaryTerm("termTestIdFullGlossaryTerm", GlossaryTermArgs.builder()
.parent(Output.tuple(termTestIdFull.project(), termTestIdFull.glossaryId()).applyValue(values -> {
var project = values.t1;
var glossaryId = values.t2;
return String.format("projects/%s/locations/us-central1/glossaries/%s", project,glossaryId);
}))
.glossaryId(termTestIdFull.glossaryId())
.location("us-central1")
.termId("tf-test-term-full_75125")
.labels(Map.of("tag", "test-tf"))
.displayName("terraform term")
.description("term created by Terraform")
.build());
}
}
resources:
termTestIdFull:
type: gcp:dataplex:Glossary
name: term_test_id_full
properties:
glossaryId: tf-test-glossary_74000
location: us-central1
termTestIdFullGlossaryTerm:
type: gcp:dataplex:GlossaryTerm
name: term_test_id_full
properties:
parent: projects/${termTestIdFull.project}/locations/us-central1/glossaries/${termTestIdFull.glossaryId}
glossaryId: ${termTestIdFull.glossaryId}
location: us-central1
termId: tf-test-term-full_75125
labels:
tag: test-tf
displayName: terraform term
description: term created by Terraform
Create GlossaryTerm Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GlossaryTerm(name: string, args: GlossaryTermArgs, opts?: CustomResourceOptions);@overload
def GlossaryTerm(resource_name: str,
args: GlossaryTermArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GlossaryTerm(resource_name: str,
opts: Optional[ResourceOptions] = None,
location: Optional[str] = None,
parent: 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,
term_id: Optional[str] = None)func NewGlossaryTerm(ctx *Context, name string, args GlossaryTermArgs, opts ...ResourceOption) (*GlossaryTerm, error)public GlossaryTerm(string name, GlossaryTermArgs args, CustomResourceOptions? opts = null)
public GlossaryTerm(String name, GlossaryTermArgs args)
public GlossaryTerm(String name, GlossaryTermArgs args, CustomResourceOptions options)
type: gcp:dataplex:GlossaryTerm
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 GlossaryTermArgs
- 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 GlossaryTermArgs
- 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 GlossaryTermArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GlossaryTermArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GlossaryTermArgs
- 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 glossaryTermResource = new Gcp.DataPlex.GlossaryTerm("glossaryTermResource", new()
{
Location = "string",
Parent = "string",
Description = "string",
DisplayName = "string",
GlossaryId = "string",
Labels =
{
{ "string", "string" },
},
Project = "string",
TermId = "string",
});
example, err := dataplex.NewGlossaryTerm(ctx, "glossaryTermResource", &dataplex.GlossaryTermArgs{
Location: pulumi.String("string"),
Parent: 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"),
TermId: pulumi.String("string"),
})
var glossaryTermResource = new GlossaryTerm("glossaryTermResource", GlossaryTermArgs.builder()
.location("string")
.parent("string")
.description("string")
.displayName("string")
.glossaryId("string")
.labels(Map.of("string", "string"))
.project("string")
.termId("string")
.build());
glossary_term_resource = gcp.dataplex.GlossaryTerm("glossaryTermResource",
location="string",
parent="string",
description="string",
display_name="string",
glossary_id="string",
labels={
"string": "string",
},
project="string",
term_id="string")
const glossaryTermResource = new gcp.dataplex.GlossaryTerm("glossaryTermResource", {
location: "string",
parent: "string",
description: "string",
displayName: "string",
glossaryId: "string",
labels: {
string: "string",
},
project: "string",
termId: "string",
});
type: gcp:dataplex:GlossaryTerm
properties:
description: string
displayName: string
glossaryId: string
labels:
string: string
location: string
parent: string
project: string
termId: string
GlossaryTerm 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 GlossaryTerm resource accepts the following input properties:
- Location string
- The location where the glossary term should reside.
- Parent string
- The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
- Description string
- The user-mutable description of the GlossaryTerm.
- Display
Name string - User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, if not specified.
- Glossary
Id string - The glossary id for creation.
- Labels Dictionary<string, string>
User-defined labels for the GlossaryTerm.
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.
- Term
Id string - The term id for creation.
- Location string
- The location where the glossary term should reside.
- Parent string
- The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
- Description string
- The user-mutable description of the GlossaryTerm.
- Display
Name string - User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, if not specified.
- Glossary
Id string - The glossary id for creation.
- Labels map[string]string
User-defined labels for the GlossaryTerm.
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.
- Term
Id string - The term id for creation.
- location String
- The location where the glossary term should reside.
- parent String
- The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
- description String
- The user-mutable description of the GlossaryTerm.
- display
Name String - User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, if not specified.
- glossary
Id String - The glossary id for creation.
- labels Map<String,String>
User-defined labels for the GlossaryTerm.
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.
- term
Id String - The term id for creation.
- location string
- The location where the glossary term should reside.
- parent string
- The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
- description string
- The user-mutable description of the GlossaryTerm.
- display
Name string - User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, if not specified.
- glossary
Id string - The glossary id for creation.
- labels {[key: string]: string}
User-defined labels for the GlossaryTerm.
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.
- term
Id string - The term id for creation.
- location str
- The location where the glossary term should reside.
- parent str
- The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
- description str
- The user-mutable description of the GlossaryTerm.
- display_
name str - User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, if not specified.
- glossary_
id str - The glossary id for creation.
- labels Mapping[str, str]
User-defined labels for the GlossaryTerm.
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.
- term_
id str - The term id for creation.
- location String
- The location where the glossary term should reside.
- parent String
- The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
- description String
- The user-mutable description of the GlossaryTerm.
- display
Name String - User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, if not specified.
- glossary
Id String - The glossary id for creation.
- labels Map<String>
User-defined labels for the GlossaryTerm.
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.
- term
Id String - The term id for creation.
Outputs
All input properties are implicitly available as output properties. Additionally, the GlossaryTerm resource produces the following output properties:
- Create
Time string - The time at which the GlossaryTerm 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 GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{termId}
- 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 GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
- Update
Time string - The time at which the GlossaryTerm was last updated.
- Create
Time string - The time at which the GlossaryTerm 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 GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{termId}
- 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 GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
- Update
Time string - The time at which the GlossaryTerm was last updated.
- create
Time String - The time at which the GlossaryTerm 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 GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{termId}
- 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 GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
- update
Time String - The time at which the GlossaryTerm was last updated.
- create
Time string - The time at which the GlossaryTerm 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 GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{termId}
- 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 GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
- update
Time string - The time at which the GlossaryTerm was last updated.
- create_
time str - The time at which the GlossaryTerm 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 GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{termId}
- 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 GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
- update_
time str - The time at which the GlossaryTerm was last updated.
- create
Time String - The time at which the GlossaryTerm 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 GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{termId}
- 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 GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
- update
Time String - The time at which the GlossaryTerm was last updated.
Look up Existing GlossaryTerm Resource
Get an existing GlossaryTerm 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?: GlossaryTermState, opts?: CustomResourceOptions): GlossaryTerm@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = 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,
term_id: Optional[str] = None,
uid: Optional[str] = None,
update_time: Optional[str] = None) -> GlossaryTermfunc GetGlossaryTerm(ctx *Context, name string, id IDInput, state *GlossaryTermState, opts ...ResourceOption) (*GlossaryTerm, error)public static GlossaryTerm Get(string name, Input<string> id, GlossaryTermState? state, CustomResourceOptions? opts = null)public static GlossaryTerm get(String name, Output<String> id, GlossaryTermState state, CustomResourceOptions options)resources: _: type: gcp:dataplex:GlossaryTerm 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.
- Create
Time string - The time at which the GlossaryTerm was created.
- Description string
- The user-mutable description of the GlossaryTerm.
- Display
Name string - User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, 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 GlossaryTerm.
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 term should reside.
- Name string
- The resource name of the GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{termId}
- Parent string
- The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
- 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.
- Term
Id string - The term id for creation.
- Uid string
- System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
- Update
Time string - The time at which the GlossaryTerm was last updated.
- Create
Time string - The time at which the GlossaryTerm was created.
- Description string
- The user-mutable description of the GlossaryTerm.
- Display
Name string - User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, 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 GlossaryTerm.
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 term should reside.
- Name string
- The resource name of the GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{termId}
- Parent string
- The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
- 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.
- Term
Id string - The term id for creation.
- Uid string
- System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
- Update
Time string - The time at which the GlossaryTerm was last updated.
- create
Time String - The time at which the GlossaryTerm was created.
- description String
- The user-mutable description of the GlossaryTerm.
- display
Name String - User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, 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 GlossaryTerm.
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 term should reside.
- name String
- The resource name of the GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{termId}
- parent String
- The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
- 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.
- term
Id String - The term id for creation.
- uid String
- System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
- update
Time String - The time at which the GlossaryTerm was last updated.
- create
Time string - The time at which the GlossaryTerm was created.
- description string
- The user-mutable description of the GlossaryTerm.
- display
Name string - User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, 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 GlossaryTerm.
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 term should reside.
- name string
- The resource name of the GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{termId}
- parent string
- The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
- 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.
- term
Id string - The term id for creation.
- uid string
- System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
- update
Time string - The time at which the GlossaryTerm was last updated.
- create_
time str - The time at which the GlossaryTerm was created.
- description str
- The user-mutable description of the GlossaryTerm.
- display_
name str - User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, 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 GlossaryTerm.
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 term should reside.
- name str
- The resource name of the GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{termId}
- parent str
- The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
- 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_
id str - The term id for creation.
- uid str
- System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
- update_
time str - The time at which the GlossaryTerm was last updated.
- create
Time String - The time at which the GlossaryTerm was created.
- description String
- The user-mutable description of the GlossaryTerm.
- display
Name String - User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, 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 GlossaryTerm.
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 term should reside.
- name String
- The resource name of the GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{termId}
- parent String
- The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
- 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.
- term
Id String - The term id for creation.
- uid String
- System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
- update
Time String - The time at which the GlossaryTerm was last updated.
Import
GlossaryTerm can be imported using any of these accepted formats:
projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/terms/{{term_id}}{{project}}/{{location}}/{{glossary_id}}/{{term_id}}{{location}}/{{glossary_id}}/{{term_id}}
When using the pulumi import command, GlossaryTerm can be imported using one of the formats above. For example:
$ pulumi import gcp:dataplex/glossaryTerm:GlossaryTerm default projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/terms/{{term_id}}
$ pulumi import gcp:dataplex/glossaryTerm:GlossaryTerm default {{project}}/{{location}}/{{glossary_id}}/{{term_id}}
$ pulumi import gcp:dataplex/glossaryTerm:GlossaryTerm default {{location}}/{{glossary_id}}/{{term_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.