Thesaurus

class Thesaurus : KotlinCustomResource

Resource for managing an AWS Kendra Thesaurus.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kendra.Thesaurus("example", {
indexId: exampleAwsKendraIndex.id,
name: "Example",
roleArn: exampleAwsIamRole.arn,
sourceS3Path: {
bucket: exampleAwsS3Bucket.id,
key: exampleAwsS3Object.key,
},
tags: {
Name: "Example Kendra Thesaurus",
},
});
import pulumi
import pulumi_aws as aws
example = aws.kendra.Thesaurus("example",
index_id=example_aws_kendra_index["id"],
name="Example",
role_arn=example_aws_iam_role["arn"],
source_s3_path={
"bucket": example_aws_s3_bucket["id"],
"key": example_aws_s3_object["key"],
},
tags={
"Name": "Example Kendra Thesaurus",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kendra.Thesaurus("example", new()
{
IndexId = exampleAwsKendraIndex.Id,
Name = "Example",
RoleArn = exampleAwsIamRole.Arn,
SourceS3Path = new Aws.Kendra.Inputs.ThesaurusSourceS3PathArgs
{
Bucket = exampleAwsS3Bucket.Id,
Key = exampleAwsS3Object.Key,
},
Tags =
{
{ "Name", "Example Kendra Thesaurus" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kendra"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := kendra.NewThesaurus(ctx, "example", &kendra.ThesaurusArgs{
IndexId: pulumi.Any(exampleAwsKendraIndex.Id),
Name: pulumi.String("Example"),
RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
SourceS3Path: &kendra.ThesaurusSourceS3PathArgs{
Bucket: pulumi.Any(exampleAwsS3Bucket.Id),
Key: pulumi.Any(exampleAwsS3Object.Key),
},
Tags: pulumi.StringMap{
"Name": pulumi.String("Example Kendra Thesaurus"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kendra.Thesaurus;
import com.pulumi.aws.kendra.ThesaurusArgs;
import com.pulumi.aws.kendra.inputs.ThesaurusSourceS3PathArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Thesaurus("example", ThesaurusArgs.builder()
.indexId(exampleAwsKendraIndex.id())
.name("Example")
.roleArn(exampleAwsIamRole.arn())
.sourceS3Path(ThesaurusSourceS3PathArgs.builder()
.bucket(exampleAwsS3Bucket.id())
.key(exampleAwsS3Object.key())
.build())
.tags(Map.of("Name", "Example Kendra Thesaurus"))
.build());
}
}
resources:
example:
type: aws:kendra:Thesaurus
properties:
indexId: ${exampleAwsKendraIndex.id}
name: Example
roleArn: ${exampleAwsIamRole.arn}
sourceS3Path:
bucket: ${exampleAwsS3Bucket.id}
key: ${exampleAwsS3Object.key}
tags:
Name: Example Kendra Thesaurus

Import

Using pulumi import, import aws_kendra_thesaurus using the unique identifiers of the thesaurus and index separated by a slash (/). For example:

$ pulumi import aws:kendra/thesaurus:Thesaurus example thesaurus-123456780/idx-8012925589

Properties

Link copied to clipboard
val arn: Output<String>

ARN of the thesaurus.

Link copied to clipboard
val description: Output<String>?
Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val indexId: Output<String>

The identifier of the index for a thesaurus.

Link copied to clipboard
val name: Output<String>

The name for the thesaurus.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val roleArn: Output<String>

The IAM (Identity and Access Management) role used to access the thesaurus file in S3.

Link copied to clipboard

The S3 path where your thesaurus file sits in S3. Detailed below.

Link copied to clipboard
val status: Output<String>

The current status of the thesaurus.

Link copied to clipboard
val tags: Output<Map<String, String>>?
Link copied to clipboard
val tagsAll: Output<Map<String, String>>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val thesaurusId: Output<String>
Link copied to clipboard
val urn: Output<String>