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

Interface CfnFlywheelMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlywheelMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.466Z")
@Stability(Stable)
public interface CfnFlywheelMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnFlywheelPropsMixin.

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.*;
 CfnFlywheelMixinProps cfnFlywheelMixinProps = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFlywheelMixinProps.Builder	builder()
default String	getActiveModelArn()	The Amazon Resource Number (ARN) of the active model version.
default String	getDataAccessRoleArn()	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
default String	getDataLakeS3Uri()	Amazon S3 URI of the data lake location.
default Object	getDataSecurityConfig()	Data security configuration.
default String	getFlywheelName()	Name for the flywheel.
default String	getModelType()	Model type of the flywheel's model.
default List<CfnTag>	getTags()	Tags associated with the endpoint being created.
default Object	getTaskConfig()	Configuration about the model associated with a flywheel.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActiveModelArn

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

The Amazon Resource Number (ARN) of the active model version.

See Also:

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

getDataAccessRoleArn

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

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.

See Also:

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

getDataLakeS3Uri

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

Amazon S3 URI of the data lake location.

See Also:

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

getDataSecurityConfig

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

Data security configuration.

Returns union: either IResolvable or CfnFlywheelPropsMixin.DataSecurityConfigProperty

See Also:

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

getFlywheelName

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

Name for the flywheel.

See Also:

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

getModelType

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

Model type of the flywheel's model.

See Also:

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

getTags

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

Tags associated with the endpoint being created.

A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.

See Also:

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

getTaskConfig

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

Configuration about the model associated with a flywheel.

Returns union: either IResolvable or CfnFlywheelPropsMixin.TaskConfigProperty

See Also:

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

builder

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

Returns:

a CfnFlywheelMixinProps.Builder of CfnFlywheelMixinProps