CfnAdapterProps

class aws_cdk.aws_textract.CfnAdapterProps(*, adapter_name, feature_types, auto_update=None, description=None, tags=None)

Bases: object

Properties for defining a CfnAdapter.

Parameters:
  • adapter_name (str) – The name to be assigned to the adapter being created.

  • feature_types (Sequence[str]) – The type of feature that the adapter is being trained on. Currently, supported feature types are: QUERIES

  • auto_update (Optional[str]) – Controls whether or not the adapter should automatically update.

  • description (Optional[str]) – The description to be assigned to the adapter being created.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tags to be added to the adapter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-textract-adapter.html

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_textract as textract

cfn_adapter_props = textract.CfnAdapterProps(
    adapter_name="adapterName",
    feature_types=["featureTypes"],

    # the properties below are optional
    auto_update="autoUpdate",
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

adapter_name

The name to be assigned to the adapter being created.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-textract-adapter.html#cfn-textract-adapter-adaptername

auto_update

Controls whether or not the adapter should automatically update.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-textract-adapter.html#cfn-textract-adapter-autoupdate

description

The description to be assigned to the adapter being created.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-textract-adapter.html#cfn-textract-adapter-description

feature_types

The type of feature that the adapter is being trained on.

Currently, supported feature types are: QUERIES

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-textract-adapter.html#cfn-textract-adapter-featuretypes

tags

A list of tags to be added to the adapter.

See:

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