CfnVocabularyProps

class aws_cdk.aws_transcribe.CfnVocabularyProps(*, language_code, vocabulary_name, data_access_role_arn=None, phrases=None, tags=None, vocabulary_file_uri=None)

Bases: object

Properties for defining a CfnVocabulary.

Parameters:
  • language_code (str) – The language code that represents the language of the entries in your custom vocabulary. Each custom vocabulary must contain terms in only one language.

  • vocabulary_name (str) – 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.

  • data_access_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input file.

  • phrases (Optional[Sequence[str]]) – 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 (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Adds one or more custom tags, each in the form of a key:value pair, to the custom vocabulary.

  • vocabulary_file_uri (Optional[str]) – The Amazon S3 location of the text file that contains your custom vocabulary. You cannot use this parameter together with Phrases.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_transcribe as transcribe

cfn_vocabulary_props = transcribe.CfnVocabularyProps(
    language_code="languageCode",
    vocabulary_name="vocabularyName",

    # the properties below are optional
    data_access_role_arn="dataAccessRoleArn",
    phrases=["phrases"],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vocabulary_file_uri="vocabularyFileUri"
)

Attributes

data_access_role_arn

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

See:

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

language_code

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:

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

phrases

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:

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

tags

value pair, to the custom vocabulary.

See:

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

Type:

Adds one or more custom tags, each in the form of a key

vocabulary_file_uri

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

You cannot use this parameter together with Phrases.

See:

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

vocabulary_name

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:

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