Package software.amazon.awscdk.services.transcribe

Interface CfnVocabularyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVocabularyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:05:02.881Z")
@Stability(Stable)
public interface CfnVocabularyProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.transcribe.*;
 CfnVocabularyProps cfnVocabularyProps = CfnVocabularyProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transcribe-vocabulary.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVocabularyProps.Builder	A builder for CfnVocabularyProps
static final class	CfnVocabularyProps.Jsii$Proxy	An implementation for CfnVocabularyProps

Method Summary

Modifier and Type	Method	Description
static CfnVocabularyProps.Builder	builder()
default 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.
String	getLanguageCode()	The language code that represents the language of the entries in your custom vocabulary.
default 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.
default List<CfnTag>	getTags()	Adds one or more custom tags, each in the form of a key:value pair, to the custom vocabulary.
default String	getVocabularyFileUri()	The Amazon S3 location of the text file that contains your custom vocabulary.
String	getVocabularyName()	A unique name, chosen by you, for your custom vocabulary.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLanguageCode

@Stability(Stable)
@NotNull
String getLanguageCode()

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

Each custom vocabulary must contain terms in only one language.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transcribe-vocabulary.html#cfn-transcribe-vocabulary-languagecode

getVocabularyName

@Stability(Stable)
@NotNull
String getVocabularyName()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transcribe-vocabulary.html#cfn-transcribe-vocabulary-vocabularyname

getDataAccessRoleArn

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transcribe-vocabulary.html#cfn-transcribe-vocabulary-dataaccessrolearn

getPhrases

@Stability(Stable)
@Nullable
default 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.

You cannot use this parameter together with VocabularyFileUri.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transcribe-vocabulary.html#cfn-transcribe-vocabulary-phrases

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transcribe-vocabulary.html#cfn-transcribe-vocabulary-tags

getVocabularyFileUri

@Stability(Stable)
@Nullable
default String getVocabularyFileUri()

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

You cannot use this parameter together with Phrases.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transcribe-vocabulary.html#cfn-transcribe-vocabulary-vocabularyfileuri

builder

@Stability(Stable)
static CfnVocabularyProps.Builder builder()

Returns:

a CfnVocabularyProps.Builder of CfnVocabularyProps