AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Comprehend::DocumentClassifier

CfnDocumentClassifier

This resource creates and trains a document classifier to categorize documents. You provide a set of training documents that are labeled with the categories that you want to identify. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see [Document Classification](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) in the Comprehend Developer Guide.

Import

import { CfnDocumentClassifier } from 'aws-cdk-lib/aws-comprehend';

Or use the module namespace:

import * as comprehend from 'aws-cdk-lib/aws-comprehend';
// comprehend.CfnDocumentClassifier

Properties

Configuration passed to the constructor as CfnDocumentClassifierProps.

dataAccessRoleArnRequired
string

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

documentClassifierNameRequired
string

The name of the document classifier.

inputDataConfigRequired
IResolvable | DocumentClassifierInputDataConfigProperty

Specifies the format and location of the input data for the job.

languageCodeRequired
string

The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.

modeOptional
string

Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode identifies a single class label for each document and multi-label mode identifies one or more class labels for each document. Multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

modelKmsKeyIdOptional
string

ID for the AWS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats: - KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"` - Amazon Resource Name (ARN) of a KMS Key: `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`

modelPolicyOptional
string

The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model. Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy: `"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"` To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values: `'{"attribute": "value", "attribute": ["value"]}'`

outputDataConfigOptional
IResolvable | DocumentClassifierOutputDataConfigProperty

Provides output results configuration parameters for custom classifier jobs.

tagsOptional
CfnTag[]

Tags to associate with the document classifier. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

versionNameOptional
string

The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the AWS account / AWS Region .

volumeKmsKeyIdOptional
string

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: - KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"` - Amazon Resource Name (ARN) of a KMS Key: `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`

vpcConfigOptional
IResolvable | VpcConfigProperty

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see [Amazon VPC](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-comprehend
CFN TypeAWS::Comprehend::DocumentClassifier
Properties12

Related Constructs

External Links