class CfnDocumentClassifierPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.Comprehend.CfnDocumentClassifierPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awscomprehend#CfnDocumentClassifierPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.comprehend.CfnDocumentClassifierPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_comprehend.CfnDocumentClassifierPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_comprehend » CfnDocumentClassifierPropsMixin

Implements IMixin

Extends Mixin

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 in the Comprehend Developer Guide.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html

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/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnDocumentClassifierPropsMixin = new comprehend.CfnDocumentClassifierPropsMixin({
  dataAccessRoleArn: 'dataAccessRoleArn',
  documentClassifierName: 'documentClassifierName',
  inputDataConfig: {
    augmentedManifests: [{
      attributeNames: ['attributeNames'],
      s3Uri: 's3Uri',
      split: 'split',
    }],
    dataFormat: 'dataFormat',
    documentReaderConfig: {
      documentReadAction: 'documentReadAction',
      documentReadMode: 'documentReadMode',
      featureTypes: ['featureTypes'],
    },
    documents: {
      s3Uri: 's3Uri',
      testS3Uri: 'testS3Uri',
    },
    documentType: 'documentType',
    labelDelimiter: 'labelDelimiter',
    s3Uri: 's3Uri',
    testS3Uri: 'testS3Uri',
  },
  languageCode: 'languageCode',
  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'],
  },
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnDocumentClassifierPropsMixin(props: CfnDocumentClassifierMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDocumentClassifierMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Comprehend::DocumentClassifier.

Properties

Name	Type	Description
props	CfnDocumentClassifierMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDocumentClassifierMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.