Skip to content
v2.274.0

CfnAdapterProps Struct ​

Properties for defining a CfnAdapter.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_textract as textract } from 'aws-cdk-lib';
const cfnAdapterProps: textract.CfnAdapterProps = {
  adapterName: 'adapterName',
  featureTypes: ['featureTypes'],

  // the properties below are optional
  autoUpdate: 'autoUpdate',
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

adapterNamestringadapter_namestradapterNameStringAdapterNamestringAdapterName*stringrequired#
The name to be assigned to the adapter being created.
autoUpdateoptionalstringauto_updateoptionalstrautoUpdateoptionalStringAutoUpdateoptionalstringAutoUpdateoptional*string#
Controls whether or not the adapter should automatically update.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description to be assigned to the adapter being created.
featureTypesstring[]feature_typestyping.List[str]featureTypesList<String>FeatureTypesstring[]FeatureTypes*[]*stringrequired#
The type of feature that the adapter is being trained on.

Currently, supported feature types are: QUERIES

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
A list of tags to be added to the adapter.