Package software.amazon.awscdk.services.translate

Class CfnTerminology

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.translate.CfnTerminology
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ITerminologyRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-10-08T17:00:05.667Z") @Stability(Stable) public class CfnTerminology extends CfnResource implements IInspectable, ITerminologyRef, ITaggableV2
A custom terminology resource for Amazon Translate that enables customized translations.

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.translate.*;
 CfnTerminology cfnTerminology = CfnTerminology.Builder.create(this, "MyCfnTerminology")
         .name("name")
         // the properties below are optional
         .description("description")
         .encryptionKey(EncryptionKeyProperty.builder()
                 .id("id")
                 .type("type")
                 .build())
         .mergeStrategy("mergeStrategy")
         .tags(List.of(TagsItemsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .terminologyData(TerminologyDataProperty.builder()
                 .file("file")
                 .format("format")
                 // the properties below are optional
                 .directionality("directionality")
                 .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

    • CfnTerminology

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

    • CfnTerminology

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

    • CfnTerminology

      @Stability(Stable) public CfnTerminology(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTerminologyProps props)
      Create a new AWS::Translate::Terminology.

      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

    • arnForTerminology

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

    • isCfnTerminology

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

      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.

    • getAttrArn

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

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The time the terminology was created.

    • getAttrDirectionality

      @Stability(Stable) @NotNull public String getAttrDirectionality()
      The directionality of the terminology.

    • getAttrFormat

      @Stability(Stable) @NotNull public String getAttrFormat()
      The format of the terminology data.

    • getAttrLastUpdatedAt

      @Stability(Stable) @NotNull public String getAttrLastUpdatedAt()
      The time the terminology was last updated.

    • getAttrSizeBytes

      @Stability(Stable) @NotNull public Number getAttrSizeBytes()
      The size of the terminology file in bytes.

    • getAttrSourceLanguageCode

      @Stability(Stable) @NotNull public String getAttrSourceLanguageCode()
      The source language code for the custom terminology.

    • getAttrTargetLanguageCodes

      @Stability(Stable) @NotNull public List<String> getAttrTargetLanguageCodes()
      The target language codes for the custom terminology.

    • getAttrTermCount

      @Stability(Stable) @NotNull public Number getAttrTermCount()
      The number of terms in the custom terminology.

    • 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

    • getTerminologyRef

      @Stability(Stable) @NotNull public TerminologyReference getTerminologyRef()
      A reference to a Terminology resource.
      Specified by:
      getTerminologyRef in interface ITerminologyRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the custom terminology.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the custom terminology.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the custom terminology.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the custom terminology.

    • getEncryptionKey

      @Stability(Stable) @Nullable public Object getEncryptionKey()
      The encryption key for the custom terminology.

      Returns union: either IResolvable or CfnTerminology.EncryptionKeyProperty

    • setEncryptionKey

      @Stability(Stable) public void setEncryptionKey(@Nullable IResolvable value)
      The encryption key for the custom terminology.

    • setEncryptionKey

      @Stability(Stable) public void setEncryptionKey(@Nullable CfnTerminology.EncryptionKeyProperty value)
      The encryption key for the custom terminology.

    • getMergeStrategy

      @Stability(Stable) @Nullable public String getMergeStrategy()
      The merge strategy for the custom terminology.

    • setMergeStrategy

      @Stability(Stable) public void setMergeStrategy(@Nullable String value)
      The merge strategy for the custom terminology.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTerminology.TagsItemsProperty> getTags()
      Tags associated with the terminology.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTerminology.TagsItemsProperty> value)
      Tags associated with the terminology.

    • getTerminologyData

      @Stability(Stable) @Nullable public Object getTerminologyData()
      The terminology data for the custom terminology being imported.

      Returns union: either IResolvable or CfnTerminology.TerminologyDataProperty

    • setTerminologyData

      @Stability(Stable) public void setTerminologyData(@Nullable IResolvable value)
      The terminology data for the custom terminology being imported.

    • setTerminologyData

      @Stability(Stable) public void setTerminologyData(@Nullable CfnTerminology.TerminologyDataProperty value)
      The terminology data for the custom terminology being imported.