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

Class CfnFlywheelPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.comprehend.CfnFlywheelPropsMixin
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.467Z") @Stability(Stable) public class CfnFlywheelPropsMixin extends Mixin implements software.constructs.IMixin
A flywheel is an AWS resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition.

You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.

When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.

To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake.

To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.

For more information about flywheels, see Flywheel overview in the Amazon 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;
 CfnFlywheelPropsMixin cfnFlywheelPropsMixin = CfnFlywheelPropsMixin.Builder.create(CfnFlywheelMixinProps.builder()
         .activeModelArn("activeModelArn")
         .dataAccessRoleArn("dataAccessRoleArn")
         .dataLakeS3Uri("dataLakeS3Uri")
         .dataSecurityConfig(DataSecurityConfigProperty.builder()
                 .dataLakeKmsKeyId("dataLakeKmsKeyId")
                 .modelKmsKeyId("modelKmsKeyId")
                 .volumeKmsKeyId("volumeKmsKeyId")
                 .vpcConfig(VpcConfigProperty.builder()
                         .securityGroupIds(List.of("securityGroupIds"))
                         .subnets(List.of("subnets"))
                         .build())
                 .build())
         .flywheelName("flywheelName")
         .modelType("modelType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .taskConfig(TaskConfigProperty.builder()
                 .documentClassificationConfig(DocumentClassificationConfigProperty.builder()
                         .labels(List.of("labels"))
                         .mode("mode")
                         .build())
                 .entityRecognitionConfig(EntityRecognitionConfigProperty.builder()
                         .entityTypes(List.of(EntityTypesListItemProperty.builder()
                                 .type("type")
                                 .build()))
                         .build())
                 .languageCode("languageCode")
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

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

  • Constructor Details

    • CfnFlywheelPropsMixin

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

    • CfnFlywheelPropsMixin

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

    • CfnFlywheelPropsMixin

      @Stability(Stable) public CfnFlywheelPropsMixin(@NotNull CfnFlywheelMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::Comprehend::Flywheel.

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

    • CfnFlywheelPropsMixin

      @Stability(Stable) public CfnFlywheelPropsMixin(@NotNull CfnFlywheelMixinProps props)
      Create a mixin to apply properties to AWS::Comprehend::Flywheel.

      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 CfnFlywheelMixinProps getProps()

    • getStrategy

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