Package com.pulumi.aws.transcribe

Class VocabularyFilter

  • public class VocabularyFilter
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS Transcribe VocabularyFilter. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.transcribe.VocabularyFilter;
 import com.pulumi.aws.transcribe.VocabularyFilterArgs;
 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 VocabularyFilter("example", VocabularyFilterArgs.builder()
             .vocabularyFilterName("example")
             .languageCode("en-US")
             .words(            
                 "cars",
                 "bucket")
             .tags(Map.ofEntries(
                 Map.entry("tag1", "value1"),
                 Map.entry("tag2", "value3")
             ))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Transcribe VocabularyFilter using the `vocabularyFilterName`. For example: ```sh $ pulumi import aws:transcribe/vocabularyFilter:VocabularyFilter example example-name ```

    • 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> arn()  
      com.pulumi.core.Output<java.lang.String> downloadUri()  
      static VocabularyFilter get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, VocabularyFilterState 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> languageCode()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> vocabularyFilterFileUri()  
      com.pulumi.core.Output<java.lang.String> vocabularyFilterName()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> words()  

      • 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

      • VocabularyFilter

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

      • VocabularyFilter

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

      • VocabularyFilter

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

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the VocabularyFilter.

      • downloadUri

        public com.pulumi.core.Output<java.lang.String> downloadUri()
        Returns:
        Generated download URI.

      • languageCode

        public com.pulumi.core.Output<java.lang.String> languageCode()
        Returns:
        Language code you selected for your vocabulary filter. Refer to the [supported languages](https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) page for accepted codes.

      • 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.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the VocabularyFilter. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()

      • vocabularyFilterFileUri

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> vocabularyFilterFileUri()
        Returns:
        Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with `words` argument.

      • vocabularyFilterName

        public com.pulumi.core.Output<java.lang.String> vocabularyFilterName()
        Returns:
        Name of the VocabularyFilter. The following arguments are optional:

      • words

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> words()
        Returns:
        List of terms to include in the vocabulary. Conflicts with `vocabularyFilterFileUri` argument.

      • get

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