class CfnEntityRecognizerPropsMixin (mixin)

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

Implements IMixin

Extends Mixin

An Amazon Comprehend custom entity recognizer: a trained model that identifies custom entity types in text, created via an asynchronous training job.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizer.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 cfnEntityRecognizerPropsMixin = new comprehend.CfnEntityRecognizerPropsMixin({
  dataAccessRoleArn: 'dataAccessRoleArn',
  inputDataConfig: {
    annotations: {
      s3Uri: 's3Uri',
      testS3Uri: 'testS3Uri',
    },
    augmentedManifests: [{
      annotationDataS3Uri: 'annotationDataS3Uri',
      attributeNames: ['attributeNames'],
      documentType: 'documentType',
      s3Uri: 's3Uri',
      sourceDocumentsS3Uri: 'sourceDocumentsS3Uri',
      split: 'split',
    }],
    dataFormat: 'dataFormat',
    documents: {
      inputFormat: 'inputFormat',
      s3Uri: 's3Uri',
      testS3Uri: 'testS3Uri',
    },
    entityList: {
      s3Uri: 's3Uri',
    },
    entityTypes: [{
      type: 'type',
    }],
  },
  languageCode: 'languageCode',
  modelKmsKeyId: 'modelKmsKeyId',
  modelPolicy: 'modelPolicy',
  recognizerName: 'recognizerName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  versionName: 'versionName',
  volumeKmsKeyId: 'volumeKmsKeyId',
  vpcConfig: {
    securityGroupIds: ['securityGroupIds'],
    subnets: ['subnets'],
  },
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnEntityRecognizerPropsMixin(props: CfnEntityRecognizerMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

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

Properties

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

---

props

Type: CfnEntityRecognizerMixinProps

---

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.