CfnFlywheelProps

class aws_cdk.aws_comprehend.CfnFlywheelProps(*, data_access_role_arn, data_lake_s3_uri, flywheel_name, active_model_arn=None, data_security_config=None, model_type=None, tags=None, task_config=None)

Bases: object

Properties for defining a CfnFlywheel.

Parameters:

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

• data_lake_s3_uri (str) – Amazon S3 URI of the data lake location.

• flywheel_name (str) – Name for the flywheel.

• active_model_arn (Optional[str]) – The Amazon Resource Number (ARN) of the active model version.

• data_security_config (Union[DataSecurityConfigProperty, Dict[str, Any], IResolvable, None]) – Data security configuration.

• model_type (Optional[str]) – Model type of the flywheel’s model.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

• task_config (Union[IResolvable, TaskConfigProperty, Dict[str, Any], None]) – Configuration about the model associated with a flywheel.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_comprehend as comprehend

cfn_flywheel_props = comprehend.CfnFlywheelProps(
    data_access_role_arn="dataAccessRoleArn",
    data_lake_s3_uri="dataLakeS3Uri",
    flywheel_name="flywheelName",

    # the properties below are optional
    active_model_arn="activeModelArn",
    data_security_config=comprehend.CfnFlywheel.DataSecurityConfigProperty(
        data_lake_kms_key_id="dataLakeKmsKeyId",
        model_kms_key_id="modelKmsKeyId",
        volume_kms_key_id="volumeKmsKeyId",
        vpc_config=comprehend.CfnFlywheel.VpcConfigProperty(
            security_group_ids=["securityGroupIds"],
            subnets=["subnets"]
        )
    ),
    model_type="modelType",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    task_config=comprehend.CfnFlywheel.TaskConfigProperty(
        language_code="languageCode",

        # the properties below are optional
        document_classification_config=comprehend.CfnFlywheel.DocumentClassificationConfigProperty(
            mode="mode",

            # the properties below are optional
            labels=["labels"]
        ),
        entity_recognition_config=comprehend.CfnFlywheel.EntityRecognitionConfigProperty(
            entity_types=[comprehend.CfnFlywheel.EntityTypesListItemProperty(
                type="type"
            )]
        )
    )
)

Attributes

active_model_arn

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

Link:

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

data_access_role_arn

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

Link:

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

data_lake_s3_uri

Amazon S3 URI of the data lake location.

Link:

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

data_security_config

Data security configuration.

Link:

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

flywheel_name

Name for the flywheel.

Link:

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

model_type

Model type of the flywheel’s model.

Link:

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

tags

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.

Link:

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

task_config

Configuration about the model associated with a flywheel.

Link:

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