Package software.amazon.awscdk.services.textract

Class CfnAdapter

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.textract.CfnAdapter
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IAdapterRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:20.603Z") @Stability(Stable) public class CfnAdapter extends CfnResource implements IInspectable, IAdapterRef, ITaggableV2
The AWS::Textract::Adapter resource creates an Amazon Textract adapter, which can be fine-tuned for enhanced performance on user-provided documents.

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.*;
 CfnAdapter cfnAdapter = CfnAdapter.Builder.create(this, "MyCfnAdapter")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAdapter

      protected CfnAdapter(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAdapter

      protected CfnAdapter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAdapter

      @Stability(Stable) public CfnAdapter(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAdapterProps props)
      Create a new AWS::Textract::Adapter.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForAdapter

      @Stability(Stable) @NotNull public static String arnForAdapter(@NotNull IAdapterRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnAdapter

      @Stability(Stable) @NotNull public static Boolean isCfnAdapter(@NotNull Object x)
      Checks whether the given object is a CfnAdapter.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAdapterRef

      @Stability(Stable) @NotNull public AdapterReference getAdapterRef()
      A reference to a Adapter resource.
      Specified by:
      getAdapterRef in interface IAdapterRef

    • getAttrAdapterId

      @Stability(Stable) @NotNull public String getAttrAdapterId()
      A unique identifier for the adapter resource.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the adapter.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The date and time that the adapter was created.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getAdapterName

      @Stability(Stable) @NotNull public String getAdapterName()
      The name to be assigned to the adapter being created.

    • setAdapterName

      @Stability(Stable) public void setAdapterName(@NotNull String value)
      The name to be assigned to the adapter being created.

    • getFeatureTypes

      @Stability(Stable) @NotNull public List<String> getFeatureTypes()
      The type of feature that the adapter is being trained on.

    • setFeatureTypes

      @Stability(Stable) public void setFeatureTypes(@NotNull List<String> value)
      The type of feature that the adapter is being trained on.

    • getAutoUpdate

      @Stability(Stable) @Nullable public String getAutoUpdate()
      Controls whether or not the adapter should automatically update.

    • setAutoUpdate

      @Stability(Stable) public void setAutoUpdate(@Nullable String value)
      Controls whether or not the adapter should automatically update.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description to be assigned to the adapter being created.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description to be assigned to the adapter being created.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of tags to be added to the adapter.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of tags to be added to the adapter.