DocumentClassifierArgs class

The set of arguments for DocumentClassifier. The set of arguments for DocumentClassifier.

Constructors

DocumentClassifierArgs({required Input<String> dataAccessRoleArn, required Input<DocumentClassifierInputDataConfig> inputDataConfig, required Input<String> languageCode, Input<String?>? mode, Input<String?>? modelKmsKeyId, Input<String?>? name, Input<DocumentClassifierOutputDataConfig?>? outputDataConfig, Input<String?>? region, Input<Map<String, String>?>? tags, Input<String?>? versionName, Input<String?>? versionNamePrefix, Input<String?>? volumeKmsKeyId, Input<DocumentClassifierVpcConfig?>? vpcConfig})
Creates a new DocumentClassifierArgs. dataAccessRoleArn The ARN for an IAM Role which allows Comprehend to read the training and testing data. inputDataConfig Configuration for the training and testing data. languageCode Two-letter language code for the language. mode The document classification mode. modelKmsKeyId KMS Key used to encrypt trained Document Classifiers. name Name for the Document Classifier. outputDataConfig Configuration for the output results of training. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. tags A map of tags to assign to the resource. If configured with a provider defaultTags Configuration Block present, tags with matching keys will overwrite those defined at the provider-level. versionName Name for the version of the Document Classifier. versionNamePrefix Creates a unique version name beginning with the specified prefix. volumeKmsKeyId KMS Key used to encrypt storage volumes during job processing. vpcConfig Configuration parameters for VPC to contain Document Classifier resources.
const
DocumentClassifierArgs.fromMap(Map<String, dynamic> map)
factory

Properties

dataAccessRoleArn → Input<String>
The ARN for an IAM Role which allows Comprehend to read the training and testing data.
final
hashCode int
The hash code for this object.
no setterinherited
inputDataConfig → Input<DocumentClassifierInputDataConfig>
Configuration for the training and testing data. See the inputDataConfig Configuration Block section below.
final
languageCode → Input<String>
Two-letter language code for the language. One of en, es, fr, it, de, or pt.
final
mode → Input<String?>?
The document classification mode. One of MULTI_CLASS or MULTI_LABEL. MULTI_CLASS is also known as "Single Label" in the AWS Console.
final
modelKmsKeyId → Input<String?>?
KMS Key used to encrypt trained Document Classifiers. Can be a KMS Key ID or a KMS Key ARN.
final
name → Input<String?>?
Name for the Document Classifier. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-).
final
outputDataConfig → Input<DocumentClassifierOutputDataConfig?>?
Configuration for the output results of training. See the outputDataConfig Configuration Block section below.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
tags → Input<Map<String, String>?>?
A map of tags to assign to the resource. If configured with a provider defaultTags Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
final
versionName → Input<String?>?
Name for the version of the Document Classifier. Each version must have a unique name within the Document Classifier. If omitted, the provider will assign a random, unique version name. If explicitly set to "", no version name will be set. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with versionNamePrefix.
final
versionNamePrefix → Input<String?>?
Creates a unique version name beginning with the specified prefix. Has a maximum length of 37 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with versionName.
final
volumeKmsKeyId → Input<String?>?
KMS Key used to encrypt storage volumes during job processing. Can be a KMS Key ID or a KMS Key ARN.
final
vpcConfig → Input<DocumentClassifierVpcConfig?>?
Configuration parameters for VPC to contain Document Classifier resources. See the vpcConfig Configuration Block section below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() Map<String, dynamic>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited