Class CfnFlywheel
A flywheel is an AWS resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition.
Inherited Members
Namespace: Amazon.CDK.AWS.Comprehend
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFlywheel : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnFlywheel
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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 .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-flywheel.html
CloudformationResource: AWS::Comprehend::Flywheel
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Comprehend;
var cfnFlywheel = new CfnFlywheel(this, "MyCfnFlywheel", new CfnFlywheelProps {
DataAccessRoleArn = "dataAccessRoleArn",
DataLakeS3Uri = "dataLakeS3Uri",
FlywheelName = "flywheelName",
// the properties below are optional
ActiveModelArn = "activeModelArn",
DataSecurityConfig = new DataSecurityConfigProperty {
DataLakeKmsKeyId = "dataLakeKmsKeyId",
ModelKmsKeyId = "modelKmsKeyId",
VolumeKmsKeyId = "volumeKmsKeyId",
VpcConfig = new VpcConfigProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
Subnets = new [] { "subnets" }
}
},
ModelType = "modelType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TaskConfig = new TaskConfigProperty {
LanguageCode = "languageCode",
// the properties below are optional
DocumentClassificationConfig = new DocumentClassificationConfigProperty {
Mode = "mode",
// the properties below are optional
Labels = new [] { "labels" }
},
EntityRecognitionConfig = new EntityRecognitionConfigProperty {
EntityTypes = new [] { new EntityTypesListItemProperty {
Type = "type"
} }
}
}
});
Synopsis
Constructors
CfnFlywheel(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnFlywheel(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnFlywheel(Construct, String, ICfnFlywheelProps) |
Properties
ActiveModelArn | The Amazon Resource Number (ARN) of the active model version. |
AttrArn | The Amazon Resource Name (ARN) of the flywheel. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DataAccessRoleArn | The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data. |
DataLakeS3Uri | Amazon S3 URI of the data lake location. |
DataSecurityConfig | Data security configuration. |
FlywheelName | Name for the flywheel. |
ModelType | Model type of the flywheel's model. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Tags associated with the endpoint being created. |
TaskConfig | Configuration about the model associated with a flywheel. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFlywheel(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnFlywheel(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnFlywheel(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnFlywheel(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnFlywheel(Construct, String, ICfnFlywheelProps)
public CfnFlywheel(Construct scope, string id, ICfnFlywheelProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnFlywheelProps
Resource properties.
Properties
ActiveModelArn
The Amazon Resource Number (ARN) of the active model version.
public virtual string ActiveModelArn { get; set; }
Property Value
System.String
AttrArn
The Amazon Resource Name (ARN) of the flywheel.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DataAccessRoleArn
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
public virtual string DataAccessRoleArn { get; set; }
Property Value
System.String
DataLakeS3Uri
Amazon S3 URI of the data lake location.
public virtual string DataLakeS3Uri { get; set; }
Property Value
System.String
DataSecurityConfig
Data security configuration.
public virtual object DataSecurityConfig { get; set; }
Property Value
System.Object
FlywheelName
Name for the flywheel.
public virtual string FlywheelName { get; set; }
Property Value
System.String
ModelType
Model type of the flywheel's model.
public virtual string ModelType { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Tags associated with the endpoint being created.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
TaskConfig
Configuration about the model associated with a flywheel.
public virtual object TaskConfig { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>