Class CfnDocumentClassifier

This resource creates and trains a document classifier to categorize documents.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDocumentClassifier

Implements

IInspectable

IDocumentClassifierRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Comprehend

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDocumentClassifier : CfnResource, IInspectable, IDocumentClassifierRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnDocumentClassifier Inherits CfnResource Implements IInspectable, IDocumentClassifierRef, IConstruct, IDependable, IEnvironmentAware, 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.

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

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(Construct, string, ICfnDocumentClassifierProps)

Create a new AWS::Comprehend::DocumentClassifier.

Properties

AttrArn	The Amazon Resource Name (ARN) of the document classifier.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	This resource creates and trains a document classifier to categorize documents.
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.
DocumentClassifierRef	A reference to a DocumentClassifier resource.
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>)	This resource creates and trains a document classifier to categorize documents.

Constructors

CfnDocumentClassifier(Construct, string, ICfnDocumentClassifierProps)

Create a new AWS::Comprehend::DocumentClassifier.

public CfnDocumentClassifier(Construct scope, string id, ICfnDocumentClassifierProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDocumentClassifierProps

Resource properties.

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the document classifier.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

CfnProperties

This resource creates and trains a document classifier to categorize documents.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

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

string

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

DocumentClassifierName

The name of the document classifier.

public virtual string DocumentClassifierName { get; set; }

Property Value

string

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

DocumentClassifierRef

A reference to a DocumentClassifier resource.

public virtual IDocumentClassifierReference DocumentClassifierRef { get; }

Property Value

IDocumentClassifierReference

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

InputDataConfig

Specifies the format and location of the input data for the job.

public virtual object InputDataConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDocumentClassifier.IDocumentClassifierInputDataConfigProperty

LanguageCode

The language of the input documents.

public virtual string LanguageCode { get; set; }

Property Value

string

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

Mode

Indicates the mode in which the classifier will be trained.

public virtual string? Mode { get; set; }

Property Value

string

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

ModelKmsKeyId

ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.

public virtual string? ModelKmsKeyId { get; set; }

Property Value

string

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

ModelPolicy

The resource-based policy to attach to your custom document classifier model.

public virtual string? ModelPolicy { get; set; }

Property Value

string

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

OutputDataConfig

Provides output results configuration parameters for custom classifier jobs.

public virtual object? OutputDataConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDocumentClassifier.IDocumentClassifierOutputDataConfigProperty

Tags

Tags to associate with the document classifier.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

VersionName

The version name given to the newly created classifier.

public virtual string? VersionName { get; set; }

Property Value

string

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

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

string

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

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

object

Remarks

Type union: either IResolvable or CfnDocumentClassifier.IVpcConfigProperty

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.

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

This resource creates and trains a document classifier to categorize documents.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

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.

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

CloudformationResource: AWS::Comprehend::DocumentClassifier

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDocumentClassifierRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2