Class GlossaryTerm


  • public class GlossaryTerm
    extends com.pulumi.resources.CustomResource
    Resource for managing an AWS DataZone Glossary Term. ## Example Usage
     
     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.ArrayList;
     import java.util.Arrays;
     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()
                 .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())
                 .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")
                                 ))
                             )
                         ))
                     )))
                 .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());
     
         }
     }
     
     
    ## Import ### Identity Schema #### Required * `domainIdentifier` - (String) Identifier of the DataZone domain. * `id` - (String) ID of the glossary term. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import DataZone Glossary Term using a comma-delimited string combining the `domainIdentifier`, `id`, and the `glossaryIdentifier`. For example: ```sh $ pulumi import aws:datazone/glossaryTerm:GlossaryTerm example domain-id,glossary-term-id,glossary-id ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> createdAt()  
      com.pulumi.core.Output<java.lang.String> createdBy()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> domainIdentifier()  
      static GlossaryTerm get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, GlossaryTermState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> glossaryIdentifier()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> longDescription()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> shortDescription()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> status()  
      com.pulumi.core.Output<java.util.Optional<GlossaryTermTermRelations>> termRelations()  
      com.pulumi.core.Output<java.util.Optional<GlossaryTermTimeouts>> timeouts()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • GlossaryTerm

        public GlossaryTerm​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • GlossaryTerm

        public GlossaryTerm​(java.lang.String name,
                            GlossaryTermArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • GlossaryTerm

        public GlossaryTerm​(java.lang.String name,
                            GlossaryTermArgs args,
                            @Nullable
                            com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • createdAt

        public com.pulumi.core.Output<java.lang.String> createdAt()
        Returns:
        Time of glossary term creation.
      • createdBy

        public com.pulumi.core.Output<java.lang.String> createdBy()
        Returns:
        Creator of glossary term.
      • domainIdentifier

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> domainIdentifier()
        Returns:
        Identifier of domain.
      • glossaryIdentifier

        public com.pulumi.core.Output<java.lang.String> glossaryIdentifier()
        Returns:
        Identifier of glossary.
      • longDescription

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> longDescription()
        Returns:
        Long description of entry.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of glossary term. The following arguments are optional:
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • shortDescription

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> shortDescription()
        Returns:
        Short description of entry.
      • status

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> status()
        Returns:
        If glossary term is ENABLED or DISABLED.
      • termRelations

        public com.pulumi.core.Output<java.util.Optional<GlossaryTermTermRelations>> termRelations()
        Returns:
        Object classifying the term relations through the following attributes:
      • get

        public static GlossaryTerm get​(java.lang.String name,
                                       com.pulumi.core.Output<java.lang.String> id,
                                       @Nullable
                                       GlossaryTermState state,
                                       @Nullable
                                       com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.