CfnVocabularyFilterProps

class aws_cdk.aws_transcribe.CfnVocabularyFilterProps(*, language_code, vocabulary_filter_name, data_access_role_arn=None, tags=None, vocabulary_filter_file_uri=None, words=None)

Bases: object

Properties for defining a CfnVocabularyFilter.

Parameters:

  • language_code (str) – The language code that represents the language of the entries in your vocabulary filter.

  • vocabulary_filter_name (str) – A unique name, chosen by you, for your custom vocabulary filter.

  • 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 files.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags associated with the vocabulary filter.

  • vocabulary_filter_file_uri (Optional[str]) – The Amazon S3 location of the text file that contains your custom vocabulary filter terms.

  • words (Optional[Sequence[str]]) – Use this parameter if you want to create your custom vocabulary filter by including all desired terms, as comma-separated values, within your request.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transcribe-vocabularyfilter.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_filter_props = transcribe.CfnVocabularyFilterProps(
    language_code="languageCode",
    vocabulary_filter_name="vocabularyFilterName",

    # the properties below are optional
    data_access_role_arn="dataAccessRoleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vocabulary_filter_file_uri="vocabularyFilterFileUri",
    words=["words"]
)

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 files.

See:

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

language_code

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

See:

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

tags

Tags associated with the vocabulary filter.

See:

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

vocabulary_filter_file_uri

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

See:

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

vocabulary_filter_name

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

See:

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

words

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

See:

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