Package software.amazon.awscdk.services.transcribe

Class CfnVocabulary

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.transcribe.CfnVocabulary
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IVocabularyRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:05:02.879Z") @Stability(Stable) public class CfnVocabulary extends CfnResource implements IInspectable, IVocabularyRef, ITaggableV2
Creates a custom vocabulary that you can use to improve the transcription accuracy of domain-specific words and phrases.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transcribe.*;
 CfnVocabulary cfnVocabulary = CfnVocabulary.Builder.create(this, "MyCfnVocabulary")
         .languageCode("languageCode")
         .vocabularyName("vocabularyName")
         // the properties below are optional
         .dataAccessRoleArn("dataAccessRoleArn")
         .phrases(List.of("phrases"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vocabularyFileUri("vocabularyFileUri")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnVocabulary

      protected CfnVocabulary(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnVocabulary

      protected CfnVocabulary(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnVocabulary

      @Stability(Stable) public CfnVocabulary(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnVocabularyProps props)
      Create a new AWS::Transcribe::Vocabulary.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForVocabulary

      @Stability(Stable) @NotNull public static String arnForVocabulary(@NotNull IVocabularyRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnVocabulary

      @Stability(Stable) @NotNull public static Boolean isCfnVocabulary(@NotNull Object x)
      Checks whether the given object is a CfnVocabulary.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the custom vocabulary.

    • getAttrLastModifiedTime

      @Stability(Stable) @NotNull public String getAttrLastModifiedTime()
      The date and time the specified custom vocabulary was last modified.

    • getAttrVocabularyState

      @Stability(Stable) @NotNull public String getAttrVocabularyState()
      The processing state of your custom vocabulary.

      If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getVocabularyRef

      @Stability(Stable) @NotNull public VocabularyReference getVocabularyRef()
      A reference to a Vocabulary resource.
      Specified by:
      getVocabularyRef in interface IVocabularyRef

    • getLanguageCode

      @Stability(Stable) @NotNull public String getLanguageCode()
      The language code that represents the language of the entries in your custom vocabulary.

    • setLanguageCode

      @Stability(Stable) public void setLanguageCode(@NotNull String value)
      The language code that represents the language of the entries in your custom vocabulary.

    • getVocabularyName

      @Stability(Stable) @NotNull public String getVocabularyName()
      A unique name, chosen by you, for your custom vocabulary.

    • setVocabularyName

      @Stability(Stable) public void setVocabularyName(@NotNull String value)
      A unique name, chosen by you, for your custom vocabulary.

    • getDataAccessRoleArn

      @Stability(Stable) @Nullable public String getDataAccessRoleArn()
      The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input file.

    • setDataAccessRoleArn

      @Stability(Stable) public void setDataAccessRoleArn(@Nullable String value)
      The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input file.

    • getPhrases

      @Stability(Stable) @Nullable public List<String> getPhrases()
      Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request.

    • setPhrases

      @Stability(Stable) public void setPhrases(@Nullable List<String> value)
      Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Adds one or more custom tags, each in the form of a key:value pair, to the custom vocabulary.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Adds one or more custom tags, each in the form of a key:value pair, to the custom vocabulary.

    • getVocabularyFileUri

      @Stability(Stable) @Nullable public String getVocabularyFileUri()
      The Amazon S3 location of the text file that contains your custom vocabulary.

    • setVocabularyFileUri

      @Stability(Stable) public void setVocabularyFileUri(@Nullable String value)
      The Amazon S3 location of the text file that contains your custom vocabulary.