Package software.amazon.awscdk.services.comprehend

Interface CfnFlywheelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlywheelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-08-02T00:29:08.536Z")
@Stability(Stable)
public interface CfnFlywheelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFlywheel.

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.*;
 CfnFlywheelProps cfnFlywheelProps = CfnFlywheelProps.builder()
         .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:

• 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	CfnFlywheelProps.Builder	A builder for CfnFlywheelProps
static final class	CfnFlywheelProps.Jsii$Proxy	An implementation for CfnFlywheelProps

Method Summary

Modifier and Type	Method	Description
static CfnFlywheelProps.Builder	builder()
default String	getActiveModelArn()	The Amazon Resource Number (ARN) of the active model version.
String	getDataAccessRoleArn()	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
String	getDataLakeS3Uri()	Amazon S3 URI of the data lake location.
default Object	getDataSecurityConfig()	Data security configuration.
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

getDataAccessRoleArn

@Stability(Stable)
@NotNull
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)
@NotNull
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

getFlywheelName

@Stability(Stable)
@NotNull
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

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

getDataSecurityConfig

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

Data security configuration.

See Also:

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

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.

See Also:

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

builder

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

Returns:

a CfnFlywheelProps.Builder of CfnFlywheelProps