Class Glossary


  • public class Glossary
    extends com.pulumi.resources.CustomResource
    Resource for managing an AWS DataZone Glossary. ## 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 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 domainExecutionRole = new Role("domainExecutionRole", RoleArgs.builder()
                 .inlinePolicies(RoleInlinePolicyArgs.builder()
                     .name("example_name")
                     .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_name")
                 .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 test = new Domain("test", DomainArgs.builder()
                 .name("example_name")
                 .domainExecutionRole(domainExecutionRole.arn())
                 .build());
     
             var testSecurityGroup = new SecurityGroup("testSecurityGroup", SecurityGroupArgs.builder()
                 .name("example_name")
                 .build());
     
             var testProject = new Project("testProject", ProjectArgs.builder()
                 .domainIdentifier(test.id())
                 .glossaryTerms("2N8w6XJCwZf")
                 .name("example_name")
                 .description("desc")
                 .skipDeletionCheck(true)
                 .build());
     
             var testGlossary = new Glossary("testGlossary", GlossaryArgs.builder()
                 .description("description")
                 .name("example_name")
                 .owningProjectIdentifier(testProject.id())
                 .status("DISABLED")
                 .domainIdentifier(testProject.domainIdentifier())
                 .build());
     
         }
     }
     
     
    ### Basic Usage
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.datazone.Glossary;
     import com.pulumi.aws.datazone.GlossaryArgs;
     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 test = new Glossary("test", GlossaryArgs.builder()
                 .description("description")
                 .name("example_name")
                 .owningProjectIdentifier(testAwsDatazoneProject.id())
                 .status("DISABLED")
                 .domainIdentifier(testAwsDatazoneProject.domainIdentifier())
                 .build());
     
         }
     }
     
     
    ## Import ### Identity Schema #### Required * `domainIdentifier` - (String) Identifier of the DataZone domain. * `id` - (String) ID of the glossary. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import DataZone Glossary using the import DataZone Glossary using a comma-delimited string combining the domain ID, glossary ID, and the ID of the project it's under. For example: ```sh $ pulumi import aws:datazone/glossary:Glossary example domain-id,glossary-id,owning-project-identifier ```
    • 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
    • Constructor Summary

      Constructors 
      Constructor Description
      Glossary​(java.lang.String name)  
      Glossary​(java.lang.String name, GlossaryArgs args)  
      Glossary​(java.lang.String name, GlossaryArgs args, com.pulumi.resources.CustomResourceOptions options)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> domainIdentifier()  
      static Glossary get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, GlossaryState 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> name()  
      com.pulumi.core.Output<java.lang.String> owningProjectIdentifier()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> status()  
      • 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

      • Glossary

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

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

        public Glossary​(java.lang.String name,
                        GlossaryArgs 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

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the glossary. Must have a length between 0 and 4096.
      • domainIdentifier

        public com.pulumi.core.Output<java.lang.String> domainIdentifier()
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the glossary. Must have length between 1 and 256.
      • owningProjectIdentifier

        public com.pulumi.core.Output<java.lang.String> owningProjectIdentifier()
        Returns:
        ID of the project that owns business glossary. Must follow regex of ^[a-zA-Z0-9_-]{1,36}$. 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.
      • status

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> status()
        Returns:
        Status of business glossary. Valid values are DISABLED and ENABLED.
      • get

        public static Glossary get​(java.lang.String name,
                                   com.pulumi.core.Output<java.lang.String> id,
                                   @Nullable
                                   GlossaryState 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.