View a markdown version of this page

AWS::Kendra::Thesaurus - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Kendra::Thesaurus

Note

Amazon Kendra is no longer open to new customers. For capabilities similar to Amazon Kendra, explore Amazon Bedrock Knowledge Bases. Learn more.

Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.

For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Kendra::Thesaurus",
  "Properties" : {
      "Description" : String,
      "IndexId" : String,
      "Name" : String,
      "RoleArn" : String,
      "SourceS3Path" : S3Path,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Kendra::Thesaurus
Properties:
  Description: String
  IndexId: String
  Name: String
  RoleArn: String
  SourceS3Path: 
    S3Path
  Tags: 
    - Tag

Properties

Description

Property description not available.

Required: No

Type: String

Pattern: ^\P{C}*$

Minimum: 0

Maximum: 1000

Update requires: No interruption

IndexId

Property description not available.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$

Minimum: 36

Maximum: 36

Update requires: Replacement

Name

The name of the thesaurus.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$

Minimum: 1

Maximum: 100

Update requires: No interruption

RoleArn

Property description not available.

Required: Yes

Type: String

Pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$

Minimum: 0

Maximum: 1284

Update requires: No interruption

SourceS3Path

Information required to find a specific file in an Amazon S3 bucket.

Required: Yes

Type: S3Path

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

Id

The identifier of the thesaurus.