Skip to content

Resource: awsTranscribeVocabulary

Terraform resource for managing an AWS Transcribe Vocabulary.

Example Usage

Basic Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
const awsS3BucketExample = new aws.s3Bucket.S3Bucket(this, "example", {
  bucket: "example-vocab-123",
  forceDestroy: true,
});
const awsS3ObjectObject = new aws.s3Object.S3Object(this, "object", {
  bucket: awsS3BucketExample.id,
  key: "transcribe/test1.txt",
  source: "test.txt",
});
const awsTranscribeVocabularyExample =
  new aws.transcribeVocabulary.TranscribeVocabulary(this, "example_2", {
    depends_on: [`\${${awsS3ObjectObject.fqn}}`],
    languageCode: "en-US",
    tags: {
      tag1: "value1",
      tag2: "value3",
    },
    vocabularyFileUri: `s3://\${${awsS3BucketExample.id}}/\${${awsS3ObjectObject.key}}`,
    vocabularyName: "example",
  });
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
awsTranscribeVocabularyExample.overrideLogicalId("example");

Argument Reference

The following arguments are required:

  • languageCode - (Required) The language code you selected for your vocabulary.
  • vocabularyFileUri - (Required) The Amazon S3 location (URI) of the text file that contains your custom vocabulary.
  • vocabularyName - (Required) The name of the Vocabulary.

The following arguments are optional:

  • phrases - (Optional) - A list of terms to include in the vocabulary. Conflicts with vocabularyFileUri
  • vocabularyFileUri - (Optional) The Amazon S3 location (URI) of the text file that contains your custom vocabulary. Conflicts wth phrases.
  • tags - (Optional) A map of tags to assign to the Vocabulary. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - Name of the Vocabulary.
  • arn - ARN of the Vocabulary.
  • downloadUri - Generated download URI.

Timeouts

Configuration options:

  • create - (Default 30M)
  • update - (Default 30M)
  • delete - (Default 30M)

Import

Transcribe Vocabulary can be imported using the vocabularyName, e.g.,

$ terraform import aws_transcribe_vocabulary.example example-name