Package software.amazon.awscdk.services.comprehend

Interface CfnDocumentClassifierProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDocumentClassifierProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:55:55.511Z")
@Stability(Stable)
public interface CfnDocumentClassifierProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDocumentClassifier.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.comprehend.*;
 CfnDocumentClassifierProps cfnDocumentClassifierProps = CfnDocumentClassifierProps.builder()
         .dataAccessRoleArn("dataAccessRoleArn")
         .documentClassifierName("documentClassifierName")
         .inputDataConfig(DocumentClassifierInputDataConfigProperty.builder()
                 .augmentedManifests(List.of(AugmentedManifestsListItemProperty.builder()
                         .attributeNames(List.of("attributeNames"))
                         .s3Uri("s3Uri")
                         // the properties below are optional
                         .split("split")
                         .build()))
                 .dataFormat("dataFormat")
                 .documentReaderConfig(DocumentReaderConfigProperty.builder()
                         .documentReadAction("documentReadAction")
                         // the properties below are optional
                         .documentReadMode("documentReadMode")
                         .featureTypes(List.of("featureTypes"))
                         .build())
                 .documents(DocumentClassifierDocumentsProperty.builder()
                         .s3Uri("s3Uri")
                         // the properties below are optional
                         .testS3Uri("testS3Uri")
                         .build())
                 .documentType("documentType")
                 .labelDelimiter("labelDelimiter")
                 .s3Uri("s3Uri")
                 .testS3Uri("testS3Uri")
                 .build())
         .languageCode("languageCode")
         // the properties below are optional
         .mode("mode")
         .modelKmsKeyId("modelKmsKeyId")
         .modelPolicy("modelPolicy")
         .outputDataConfig(DocumentClassifierOutputDataConfigProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .s3Uri("s3Uri")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .versionName("versionName")
         .volumeKmsKeyId("volumeKmsKeyId")
         .vpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnets(List.of("subnets"))
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDocumentClassifierProps.Builder	A builder for CfnDocumentClassifierProps
static final class	CfnDocumentClassifierProps.Jsii$Proxy	An implementation for CfnDocumentClassifierProps

Method Summary

Modifier and Type	Method	Description
static CfnDocumentClassifierProps.Builder	builder()
String	getDataAccessRoleArn()	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
String	getDocumentClassifierName()	The name of the document classifier.
Object	getInputDataConfig()	Specifies the format and location of the input data for the job.
String	getLanguageCode()	The language of the input documents.
default String	getMode()	Indicates the mode in which the classifier will be trained.
default String	getModelKmsKeyId()	ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
default String	getModelPolicy()	The resource-based policy to attach to your custom document classifier model.
default Object	getOutputDataConfig()	Provides output results configuration parameters for custom classifier jobs.
default List<CfnTag>	getTags()	Tags to associate with the document classifier.
default String	getVersionName()	The version name given to the newly created classifier.
default String	getVolumeKmsKeyId()	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.
default Object	getVpcConfig()	Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataAccessRoleArn

@Stability(Stable)
@NotNull
String getDataAccessRoleArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-dataaccessrolearn

getDocumentClassifierName

@Stability(Stable)
@NotNull
String getDocumentClassifierName()

The name of the document classifier.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-documentclassifiername

getInputDataConfig

@Stability(Stable)
@NotNull
Object getInputDataConfig()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-inputdataconfig

getLanguageCode

@Stability(Stable)
@NotNull
String getLanguageCode()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-languagecode

getMode

@Stability(Stable)
@Nullable
default String getMode()

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 (|).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-mode

getModelKmsKeyId

@Stability(Stable)
@Nullable
default String getModelKmsKeyId()

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"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-modelkmskeyid

getModelPolicy

@Stability(Stable)
@Nullable
default String getModelPolicy()

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"]}'

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-modelpolicy

getOutputDataConfig

@Stability(Stable)
@Nullable
default Object getOutputDataConfig()

Provides output results configuration parameters for custom classifier jobs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-outputdataconfig

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-tags

getVersionName

@Stability(Stable)
@Nullable
default String getVersionName()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-versionname

getVolumeKmsKeyId

@Stability(Stable)
@Nullable
default String getVolumeKmsKeyId()

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"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-volumekmskeyid

getVpcConfig

@Stability(Stable)
@Nullable
default Object getVpcConfig()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-documentclassifier.html#cfn-comprehend-documentclassifier-vpcconfig

builder

@Stability(Stable)
static CfnDocumentClassifierProps.Builder builder()

Returns:

a CfnDocumentClassifierProps.Builder of CfnDocumentClassifierProps