interface CfnEntityRecognizerProps

Language	Type name
.NET	Amazon.CDK.AWS.Comprehend.CfnEntityRecognizerProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscomprehend#CfnEntityRecognizerProps
Java	software.amazon.awscdk.services.comprehend.CfnEntityRecognizerProps
Python	aws_cdk.aws_comprehend.CfnEntityRecognizerProps
TypeScript	aws-cdk-lib » aws_comprehend » CfnEntityRecognizerProps

Properties for defining a CfnEntityRecognizer.

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-lib';
const cfnEntityRecognizerProps: comprehend.CfnEntityRecognizerProps = {
  dataAccessRoleArn: 'dataAccessRoleArn',
  inputDataConfig: {
    entityTypes: [{
      type: 'type',
    }],

    // the properties below are optional
    annotations: {
      s3Uri: 's3Uri',

      // the properties below are optional
      testS3Uri: 'testS3Uri',
    },
    augmentedManifests: [{
      attributeNames: ['attributeNames'],
      s3Uri: 's3Uri',

      // the properties below are optional
      annotationDataS3Uri: 'annotationDataS3Uri',
      documentType: 'documentType',
      sourceDocumentsS3Uri: 'sourceDocumentsS3Uri',
      split: 'split',
    }],
    dataFormat: 'dataFormat',
    documents: {
      s3Uri: 's3Uri',

      // the properties below are optional
      inputFormat: 'inputFormat',
      testS3Uri: 'testS3Uri',
    },
    entityList: {
      s3Uri: 's3Uri',
    },
  },
  languageCode: 'languageCode',
  recognizerName: 'recognizerName',

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

Properties

Name	Type	Description
dataAccessRoleArn	string	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
inputDataConfig	IResolvable | EntityRecognizerInputDataConfigProperty	Specifies the format and location of the input data for an entity recognizer.
languageCode	string	The language of the input documents.
recognizerName	string	The name given to the entity recognizer.
modelKmsKeyId?	string	ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
modelPolicy?	string	The JSON resource-based policy to attach to your custom entity recognizer model.
tags?	CfnTag[]	Tags to associate with the entity recognizer.
versionName?	string	The version name given to the entity recognizer.
volumeKmsKeyId?	string	ID for the AWS KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s).
vpcConfig?	IResolvable | VpcConfigProperty	Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.

---

dataAccessRoleArn

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizer.html#cfn-comprehend-entityrecognizer-dataaccessrolearn

---

inputDataConfig

Type: IResolvable | EntityRecognizerInputDataConfigProperty

Specifies the format and location of the input data for an entity recognizer.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizer.html#cfn-comprehend-entityrecognizer-inputdataconfig

---

languageCode

Type: string

The language of the input documents.

All documents must be in the same language.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizer.html#cfn-comprehend-entityrecognizer-languagecode

---

recognizerName

Type: string

The name given to the entity recognizer.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizer.html#cfn-comprehend-entityrecognizer-recognizername

---

modelKmsKeyId?

Type: string (optional)

ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizer.html#cfn-comprehend-entityrecognizer-modelkmskeyid

---

modelPolicy?

Type: string (optional)

The JSON resource-based policy to attach to your custom entity recognizer model.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizer.html#cfn-comprehend-entityrecognizer-modelpolicy

---

tags?

Type: CfnTag[] (optional)

Tags to associate with the entity recognizer.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizer.html#cfn-comprehend-entityrecognizer-tags

---

versionName?

Type: string (optional)

The version name given to the entity recognizer.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizer.html#cfn-comprehend-entityrecognizer-versionname

---

volumeKmsKeyId?

Type: string (optional)

ID for the AWS KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s).

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizer.html#cfn-comprehend-entityrecognizer-volumekmskeyid

---

vpcConfig?

Type: IResolvable | VpcConfigProperty (optional)

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizer.html#cfn-comprehend-entityrecognizer-vpcconfig