2.272.0

interface CfnEntityRecognizerMixinProps

LanguageType name
.NETAmazon.CDK.CfnPropertyMixins.AWS.Comprehend.CfnEntityRecognizerMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awscomprehend#CfnEntityRecognizerMixinProps
Javasoftware.amazon.awscdk.cfnpropertymixins.services.comprehend.CfnEntityRecognizerMixinProps
Pythonaws_cdk.cfn_property_mixins.aws_comprehend.CfnEntityRecognizerMixinProps
TypeScript @aws-cdk/cfn-property-mixins » aws_comprehend » CfnEntityRecognizerMixinProps

Properties for CfnEntityRecognizerPropsMixin.

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';
const cfnEntityRecognizerMixinProps: comprehend.CfnEntityRecognizerMixinProps = {
  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'],
  },
};

Properties

NameTypeDescription
dataAccessRoleArn?stringThe Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
inputDataConfig?IResolvable | EntityRecognizerInputDataConfigPropertySpecifies the format and location of the input data for an entity recognizer.
languageCode?stringThe language of the input documents.
modelKmsKeyId?stringID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
modelPolicy?stringThe JSON resource-based policy to attach to your custom entity recognizer model.
recognizerName?stringThe name given to the entity recognizer.
tags?CfnTag[]Tags to associate with the entity recognizer.
versionName?stringThe version name given to the entity recognizer.
volumeKmsKeyId?stringID 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 | VpcConfigPropertyConfiguration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.

dataAccessRoleArn?

Type: string (optional)

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 (optional)

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 (optional)

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

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

recognizerName?

Type: string (optional)

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

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

← PreviousNext →