interface CfnVocabularyProps

Language	Type name
.NET	`Amazon.CDK.AWS.Transcribe.CfnVocabularyProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awstranscribe#CfnVocabularyProps`
Java	`software.amazon.awscdk.services.transcribe.CfnVocabularyProps`
Python	`aws_cdk.aws_transcribe.CfnVocabularyProps`
TypeScript	`aws-cdk-lib` » `aws_transcribe` » `CfnVocabularyProps`

Properties for defining a CfnVocabulary.

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

Name	Type	Description
languageCode	`string`	The language code that represents the language of the entries in your custom vocabulary.
vocabularyName	`string`	A unique name, chosen by you, for your custom vocabulary.
dataAccessRoleArn?	`string`	The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input file.
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.
tags?	`CfnTag[]`	Adds one or more custom tags, each in the form of a key:value pair, to the custom vocabulary.
vocabularyFileUri?	`string`	The Amazon S3 location of the text file that contains your custom vocabulary.

languageCode

Type: string

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

Each custom vocabulary must contain terms in only one language.

vocabularyName

Type: string

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.

dataAccessRoleArn?

Type: string (optional)

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

phrases?

Type: string[] (optional)

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.

tags?

Type: CfnTag[] (optional)

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

vocabularyFileUri?