Package software.amazon.awscdk.cfnpropertymixins.services.transcribe

Interface CfnVocabularyMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVocabularyMixinProps.Jsii$Proxy

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

Properties for CfnVocabularyPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.transcribe.*;
 CfnVocabularyMixinProps cfnVocabularyMixinProps = CfnVocabularyMixinProps.builder()
         .dataAccessRoleArn("dataAccessRoleArn")
         .languageCode("languageCode")
         .phrases(List.of("phrases"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vocabularyFileUri("vocabularyFileUri")
         .vocabularyName("vocabularyName")
         .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	CfnVocabularyMixinProps.Builder	A builder for CfnVocabularyMixinProps
static final class	CfnVocabularyMixinProps.Jsii$Proxy	An implementation for CfnVocabularyMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnVocabularyMixinProps.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.
default 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.
default String	getVocabularyName()	A unique name, chosen by you, for your custom vocabulary.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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

getLanguageCode

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

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

getVocabularyName

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

builder

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

Returns:

a CfnVocabularyMixinProps.Builder of CfnVocabularyMixinProps