Package software.amazon.awscdk.services.kendra

Interface CfnThesaurusProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnThesaurusProps.Jsii$Proxy

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

Properties for defining a CfnThesaurus.

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.kendra.*;
 CfnThesaurusProps cfnThesaurusProps = CfnThesaurusProps.builder()
         .indexId("indexId")
         .name("name")
         .roleArn("roleArn")
         .sourceS3Path(S3PathProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .build())
         // the properties below are optional
         .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-kendra-thesaurus.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnThesaurusProps.Builder	builder()
default String	getDescription()	A description for the thesaurus.
String	getIndexId()	The identifier of the index for the thesaurus.
String	getName()	A name for the thesaurus.
String	getRoleArn()	An IAM role that gives Amazon Kendra permissions to access the thesaurus file specified in SourceS3Path.
Object	getSourceS3Path()	Information required to find a specific file in an Amazon S3 bucket.
default List<CfnTag>	getTags()	A list of key-value pairs that identify or categorize the thesaurus.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIndexId

@Stability(Stable)
@NotNull
String getIndexId()

The identifier of the index for the thesaurus.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-thesaurus.html#cfn-kendra-thesaurus-indexid

getName

@Stability(Stable)
@NotNull
String getName()

A name for the thesaurus.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-thesaurus.html#cfn-kendra-thesaurus-name

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

An IAM role that gives Amazon Kendra permissions to access the thesaurus file specified in SourceS3Path.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-thesaurus.html#cfn-kendra-thesaurus-rolearn

getSourceS3Path

@Stability(Stable)
@NotNull
Object getSourceS3Path()

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

Returns union: either IResolvable or CfnThesaurus.S3PathProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-thesaurus.html#cfn-kendra-thesaurus-sources3path

getDescription

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

A description for the thesaurus.

See Also:

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

getTags

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

A list of key-value pairs that identify or categorize the thesaurus.

See Also:

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

builder

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

Returns:

a CfnThesaurusProps.Builder of CfnThesaurusProps