Class CfnDocumentClassifier
This resource creates and trains a document classifier to categorize documents.
Inherited Members
Namespace: Amazon.CDK.AWS.Comprehend
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDocumentClassifier : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnDocumentClassifier
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
You provide a set of training documents that are labeled with the categories that you want to identify. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see Document Classification in the Comprehend Developer Guide.
CloudformationResource: AWS::Comprehend::DocumentClassifier
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 cfnDocumentClassifier = new CfnDocumentClassifier(this, "MyCfnDocumentClassifier", 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
CfnDocumentClassifier(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDocumentClassifier(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDocumentClassifier(Construct, String, ICfnDocumentClassifierProps) |
Properties
AttrArn | The Amazon Resource Name (ARN) of the document classifier. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DataAccessRoleArn | The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. |
DocumentClassifierName | The name of the document classifier. |
InputDataConfig | Specifies the format and location of the input data for the job. |
LanguageCode | The language of the input documents. |
Mode | Indicates the mode in which the classifier will be trained. |
ModelKmsKeyId | ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models. |
ModelPolicy | The resource-based policy to attach to your custom document classifier model. |
OutputDataConfig | Provides output results configuration parameters for custom classifier jobs. |
Tags | Tags to associate with the document classifier. |
VersionName | The version name given to the newly created classifier. |
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. |
VpcConfig | Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDocumentClassifier(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDocumentClassifier(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDocumentClassifier(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDocumentClassifier(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDocumentClassifier(Construct, String, ICfnDocumentClassifierProps)
public CfnDocumentClassifier(Construct scope, string id, ICfnDocumentClassifierProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDocumentClassifierProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the document classifier.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DataAccessRoleArn
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
public virtual string DataAccessRoleArn { get; set; }
Property Value
System.String
DocumentClassifierName
The name of the document classifier.
public virtual string DocumentClassifierName { get; set; }
Property Value
System.String
InputDataConfig
Specifies the format and location of the input data for the job.
public virtual object InputDataConfig { get; set; }
Property Value
System.Object
LanguageCode
The language of the input documents.
public virtual string LanguageCode { get; set; }
Property Value
System.String
Mode
Indicates the mode in which the classifier will be trained.
public virtual string Mode { get; set; }
Property Value
System.String
ModelKmsKeyId
ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
public virtual string ModelKmsKeyId { get; set; }
Property Value
System.String
ModelPolicy
The resource-based policy to attach to your custom document classifier model.
public virtual string ModelPolicy { get; set; }
Property Value
System.String
OutputDataConfig
Provides output results configuration parameters for custom classifier jobs.
public virtual object OutputDataConfig { get; set; }
Property Value
System.Object
Tags
Tags to associate with the document classifier.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
VersionName
The version name given to the newly created classifier.
public virtual string VersionName { get; set; }
Property Value
System.String
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 virtual string VolumeKmsKeyId { get; set; }
Property Value
System.String
VpcConfig
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.
public virtual object VpcConfig { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>