Class CfnFlywheel
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.comprehend.CfnFlywheel
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:40.913Z")
@Stability(Stable)
public class CfnFlywheel
extends CfnResource
implements IInspectable, ITaggable
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.services.comprehend.*; CfnFlywheel cfnFlywheel = CfnFlywheel.Builder.create(this, "MyCfnFlywheel") .dataAccessRoleArn("dataAccessRoleArn") .dataLakeS3Uri("dataLakeS3Uri") .flywheelName("flywheelName") // the properties below are optional .activeModelArn("activeModelArn") .dataSecurityConfig(DataSecurityConfigProperty.builder() .dataLakeKmsKeyId("dataLakeKmsKeyId") .modelKmsKeyId("modelKmsKeyId") .volumeKmsKeyId("volumeKmsKeyId") .vpcConfig(VpcConfigProperty.builder() .securityGroupIds(List.of("securityGroupIds")) .subnets(List.of("subnets")) .build()) .build()) .modelType("modelType") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .taskConfig(TaskConfigProperty.builder() .languageCode("languageCode") // the properties below are optional .documentClassificationConfig(DocumentClassificationConfigProperty.builder() .mode("mode") // the properties below are optional .labels(List.of("labels")) .build()) .entityRecognitionConfig(EntityRecognitionConfigProperty.builder() .entityTypes(List.of(EntityTypesListItemProperty.builder() .type("type") .build())) .build()) .build()) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnFlywheel
.static interface
Data security configuration.static interface
Configuration required for a document classification model.static interface
Configuration required for an entity recognition model.static interface
An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.static interface
Configuration about the model associated with a flywheel.static interface
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnFlywheel
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnFlywheel
(software.amazon.jsii.JsiiObjectRef objRef) CfnFlywheel
(software.constructs.Construct scope, String id, CfnFlywheelProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Number (ARN) of the active model version.The Amazon Resource Name (ARN) of the flywheel.The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.Amazon S3 URI of the data lake location.Data security configuration.Name for the flywheel.Model type of the flywheel's model.getTags()
Tag Manager which manages the tags for this resource.Tags associated with the endpoint being created.Configuration about the model associated with a flywheel.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setActiveModelArn
(String value) The Amazon Resource Number (ARN) of the active model version.void
setDataAccessRoleArn
(String value) The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.void
setDataLakeS3Uri
(String value) Amazon S3 URI of the data lake location.void
setDataSecurityConfig
(IResolvable value) Data security configuration.void
Data security configuration.void
setFlywheelName
(String value) Name for the flywheel.void
setModelType
(String value) Model type of the flywheel's model.void
setTagsRaw
(List<CfnTag> value) Tags associated with the endpoint being created.void
setTaskConfig
(IResolvable value) Configuration about the model associated with a flywheel.void
Configuration about the model associated with a flywheel.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnFlywheel
protected CfnFlywheel(software.amazon.jsii.JsiiObjectRef objRef) -
CfnFlywheel
protected CfnFlywheel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnFlywheel
@Stability(Stable) public CfnFlywheel(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnFlywheelProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the flywheel. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getDataAccessRoleArn
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data. -
setDataAccessRoleArn
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data. -
getDataLakeS3Uri
Amazon S3 URI of the data lake location. -
setDataLakeS3Uri
Amazon S3 URI of the data lake location. -
getFlywheelName
Name for the flywheel. -
setFlywheelName
Name for the flywheel. -
getActiveModelArn
The Amazon Resource Number (ARN) of the active model version. -
setActiveModelArn
The Amazon Resource Number (ARN) of the active model version. -
getDataSecurityConfig
Data security configuration. -
setDataSecurityConfig
Data security configuration. -
setDataSecurityConfig
@Stability(Stable) public void setDataSecurityConfig(@Nullable CfnFlywheel.DataSecurityConfigProperty value) Data security configuration. -
getModelType
Model type of the flywheel's model. -
setModelType
Model type of the flywheel's model. -
getTagsRaw
Tags associated with the endpoint being created. -
setTagsRaw
Tags associated with the endpoint being created. -
getTaskConfig
Configuration about the model associated with a flywheel. -
setTaskConfig
Configuration about the model associated with a flywheel. -
setTaskConfig
Configuration about the model associated with a flywheel.
-