aws-cdk-lib.aws_comprehend.CfnDocumentClassifierProps

interface CfnDocumentClassifierProps

LanguageType name
.NETAmazon.CDK.AWS.Comprehend.CfnDocumentClassifierProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscomprehend#CfnDocumentClassifierProps
Javasoftware.amazon.awscdk.services.comprehend.CfnDocumentClassifierProps
Pythonaws_cdk.aws_comprehend.CfnDocumentClassifierProps
TypeScript aws-cdk-lib » aws_comprehend » CfnDocumentClassifierProps

Properties for defining a CfnDocumentClassifier.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_comprehend as comprehend } from 'aws-cdk-lib';
const cfnDocumentClassifierProps: comprehend.CfnDocumentClassifierProps = {
  dataAccessRoleArn: 'dataAccessRoleArn',
  documentClassifierName: 'documentClassifierName',
  inputDataConfig: {
    augmentedManifests: [{
      attributeNames: ['attributeNames'],
      s3Uri: 's3Uri',

      // the properties below are optional
      split: 'split',
    }],
    dataFormat: 'dataFormat',
    documentReaderConfig: {
      documentReadAction: 'documentReadAction',

      // the properties below are optional
      documentReadMode: 'documentReadMode',
      featureTypes: ['featureTypes'],
    },
    documents: {
      s3Uri: 's3Uri',

      // the properties below are optional
      testS3Uri: 'testS3Uri',
    },
    documentType: 'documentType',
    labelDelimiter: 'labelDelimiter',
    s3Uri: 's3Uri',
    testS3Uri: 'testS3Uri',
  },
  languageCode: 'languageCode',

  // the properties below are optional
  mode: 'mode',
  modelKmsKeyId: 'modelKmsKeyId',
  modelPolicy: 'modelPolicy',
  outputDataConfig: {
    kmsKeyId: 'kmsKeyId',
    s3Uri: 's3Uri',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  versionName: 'versionName',
  volumeKmsKeyId: 'volumeKmsKeyId',
  vpcConfig: {
    securityGroupIds: ['securityGroupIds'],
    subnets: ['subnets'],
  },
};

Properties

NameTypeDescription
dataAccessRoleArnstringThe Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
documentClassifierNamestringThe name of the document classifier.
inputDataConfigIResolvable | DocumentClassifierInputDataConfigPropertySpecifies the format and location of the input data for the job.
languageCodestringThe language of the input documents.
mode?stringIndicates the mode in which the classifier will be trained.
modelKmsKeyId?stringID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
modelPolicy?stringThe resource-based policy to attach to your custom document classifier model.
outputDataConfig?IResolvable | DocumentClassifierOutputDataConfigPropertyProvides output results configuration parameters for custom classifier jobs.
tags?CfnTag[]Tags to associate with the document classifier.
versionName?stringThe version name given to the newly created classifier.
volumeKmsKeyId?stringID 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.
vpcConfig?IResolvable | VpcConfigPropertyConfiguration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.

dataAccessRoleArn

Type: string

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


documentClassifierName

Type: string

The name of the document classifier.


inputDataConfig

Type: IResolvable | DocumentClassifierInputDataConfigProperty

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


languageCode

Type: 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.


mode?

Type: string (optional)

Indicates the mode in which the classifier will be trained.

The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).


modelKmsKeyId?

Type: string (optional)

ID for the AWS KMS 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"

modelPolicy?

Type: string (optional)

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"]}'


outputDataConfig?

Type: IResolvable | DocumentClassifierOutputDataConfigProperty (optional)

Provides output results configuration parameters for custom classifier jobs.


tags?

Type: CfnTag[] (optional)

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.


versionName?

Type: string (optional)

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 .


volumeKmsKeyId?

Type: string (optional)

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"

vpcConfig?

Type: IResolvable | VpcConfigProperty (optional)

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 .