Package software.amazon.awscdk.services.textract

Interface CfnAdapterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAdapterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:20.604Z")
@Stability(Stable)
public interface CfnAdapterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAdapter.

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.textract.*;
 CfnAdapterProps cfnAdapterProps = CfnAdapterProps.builder()
         .adapterName("adapterName")
         .featureTypes(List.of("featureTypes"))
         // the properties below are optional
         .autoUpdate("autoUpdate")
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAdapterProps.Builder	A builder for CfnAdapterProps
static final class	CfnAdapterProps.Jsii$Proxy	An implementation for CfnAdapterProps

Method Summary

Modifier and Type	Method	Description
static CfnAdapterProps.Builder	builder()
String	getAdapterName()	The name to be assigned to the adapter being created.
default String	getAutoUpdate()	Controls whether or not the adapter should automatically update.
default String	getDescription()	The description to be assigned to the adapter being created.
List<String>	getFeatureTypes()	The type of feature that the adapter is being trained on.
default List<CfnTag>	getTags()	A list of tags to be added to the adapter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdapterName

@Stability(Stable)
@NotNull
String getAdapterName()

The name to be assigned to the adapter being created.

See Also:

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

getFeatureTypes

@Stability(Stable)
@NotNull
List<String> getFeatureTypes()

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

Currently, supported feature types are: QUERIES

See Also:

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

getAutoUpdate

@Stability(Stable)
@Nullable
default String getAutoUpdate()

Controls whether or not the adapter should automatically update.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description to be assigned to the adapter being created.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of tags to be added to the adapter.

See Also:

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

builder

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

Returns:

a CfnAdapterProps.Builder of CfnAdapterProps