CfnEntityRecognizerProps Struct
Properties for defining a CfnEntityRecognizer.
Example
ts
// 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
dataAccessRoleArnstringdata_access_role_arnstrdataAccessRoleArnStringDataAccessRoleArnstringDataAccessRoleArn*stringrequired#The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
inputDataConfigIResolvable | CfnEntityRecognizer.EntityRecognizerInputDataConfigPropertyinput_data_configtyping.Union[IResolvable, EntityRecognizerInputDataConfigProperty]inputDataConfigIResolvableInputDataConfigIResolvableInputDataConfiginterface{}required#Specifies the format and location of the input data for an entity recognizer.
The language of the input documents.
All documents must be in the same language.
modelKmsKeyIdoptionalstringmodel_kms_key_idoptionalstrmodelKmsKeyIdoptionalStringModelKmsKeyIdoptionalstringModelKmsKeyIdoptional*string#ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
modelPolicyoptionalstringmodel_policyoptionalstrmodelPolicyoptionalStringModelPolicyoptionalstringModelPolicyoptional*string#The JSON resource-based policy to attach to your custom entity recognizer model.
recognizerNamestringrecognizer_namestrrecognizerNameStringRecognizerNamestringRecognizerName*stringrequired#The name given to the entity recognizer.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#Tags to associate with the entity recognizer.
versionNameoptionalstringversion_nameoptionalstrversionNameoptionalStringVersionNameoptionalstringVersionNameoptional*string#The version name given to the entity recognizer.
volumeKmsKeyIdoptionalstringvolume_kms_key_idoptionalstrvolumeKmsKeyIdoptionalStringVolumeKmsKeyIdoptionalstringVolumeKmsKeyIdoptional*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).
vpcConfigoptionalIResolvable | CfnEntityRecognizer.VpcConfigPropertyvpc_configoptionaltyping.Union[IResolvable, VpcConfigProperty]vpcConfigoptionalIResolvableVpcConfigoptionalIResolvableVpcConfigoptionalinterface{}#Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.