1. Packages
  2. AWS
  3. API Docs
  4. datazone
  5. GlossaryTerm
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

aws.datazone.GlossaryTerm

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

    Resource for managing an AWS DataZone Glossary Term.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.iam.Role("example", {
        name: "example",
        assumeRolePolicy: JSON.stringify({
            Version: "2012-10-17",
            Statement: [
                {
                    Action: [
                        "sts:AssumeRole",
                        "sts:TagSession",
                    ],
                    Effect: "Allow",
                    Principal: {
                        Service: "datazone.amazonaws.com",
                    },
                },
                {
                    Action: [
                        "sts:AssumeRole",
                        "sts:TagSession",
                    ],
                    Effect: "Allow",
                    Principal: {
                        Service: "cloudformation.amazonaws.com",
                    },
                },
            ],
        }),
        inlinePolicies: [{
            name: "example",
            policy: JSON.stringify({
                Version: "2012-10-17",
                Statement: [{
                    Action: [
                        "datazone:*",
                        "ram:*",
                        "sso:*",
                        "kms:*",
                    ],
                    Effect: "Allow",
                    Resource: "*",
                }],
            }),
        }],
    });
    const exampleDomain = new aws.datazone.Domain("example", {
        name: "example_name",
        domainExecutionRole: example.arn,
    });
    const exampleSecurityGroup = new aws.ec2.SecurityGroup("example", {name: "example_name"});
    const exampleProject = new aws.datazone.Project("example", {
        domainIdentifier: exampleDomain.id,
        glossaryTerms: ["2N8w6XJCwZf"],
        name: "example",
        skipDeletionCheck: true,
    });
    const exampleGlossary = new aws.datazone.Glossary("example", {
        description: "description",
        name: "example",
        owningProjectIdentifier: exampleProject.id,
        status: "ENABLED",
        domainIdentifier: exampleProject.domainIdentifier,
    });
    const exampleGlossaryTerm = new aws.datazone.GlossaryTerm("example", {
        domainIdentifier: exampleDomain.id,
        glossaryIdentifier: exampleGlossary.id,
        name: "example",
        status: "ENABLED",
    });
    
    import pulumi
    import json
    import pulumi_aws as aws
    
    example = aws.iam.Role("example",
        name="example",
        assume_role_policy=json.dumps({
            "Version": "2012-10-17",
            "Statement": [
                {
                    "Action": [
                        "sts:AssumeRole",
                        "sts:TagSession",
                    ],
                    "Effect": "Allow",
                    "Principal": {
                        "Service": "datazone.amazonaws.com",
                    },
                },
                {
                    "Action": [
                        "sts:AssumeRole",
                        "sts:TagSession",
                    ],
                    "Effect": "Allow",
                    "Principal": {
                        "Service": "cloudformation.amazonaws.com",
                    },
                },
            ],
        }),
        inline_policies=[{
            "name": "example",
            "policy": json.dumps({
                "version": "2012-10-17",
                "statement": [{
                    "action": [
                        "datazone:*",
                        "ram:*",
                        "sso:*",
                        "kms:*",
                    ],
                    "effect": "Allow",
                    "resource": "*",
                }],
            }),
        }])
    example_domain = aws.datazone.Domain("example",
        name="example_name",
        domain_execution_role=example.arn)
    example_security_group = aws.ec2.SecurityGroup("example", name="example_name")
    example_project = aws.datazone.Project("example",
        domain_identifier=example_domain.id,
        glossary_terms=["2N8w6XJCwZf"],
        name="example",
        skip_deletion_check=True)
    example_glossary = aws.datazone.Glossary("example",
        description="description",
        name="example",
        owning_project_identifier=example_project.id,
        status="ENABLED",
        domain_identifier=example_project.domain_identifier)
    example_glossary_term = aws.datazone.GlossaryTerm("example",
        domain_identifier=example_domain.id,
        glossary_identifier=example_glossary.id,
        name="example",
        status="ENABLED")
    
    package main
    
    import (
    	"encoding/json"
    
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/datazone"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		tmpJSON0, err := json.Marshal(map[string]interface{}{
    			"Version": "2012-10-17",
    			"Statement": []map[string]interface{}{
    				map[string]interface{}{
    					"Action": []string{
    						"sts:AssumeRole",
    						"sts:TagSession",
    					},
    					"Effect": "Allow",
    					"Principal": map[string]interface{}{
    						"Service": "datazone.amazonaws.com",
    					},
    				},
    				map[string]interface{}{
    					"Action": []string{
    						"sts:AssumeRole",
    						"sts:TagSession",
    					},
    					"Effect": "Allow",
    					"Principal": map[string]interface{}{
    						"Service": "cloudformation.amazonaws.com",
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		tmpJSON1, err := json.Marshal(map[string]interface{}{
    			"Version": "2012-10-17",
    			"Statement": []map[string]interface{}{
    				map[string]interface{}{
    					"Action": []string{
    						"datazone:*",
    						"ram:*",
    						"sso:*",
    						"kms:*",
    					},
    					"Effect":   "Allow",
    					"Resource": "*",
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		json1 := string(tmpJSON1)
    		example, err := iam.NewRole(ctx, "example", &iam.RoleArgs{
    			Name:             pulumi.String("example"),
    			AssumeRolePolicy: pulumi.String(json0),
    			InlinePolicies: iam.RoleInlinePolicyArray{
    				&iam.RoleInlinePolicyArgs{
    					Name:   pulumi.String("example"),
    					Policy: pulumi.String(json1),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleDomain, err := datazone.NewDomain(ctx, "example", &datazone.DomainArgs{
    			Name:                pulumi.String("example_name"),
    			DomainExecutionRole: example.Arn,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ec2.NewSecurityGroup(ctx, "example", &ec2.SecurityGroupArgs{
    			Name: pulumi.String("example_name"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleProject, err := datazone.NewProject(ctx, "example", &datazone.ProjectArgs{
    			DomainIdentifier: exampleDomain.ID(),
    			GlossaryTerms: pulumi.StringArray{
    				pulumi.String("2N8w6XJCwZf"),
    			},
    			Name:              pulumi.String("example"),
    			SkipDeletionCheck: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		exampleGlossary, err := datazone.NewGlossary(ctx, "example", &datazone.GlossaryArgs{
    			Description:             pulumi.String("description"),
    			Name:                    pulumi.String("example"),
    			OwningProjectIdentifier: exampleProject.ID(),
    			Status:                  pulumi.String("ENABLED"),
    			DomainIdentifier:        exampleProject.DomainIdentifier,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datazone.NewGlossaryTerm(ctx, "example", &datazone.GlossaryTermArgs{
    			DomainIdentifier:   exampleDomain.ID(),
    			GlossaryIdentifier: exampleGlossary.ID(),
    			Name:               pulumi.String("example"),
    			Status:             pulumi.String("ENABLED"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using System.Text.Json;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Iam.Role("example", new()
        {
            Name = "example",
            AssumeRolePolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["Version"] = "2012-10-17",
                ["Statement"] = new[]
                {
                    new Dictionary<string, object?>
                    {
                        ["Action"] = new[]
                        {
                            "sts:AssumeRole",
                            "sts:TagSession",
                        },
                        ["Effect"] = "Allow",
                        ["Principal"] = new Dictionary<string, object?>
                        {
                            ["Service"] = "datazone.amazonaws.com",
                        },
                    },
                    new Dictionary<string, object?>
                    {
                        ["Action"] = new[]
                        {
                            "sts:AssumeRole",
                            "sts:TagSession",
                        },
                        ["Effect"] = "Allow",
                        ["Principal"] = new Dictionary<string, object?>
                        {
                            ["Service"] = "cloudformation.amazonaws.com",
                        },
                    },
                },
            }),
            InlinePolicies = new[]
            {
                new Aws.Iam.Inputs.RoleInlinePolicyArgs
                {
                    Name = "example",
                    Policy = JsonSerializer.Serialize(new Dictionary<string, object?>
                    {
                        ["Version"] = "2012-10-17",
                        ["Statement"] = new[]
                        {
                            new Dictionary<string, object?>
                            {
                                ["Action"] = new[]
                                {
                                    "datazone:*",
                                    "ram:*",
                                    "sso:*",
                                    "kms:*",
                                },
                                ["Effect"] = "Allow",
                                ["Resource"] = "*",
                            },
                        },
                    }),
                },
            },
        });
    
        var exampleDomain = new Aws.DataZone.Domain("example", new()
        {
            Name = "example_name",
            DomainExecutionRole = example.Arn,
        });
    
        var exampleSecurityGroup = new Aws.Ec2.SecurityGroup("example", new()
        {
            Name = "example_name",
        });
    
        var exampleProject = new Aws.DataZone.Project("example", new()
        {
            DomainIdentifier = exampleDomain.Id,
            GlossaryTerms = new[]
            {
                "2N8w6XJCwZf",
            },
            Name = "example",
            SkipDeletionCheck = true,
        });
    
        var exampleGlossary = new Aws.DataZone.Glossary("example", new()
        {
            Description = "description",
            Name = "example",
            OwningProjectIdentifier = exampleProject.Id,
            Status = "ENABLED",
            DomainIdentifier = exampleProject.DomainIdentifier,
        });
    
        var exampleGlossaryTerm = new Aws.DataZone.GlossaryTerm("example", new()
        {
            DomainIdentifier = exampleDomain.Id,
            GlossaryIdentifier = exampleGlossary.Id,
            Name = "example",
            Status = "ENABLED",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.iam.Role;
    import com.pulumi.aws.iam.RoleArgs;
    import com.pulumi.aws.iam.inputs.RoleInlinePolicyArgs;
    import com.pulumi.aws.datazone.Domain;
    import com.pulumi.aws.datazone.DomainArgs;
    import com.pulumi.aws.ec2.SecurityGroup;
    import com.pulumi.aws.ec2.SecurityGroupArgs;
    import com.pulumi.aws.datazone.Project;
    import com.pulumi.aws.datazone.ProjectArgs;
    import com.pulumi.aws.datazone.Glossary;
    import com.pulumi.aws.datazone.GlossaryArgs;
    import com.pulumi.aws.datazone.GlossaryTerm;
    import com.pulumi.aws.datazone.GlossaryTermArgs;
    import static com.pulumi.codegen.internal.Serialization.*;
    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 example = new Role("example", RoleArgs.builder()
                .name("example")
                .assumeRolePolicy(serializeJson(
                    jsonObject(
                        jsonProperty("Version", "2012-10-17"),
                        jsonProperty("Statement", jsonArray(
                            jsonObject(
                                jsonProperty("Action", jsonArray(
                                    "sts:AssumeRole", 
                                    "sts:TagSession"
                                )),
                                jsonProperty("Effect", "Allow"),
                                jsonProperty("Principal", jsonObject(
                                    jsonProperty("Service", "datazone.amazonaws.com")
                                ))
                            ), 
                            jsonObject(
                                jsonProperty("Action", jsonArray(
                                    "sts:AssumeRole", 
                                    "sts:TagSession"
                                )),
                                jsonProperty("Effect", "Allow"),
                                jsonProperty("Principal", jsonObject(
                                    jsonProperty("Service", "cloudformation.amazonaws.com")
                                ))
                            )
                        ))
                    )))
                .inlinePolicies(RoleInlinePolicyArgs.builder()
                    .name("example")
                    .policy(serializeJson(
                        jsonObject(
                            jsonProperty("Version", "2012-10-17"),
                            jsonProperty("Statement", jsonArray(jsonObject(
                                jsonProperty("Action", jsonArray(
                                    "datazone:*", 
                                    "ram:*", 
                                    "sso:*", 
                                    "kms:*"
                                )),
                                jsonProperty("Effect", "Allow"),
                                jsonProperty("Resource", "*")
                            )))
                        )))
                    .build())
                .build());
    
            var exampleDomain = new Domain("exampleDomain", DomainArgs.builder()
                .name("example_name")
                .domainExecutionRole(example.arn())
                .build());
    
            var exampleSecurityGroup = new SecurityGroup("exampleSecurityGroup", SecurityGroupArgs.builder()
                .name("example_name")
                .build());
    
            var exampleProject = new Project("exampleProject", ProjectArgs.builder()
                .domainIdentifier(exampleDomain.id())
                .glossaryTerms("2N8w6XJCwZf")
                .name("example")
                .skipDeletionCheck(true)
                .build());
    
            var exampleGlossary = new Glossary("exampleGlossary", GlossaryArgs.builder()
                .description("description")
                .name("example")
                .owningProjectIdentifier(exampleProject.id())
                .status("ENABLED")
                .domainIdentifier(exampleProject.domainIdentifier())
                .build());
    
            var exampleGlossaryTerm = new GlossaryTerm("exampleGlossaryTerm", GlossaryTermArgs.builder()
                .domainIdentifier(exampleDomain.id())
                .glossaryIdentifier(exampleGlossary.id())
                .name("example")
                .status("ENABLED")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:iam:Role
        properties:
          name: example
          assumeRolePolicy:
            fn::toJSON:
              Version: 2012-10-17
              Statement:
                - Action:
                    - sts:AssumeRole
                    - sts:TagSession
                  Effect: Allow
                  Principal:
                    Service: datazone.amazonaws.com
                - Action:
                    - sts:AssumeRole
                    - sts:TagSession
                  Effect: Allow
                  Principal:
                    Service: cloudformation.amazonaws.com
          inlinePolicies:
            - name: example
              policy:
                fn::toJSON:
                  Version: 2012-10-17
                  Statement:
                    - Action:
                        - datazone:*
                        - ram:*
                        - sso:*
                        - kms:*
                      Effect: Allow
                      Resource: '*'
      exampleDomain:
        type: aws:datazone:Domain
        name: example
        properties:
          name: example_name
          domainExecutionRole: ${example.arn}
      exampleSecurityGroup:
        type: aws:ec2:SecurityGroup
        name: example
        properties:
          name: example_name
      exampleProject:
        type: aws:datazone:Project
        name: example
        properties:
          domainIdentifier: ${exampleDomain.id}
          glossaryTerms:
            - 2N8w6XJCwZf
          name: example
          skipDeletionCheck: true
      exampleGlossary:
        type: aws:datazone:Glossary
        name: example
        properties:
          description: description
          name: example
          owningProjectIdentifier: ${exampleProject.id}
          status: ENABLED
          domainIdentifier: ${exampleProject.domainIdentifier}
      exampleGlossaryTerm:
        type: aws:datazone:GlossaryTerm
        name: example
        properties:
          domainIdentifier: ${exampleDomain.id}
          glossaryIdentifier: ${exampleGlossary.id}
          name: example
          status: ENABLED
    

    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,
                     glossary_identifier: Optional[str] = None,
                     domain_identifier: Optional[str] = None,
                     long_description: Optional[str] = None,
                     name: Optional[str] = None,
                     short_description: Optional[str] = None,
                     status: Optional[str] = None,
                     term_relations: Optional[GlossaryTermTermRelationsArgs] = None,
                     timeouts: Optional[GlossaryTermTimeoutsArgs] = 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: aws:datazone: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 Aws.DataZone.GlossaryTerm("glossaryTermResource", new()
    {
        GlossaryIdentifier = "string",
        DomainIdentifier = "string",
        LongDescription = "string",
        Name = "string",
        ShortDescription = "string",
        Status = "string",
        TermRelations = new Aws.DataZone.Inputs.GlossaryTermTermRelationsArgs
        {
            Classifies = new[]
            {
                "string",
            },
            IsAs = new[]
            {
                "string",
            },
        },
        Timeouts = new Aws.DataZone.Inputs.GlossaryTermTimeoutsArgs
        {
            Create = "string",
        },
    });
    
    example, err := datazone.NewGlossaryTerm(ctx, "glossaryTermResource", &datazone.GlossaryTermArgs{
    	GlossaryIdentifier: pulumi.String("string"),
    	DomainIdentifier:   pulumi.String("string"),
    	LongDescription:    pulumi.String("string"),
    	Name:               pulumi.String("string"),
    	ShortDescription:   pulumi.String("string"),
    	Status:             pulumi.String("string"),
    	TermRelations: &datazone.GlossaryTermTermRelationsArgs{
    		Classifies: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IsAs: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	Timeouts: &datazone.GlossaryTermTimeoutsArgs{
    		Create: pulumi.String("string"),
    	},
    })
    
    var glossaryTermResource = new GlossaryTerm("glossaryTermResource", GlossaryTermArgs.builder()
        .glossaryIdentifier("string")
        .domainIdentifier("string")
        .longDescription("string")
        .name("string")
        .shortDescription("string")
        .status("string")
        .termRelations(GlossaryTermTermRelationsArgs.builder()
            .classifies("string")
            .isAs("string")
            .build())
        .timeouts(GlossaryTermTimeoutsArgs.builder()
            .create("string")
            .build())
        .build());
    
    glossary_term_resource = aws.datazone.GlossaryTerm("glossaryTermResource",
        glossary_identifier="string",
        domain_identifier="string",
        long_description="string",
        name="string",
        short_description="string",
        status="string",
        term_relations={
            "classifies": ["string"],
            "isAs": ["string"],
        },
        timeouts={
            "create": "string",
        })
    
    const glossaryTermResource = new aws.datazone.GlossaryTerm("glossaryTermResource", {
        glossaryIdentifier: "string",
        domainIdentifier: "string",
        longDescription: "string",
        name: "string",
        shortDescription: "string",
        status: "string",
        termRelations: {
            classifies: ["string"],
            isAs: ["string"],
        },
        timeouts: {
            create: "string",
        },
    });
    
    type: aws:datazone:GlossaryTerm
    properties:
        domainIdentifier: string
        glossaryIdentifier: string
        longDescription: string
        name: string
        shortDescription: string
        status: string
        termRelations:
            classifies:
                - string
            isAs:
                - string
        timeouts:
            create: 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

    The GlossaryTerm resource accepts the following input properties:

    GlossaryIdentifier string
    Identifier of glossary.
    DomainIdentifier string
    Identifier of domain.
    LongDescription string
    Long description of entry.
    Name string

    Name of glossary term.

    The following arguments are optional:

    ShortDescription string
    Short description of entry.
    Status string
    If glossary term is ENABLED or DISABLED.
    TermRelations GlossaryTermTermRelations
    Object classifying the term relations through the following attributes:
    Timeouts GlossaryTermTimeouts
    GlossaryIdentifier string
    Identifier of glossary.
    DomainIdentifier string
    Identifier of domain.
    LongDescription string
    Long description of entry.
    Name string

    Name of glossary term.

    The following arguments are optional:

    ShortDescription string
    Short description of entry.
    Status string
    If glossary term is ENABLED or DISABLED.
    TermRelations GlossaryTermTermRelationsArgs
    Object classifying the term relations through the following attributes:
    Timeouts GlossaryTermTimeoutsArgs
    glossaryIdentifier String
    Identifier of glossary.
    domainIdentifier String
    Identifier of domain.
    longDescription String
    Long description of entry.
    name String

    Name of glossary term.

    The following arguments are optional:

    shortDescription String
    Short description of entry.
    status String
    If glossary term is ENABLED or DISABLED.
    termRelations GlossaryTermTermRelations
    Object classifying the term relations through the following attributes:
    timeouts GlossaryTermTimeouts
    glossaryIdentifier string
    Identifier of glossary.
    domainIdentifier string
    Identifier of domain.
    longDescription string
    Long description of entry.
    name string

    Name of glossary term.

    The following arguments are optional:

    shortDescription string
    Short description of entry.
    status string
    If glossary term is ENABLED or DISABLED.
    termRelations GlossaryTermTermRelations
    Object classifying the term relations through the following attributes:
    timeouts GlossaryTermTimeouts
    glossary_identifier str
    Identifier of glossary.
    domain_identifier str
    Identifier of domain.
    long_description str
    Long description of entry.
    name str

    Name of glossary term.

    The following arguments are optional:

    short_description str
    Short description of entry.
    status str
    If glossary term is ENABLED or DISABLED.
    term_relations GlossaryTermTermRelationsArgs
    Object classifying the term relations through the following attributes:
    timeouts GlossaryTermTimeoutsArgs
    glossaryIdentifier String
    Identifier of glossary.
    domainIdentifier String
    Identifier of domain.
    longDescription String
    Long description of entry.
    name String

    Name of glossary term.

    The following arguments are optional:

    shortDescription String
    Short description of entry.
    status String
    If glossary term is ENABLED or DISABLED.
    termRelations Property Map
    Object classifying the term relations through the following attributes:
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GlossaryTerm resource produces the following output properties:

    CreatedAt string
    Time of glossary term creation.
    CreatedBy string
    Creator of glossary term.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreatedAt string
    Time of glossary term creation.
    CreatedBy string
    Creator of glossary term.
    Id string
    The provider-assigned unique ID for this managed resource.
    createdAt String
    Time of glossary term creation.
    createdBy String
    Creator of glossary term.
    id String
    The provider-assigned unique ID for this managed resource.
    createdAt string
    Time of glossary term creation.
    createdBy string
    Creator of glossary term.
    id string
    The provider-assigned unique ID for this managed resource.
    created_at str
    Time of glossary term creation.
    created_by str
    Creator of glossary term.
    id str
    The provider-assigned unique ID for this managed resource.
    createdAt String
    Time of glossary term creation.
    createdBy String
    Creator of glossary term.
    id String
    The provider-assigned unique ID for this managed resource.

    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,
            created_at: Optional[str] = None,
            created_by: Optional[str] = None,
            domain_identifier: Optional[str] = None,
            glossary_identifier: Optional[str] = None,
            long_description: Optional[str] = None,
            name: Optional[str] = None,
            short_description: Optional[str] = None,
            status: Optional[str] = None,
            term_relations: Optional[GlossaryTermTermRelationsArgs] = None,
            timeouts: Optional[GlossaryTermTimeoutsArgs] = None) -> GlossaryTerm
    func 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)
    Resource lookup is not supported in YAML
    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:
    CreatedAt string
    Time of glossary term creation.
    CreatedBy string
    Creator of glossary term.
    DomainIdentifier string
    Identifier of domain.
    GlossaryIdentifier string
    Identifier of glossary.
    LongDescription string
    Long description of entry.
    Name string

    Name of glossary term.

    The following arguments are optional:

    ShortDescription string
    Short description of entry.
    Status string
    If glossary term is ENABLED or DISABLED.
    TermRelations GlossaryTermTermRelations
    Object classifying the term relations through the following attributes:
    Timeouts GlossaryTermTimeouts
    CreatedAt string
    Time of glossary term creation.
    CreatedBy string
    Creator of glossary term.
    DomainIdentifier string
    Identifier of domain.
    GlossaryIdentifier string
    Identifier of glossary.
    LongDescription string
    Long description of entry.
    Name string

    Name of glossary term.

    The following arguments are optional:

    ShortDescription string
    Short description of entry.
    Status string
    If glossary term is ENABLED or DISABLED.
    TermRelations GlossaryTermTermRelationsArgs
    Object classifying the term relations through the following attributes:
    Timeouts GlossaryTermTimeoutsArgs
    createdAt String
    Time of glossary term creation.
    createdBy String
    Creator of glossary term.
    domainIdentifier String
    Identifier of domain.
    glossaryIdentifier String
    Identifier of glossary.
    longDescription String
    Long description of entry.
    name String

    Name of glossary term.

    The following arguments are optional:

    shortDescription String
    Short description of entry.
    status String
    If glossary term is ENABLED or DISABLED.
    termRelations GlossaryTermTermRelations
    Object classifying the term relations through the following attributes:
    timeouts GlossaryTermTimeouts
    createdAt string
    Time of glossary term creation.
    createdBy string
    Creator of glossary term.
    domainIdentifier string
    Identifier of domain.
    glossaryIdentifier string
    Identifier of glossary.
    longDescription string
    Long description of entry.
    name string

    Name of glossary term.

    The following arguments are optional:

    shortDescription string
    Short description of entry.
    status string
    If glossary term is ENABLED or DISABLED.
    termRelations GlossaryTermTermRelations
    Object classifying the term relations through the following attributes:
    timeouts GlossaryTermTimeouts
    created_at str
    Time of glossary term creation.
    created_by str
    Creator of glossary term.
    domain_identifier str
    Identifier of domain.
    glossary_identifier str
    Identifier of glossary.
    long_description str
    Long description of entry.
    name str

    Name of glossary term.

    The following arguments are optional:

    short_description str
    Short description of entry.
    status str
    If glossary term is ENABLED or DISABLED.
    term_relations GlossaryTermTermRelationsArgs
    Object classifying the term relations through the following attributes:
    timeouts GlossaryTermTimeoutsArgs
    createdAt String
    Time of glossary term creation.
    createdBy String
    Creator of glossary term.
    domainIdentifier String
    Identifier of domain.
    glossaryIdentifier String
    Identifier of glossary.
    longDescription String
    Long description of entry.
    name String

    Name of glossary term.

    The following arguments are optional:

    shortDescription String
    Short description of entry.
    status String
    If glossary term is ENABLED or DISABLED.
    termRelations Property Map
    Object classifying the term relations through the following attributes:
    timeouts Property Map

    Supporting Types

    GlossaryTermTermRelations, GlossaryTermTermRelationsArgs

    Classifies List<string>
    String array that calssifies the term relations.
    IsAs List<string>
    Classifies []string
    String array that calssifies the term relations.
    IsAs []string
    classifies List<String>
    String array that calssifies the term relations.
    isAs List<String>
    classifies string[]
    String array that calssifies the term relations.
    isAs string[]
    classifies Sequence[str]
    String array that calssifies the term relations.
    is_as Sequence[str]
    classifies List<String>
    String array that calssifies the term relations.
    isAs List<String>

    GlossaryTermTimeouts, GlossaryTermTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    Using pulumi import, import DataZone Glossary Term using a comma-delimited string combining the domain_identifier, id, and the glossary_identifier. For example:

    $ pulumi import aws:datazone/glossaryTerm:GlossaryTerm example domain-id,glossary-term-id,glossary-id
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi