Class CfnDocumentClassifierProps
Properties for defining a CfnDocumentClassifier.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Comprehend
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDocumentClassifierProps : Object, ICfnDocumentClassifierPropsSyntax (vb)
Public Class CfnDocumentClassifierProps
Inherits Object
Implements ICfnDocumentClassifierPropsRemarks
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 cfnDocumentClassifierProps = new CfnDocumentClassifierProps {
DataAccessRoleArn = "dataAccessRoleArn",
DocumentClassifierName = "documentClassifierName",
InputDataConfig = new DocumentClassifierInputDataConfigProperty {
AugmentedManifests = new [] { new AugmentedManifestsListItemProperty {
AttributeNames = new [] { "attributeNames" },
S3Uri = "s3Uri",
// the properties below are optional
Split = "split"
} },
DataFormat = "dataFormat",
DocumentReaderConfig = new DocumentReaderConfigProperty {
DocumentReadAction = "documentReadAction",
// the properties below are optional
DocumentReadMode = "documentReadMode",
FeatureTypes = new [] { "featureTypes" }
},
Documents = new DocumentClassifierDocumentsProperty {
S3Uri = "s3Uri",
// the properties below are optional
TestS3Uri = "testS3Uri"
},
DocumentType = "documentType",
LabelDelimiter = "labelDelimiter",
S3Uri = "s3Uri",
TestS3Uri = "testS3Uri"
},
LanguageCode = "languageCode",
// the properties below are optional
Mode = "mode",
ModelKmsKeyId = "modelKmsKeyId",
ModelPolicy = "modelPolicy",
OutputDataConfig = new DocumentClassifierOutputDataConfigProperty {
KmsKeyId = "kmsKeyId",
S3Uri = "s3Uri"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VersionName = "versionName",
VolumeKmsKeyId = "volumeKmsKeyId",
VpcConfig = new VpcConfigProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
Subnets = new [] { "subnets" }
}
};Synopsis
Constructors
| Cfn |
Properties
| Data |
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. |
| Document |
The name of the document classifier. |
| Input |
Specifies the format and location of the input data for the job. |
| Language |
The language of the input documents. |
| Mode | Indicates the mode in which the classifier will be trained. |
| Model |
ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models. |
| Model |
The resource-based policy to attach to your custom document classifier model. |
| Output |
Provides output results configuration parameters for custom classifier jobs. |
| Tags | Tags to associate with the document classifier. |
| Version |
The version name given to the newly created classifier. |
| Volume |
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. |
| Vpc |
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. |
Constructors
CfnDocumentClassifierProps()
public CfnDocumentClassifierProps()Properties
DataAccessRoleArn
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
public string DataAccessRoleArn { get; set; }Property Value
System.
Remarks
DocumentClassifierName
The name of the document classifier.
public string DocumentClassifierName { get; set; }Property Value
System.
Remarks
InputDataConfig
Specifies the format and location of the input data for the job.
public object InputDataConfig { get; set; }Property Value
System.
Remarks
LanguageCode
The language of the input documents.
public string LanguageCode { get; set; }Property Value
System.
Remarks
You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.
Mode
Indicates the mode in which the classifier will be trained.
public string Mode { get; set; }Property Value
System.
Remarks
The classifier can be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode identifies a single class label for each document and multi-label mode identifies one or more class labels for each document. Multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
ModelKmsKeyId
ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
public string ModelKmsKeyId { get; set; }Property Value
System.
Remarks
The ModelKmsKeyId can be either of the following formats:
ModelPolicy
The resource-based policy to attach to your custom document classifier model.
public string ModelPolicy { get; set; }Property Value
System.
Remarks
You can use this policy to allow another AWS account to import your custom model.
Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
"{"attribute": "value", "attribute": ["value"]}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
'{"attribute": "value", "attribute": ["value"]}'
OutputDataConfig
Provides output results configuration parameters for custom classifier jobs.
public object OutputDataConfig { get; set; }Property Value
System.
Remarks
Tags
Tags to associate with the document classifier.
public ICfnTag[] Tags { get; set; }Property Value
ICfn
Remarks
A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
VersionName
The version name given to the newly created classifier.
public string VersionName { get; set; }Property Value
System.
Remarks
Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the AWS account / AWS Region .
VolumeKmsKeyId
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.
public string VolumeKmsKeyId { get; set; }Property Value
System.
Remarks
The VolumeKmsKeyId can be either of the following formats:
VpcConfig
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.
public object VpcConfig { get; set; }Property Value
System.