class CfnDocumentClassifier (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.Comprehend.CfnDocumentClassifier`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscomprehend#CfnDocumentClassifier`
Java	`software.amazon.awscdk.services.comprehend.CfnDocumentClassifier`
Python	`aws_cdk.aws_comprehend.CfnDocumentClassifier`
TypeScript	`aws-cdk-lib` » `aws_comprehend` » `CfnDocumentClassifier`

Implements IConstruct, IDependable, IInspectable, ITaggableV2

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

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.

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-lib';
const cfnDocumentClassifier = new comprehend.CfnDocumentClassifier(this, 'MyCfnDocumentClassifier', {
  dataAccessRoleArn: 'dataAccessRoleArn',
  documentClassifierName: 'documentClassifierName',
  inputDataConfig: {
    augmentedManifests: [{
      attributeNames: ['attributeNames'],
      s3Uri: 's3Uri',

      // the properties below are optional
      split: 'split',
    }],
    dataFormat: 'dataFormat',
    documentReaderConfig: {
      documentReadAction: 'documentReadAction',

      // the properties below are optional
      documentReadMode: 'documentReadMode',
      featureTypes: ['featureTypes'],
    },
    documents: {
      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: {
    kmsKeyId: 'kmsKeyId',
    s3Uri: 's3Uri',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  versionName: 'versionName',
  volumeKmsKeyId: 'volumeKmsKeyId',
  vpcConfig: {
    securityGroupIds: ['securityGroupIds'],
    subnets: ['subnets'],
  },
});

Initializer

new CfnDocumentClassifier(scope: Construct, id: string, props: CfnDocumentClassifierProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnDocumentClassifierProps — Resource properties.

Construct Props

Name	Type	Description
dataAccessRoleArn	`string`	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
documentClassifierName	`string`	The name of the document classifier.
inputDataConfig	`IResolvable` `\|` `DocumentClassifierInputDataConfigProperty`	Specifies the format and location of the input data for the job.
languageCode	`string`	The language of the input documents.
mode?	`string`	Indicates the mode in which the classifier will be trained.
modelKmsKeyId?	`string`	ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
modelPolicy?	`string`	The resource-based policy to attach to your custom document classifier model.
outputDataConfig?	`IResolvable` `\|` `DocumentClassifierOutputDataConfigProperty`	Provides output results configuration parameters for custom classifier jobs.
tags?	`CfnTag[]`	Tags to associate with the document classifier.
versionName?	`string`	The version name given to the newly created classifier.
volumeKmsKeyId?	`string`	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?	`IResolvable` `\|` `VpcConfigProperty`	Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.

dataAccessRoleArn

Type: string

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

documentClassifierName

Type: string

The name of the document classifier.

inputDataConfig

Type: IResolvable | DocumentClassifierInputDataConfigProperty

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

languageCode

Type: string

The language of the input documents.

You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.

mode?

Type: string (optional)

Indicates the mode in which the classifier will be trained.

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?

Type: string (optional)

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

The ModelKmsKeyId can be either of the following formats:

KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

modelPolicy?

Type: string (optional)

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

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?

Type: IResolvable | DocumentClassifierOutputDataConfigProperty (optional)

Provides output results configuration parameters for custom classifier jobs.

tags?

Type: CfnTag[] (optional)

Tags to associate with the document classifier.

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?

Type: string (optional)

The version name given to the newly created classifier.

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?

Type: string (optional)

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.

The VolumeKmsKeyId can be either of the following formats:

KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

vpcConfig?

Type: IResolvable | VpcConfigProperty (optional)

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.

For more information, see Amazon VPC .

Properties

Name	Type	Description
attrArn	`string`	The Amazon Resource Name (ARN) of the document classifier.
cdkTagManager	`TagManager`	Tag Manager which manages the tags for this resource.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
dataAccessRoleArn	`string`	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
documentClassifierName	`string`	The name of the document classifier.
inputDataConfig	`IResolvable` `\|` `DocumentClassifierInputDataConfigProperty`	Specifies the format and location of the input data for the job.
languageCode	`string`	The language of the input documents.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
mode?	`string`	Indicates the mode in which the classifier will be trained.
modelKmsKeyId?	`string`	ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
modelPolicy?	`string`	The resource-based policy to attach to your custom document classifier model.
outputDataConfig?	`IResolvable` `\|` `DocumentClassifierOutputDataConfigProperty`	Provides output results configuration parameters for custom classifier jobs.
tags?	`CfnTag[]`	Tags to associate with the document classifier.
versionName?	`string`	The version name given to the newly created classifier.
volumeKmsKeyId?	`string`	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?	`IResolvable` `\|` `VpcConfigProperty`	Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

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

cdkTagManager

Type: TagManager

Tag Manager which manages the tags for this resource.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

dataAccessRoleArn

Type: string

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

documentClassifierName

Type: string

The name of the document classifier.

inputDataConfig

Type: IResolvable | DocumentClassifierInputDataConfigProperty

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

languageCode

Type: string

The language of the input documents.

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

mode?

Type: string (optional)

Indicates the mode in which the classifier will be trained.

modelKmsKeyId?

Type: string (optional)

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

modelPolicy?

Type: string (optional)

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

outputDataConfig?

Type: IResolvable | DocumentClassifierOutputDataConfigProperty (optional)

Provides output results configuration parameters for custom classifier jobs.

tags?

Type: CfnTag[] (optional)

Tags to associate with the document classifier.

versionName?

Type: string (optional)

The version name given to the newly created classifier.

volumeKmsKeyId?

Type: string (optional)

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?

Type: IResolvable | VpcConfigProperty (optional)

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }