Interface ICfnEntityRecognizerProps

Properties for defining a CfnEntityRecognizer.

Namespace: Amazon.CDK.AWS.Comprehend

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnEntityRecognizerProps

Syntax (vb)

Public Interface ICfnEntityRecognizerProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Comprehend;

             var cfnEntityRecognizerProps = new CfnEntityRecognizerProps {
                 DataAccessRoleArn = "dataAccessRoleArn",
                 InputDataConfig = new EntityRecognizerInputDataConfigProperty {
                     EntityTypes = new [] { new EntityTypesListItemProperty {
                         Type = "type"
                     } },

                     // the properties below are optional
                     Annotations = new EntityRecognizerAnnotationsProperty {
                         S3Uri = "s3Uri",

                         // the properties below are optional
                         TestS3Uri = "testS3Uri"
                     },
                     AugmentedManifests = new [] { new AugmentedManifestsListItemProperty {
                         AttributeNames = new [] { "attributeNames" },
                         S3Uri = "s3Uri",

                         // the properties below are optional
                         AnnotationDataS3Uri = "annotationDataS3Uri",
                         DocumentType = "documentType",
                         SourceDocumentsS3Uri = "sourceDocumentsS3Uri",
                         Split = "split"
                     } },
                     DataFormat = "dataFormat",
                     Documents = new EntityRecognizerDocumentsProperty {
                         S3Uri = "s3Uri",

                         // the properties below are optional
                         InputFormat = "inputFormat",
                         TestS3Uri = "testS3Uri"
                     },
                     EntityList = new EntityRecognizerEntityListProperty {
                         S3Uri = "s3Uri"
                     }
                 },
                 LanguageCode = "languageCode",
                 RecognizerName = "recognizerName",

                 // the properties below are optional
                 ModelKmsKeyId = "modelKmsKeyId",
                 ModelPolicy = "modelPolicy",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VersionName = "versionName",
                 VolumeKmsKeyId = "volumeKmsKeyId",
                 VpcConfig = new VpcConfigProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     Subnets = new [] { "subnets" }
                 }
             };

Synopsis

Properties

DataAccessRoleArn	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
InputDataConfig	Specifies the format and location of the input data for an entity recognizer.
LanguageCode	The language of the input documents.
ModelKmsKeyId	ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
ModelPolicy	The JSON resource-based policy to attach to your custom entity recognizer model.
RecognizerName	The name given to the entity recognizer.
Tags	Tags to associate with the entity recognizer.
VersionName	The version name given to the entity recognizer.
VolumeKmsKeyId	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	Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.