Package software.amazon.awscdk.cfnpropertymixins.services.comprehend

Class CfnDocumentClassifierPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.comprehend.CfnDocumentClassifierPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:57.461Z") @Stability(Stable) public class CfnDocumentClassifierPropsMixin extends Mixin implements software.constructs.IMixin
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 software.amazon.awscdk.cfnpropertymixins.services.comprehend.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnDocumentClassifierPropsMixin cfnDocumentClassifierPropsMixin = CfnDocumentClassifierPropsMixin.Builder.create(CfnDocumentClassifierMixinProps.builder()
         .dataAccessRoleArn("dataAccessRoleArn")
         .documentClassifierName("documentClassifierName")
         .inputDataConfig(DocumentClassifierInputDataConfigProperty.builder()
                 .augmentedManifests(List.of(AugmentedManifestsListItemProperty.builder()
                         .attributeNames(List.of("attributeNames"))
                         .s3Uri("s3Uri")
                         .split("split")
                         .build()))
                 .dataFormat("dataFormat")
                 .documentReaderConfig(DocumentReaderConfigProperty.builder()
                         .documentReadAction("documentReadAction")
                         .documentReadMode("documentReadMode")
                         .featureTypes(List.of("featureTypes"))
                         .build())
                 .documents(DocumentClassifierDocumentsProperty.builder()
                         .s3Uri("s3Uri")
                         .testS3Uri("testS3Uri")
                         .build())
                 .documentType("documentType")
                 .labelDelimiter("labelDelimiter")
                 .s3Uri("s3Uri")
                 .testS3Uri("testS3Uri")
                 .build())
         .languageCode("languageCode")
         .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())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnDocumentClassifierPropsMixin

      protected CfnDocumentClassifierPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDocumentClassifierPropsMixin

      protected CfnDocumentClassifierPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDocumentClassifierPropsMixin

      @Stability(Stable) public CfnDocumentClassifierPropsMixin(@NotNull CfnDocumentClassifierMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::Comprehend::DocumentClassifier.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnDocumentClassifierPropsMixin

      @Stability(Stable) public CfnDocumentClassifierPropsMixin(@NotNull CfnDocumentClassifierMixinProps props)
      Create a mixin to apply properties to AWS::Comprehend::DocumentClassifier.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnDocumentClassifierMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()