aws-cdk-lib.aws_transcribe.CfnVocabularyProps

CfnVocabularyProps Struct

Properties for defining a CfnVocabulary.

CfnVocabularyProps

used as props by

• CfnVocabulary

Source

Generated code

Type last changed

v2.272.0 · 30 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_transcribe as transcribe } from 'aws-cdk-lib';
const cfnVocabularyProps: transcribe.CfnVocabularyProps = {
  languageCode: 'languageCode',
  vocabularyName: 'vocabularyName',

  // the properties below are optional
  dataAccessRoleArn: 'dataAccessRoleArn',
  phrases: ['phrases'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vocabularyFileUri: 'vocabularyFileUri',
};

Properties

dataAccessRoleArnstringdata_access_role_arnstrdataAccessRoleArnStringDataAccessRoleArnstringDataAccessRoleArn*string#

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input file.

languageCodestringlanguage_codestrlanguageCodeStringLanguageCodestringLanguageCode*stringrequired#

The language code that represents the language of the entries in your custom vocabulary.

Each custom vocabulary must contain terms in only one language.

phrasesstring[]phrasestyping.List[str]phrasesList<String>Phrasesstring[]Phrases*[]*string#

Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request.

You cannot use this parameter together with VocabularyFileUri.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

Adds one or more custom tags, each in the form of a key:value pair, to the custom vocabulary.

vocabularyFileUristringvocabulary_file_uristrvocabularyFileUriStringVocabularyFileUristringVocabularyFileUri*string#

The Amazon S3 location of the text file that contains your custom vocabulary.

You cannot use this parameter together with Phrases.

vocabularyNamestringvocabulary_namestrvocabularyNameStringVocabularyNamestringVocabularyName*stringrequired#

A unique name, chosen by you, for your custom vocabulary.

This name is case sensitive, cannot contain spaces, and must be unique within an AWS account.