QuerySuggestionsBlockList

class QuerySuggestionsBlockList : KotlinCustomResource

Use the aws_kendra_index_block_list resource to manage an AWS Kendra block list used for query suggestions for an index.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kendra.QuerySuggestionsBlockList("example", {
indexId: exampleAwsKendraIndex.id,
name: "Example",
roleArn: exampleAwsIamRole.arn,
sourceS3Path: {
bucket: exampleAwsS3Bucket.id,
key: "example/suggestions.txt",
},
tags: {
Name: "Example Kendra Index",
},
});
import pulumi
import pulumi_aws as aws
example = aws.kendra.QuerySuggestionsBlockList("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/suggestions.txt",
},
tags={
"Name": "Example Kendra Index",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kendra.QuerySuggestionsBlockList("example", new()
{
IndexId = exampleAwsKendraIndex.Id,
Name = "Example",
RoleArn = exampleAwsIamRole.Arn,
SourceS3Path = new Aws.Kendra.Inputs.QuerySuggestionsBlockListSourceS3PathArgs
{
Bucket = exampleAwsS3Bucket.Id,
Key = "example/suggestions.txt",
},
Tags =
{
{ "Name", "Example Kendra Index" },
},
});
});
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.NewQuerySuggestionsBlockList(ctx, "example", &kendra.QuerySuggestionsBlockListArgs{
IndexId: pulumi.Any(exampleAwsKendraIndex.Id),
Name: pulumi.String("Example"),
RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
SourceS3Path: &kendra.QuerySuggestionsBlockListSourceS3PathArgs{
Bucket: pulumi.Any(exampleAwsS3Bucket.Id),
Key: pulumi.String("example/suggestions.txt"),
},
Tags: pulumi.StringMap{
"Name": pulumi.String("Example Kendra Index"),
},
})
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.QuerySuggestionsBlockList;
import com.pulumi.aws.kendra.QuerySuggestionsBlockListArgs;
import com.pulumi.aws.kendra.inputs.QuerySuggestionsBlockListSourceS3PathArgs;
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 QuerySuggestionsBlockList("example", QuerySuggestionsBlockListArgs.builder()
.indexId(exampleAwsKendraIndex.id())
.name("Example")
.roleArn(exampleAwsIamRole.arn())
.sourceS3Path(QuerySuggestionsBlockListSourceS3PathArgs.builder()
.bucket(exampleAwsS3Bucket.id())
.key("example/suggestions.txt")
.build())
.tags(Map.of("Name", "Example Kendra Index"))
.build());
}
}
resources:
example:
type: aws:kendra:QuerySuggestionsBlockList
properties:
indexId: ${exampleAwsKendraIndex.id}
name: Example
roleArn: ${exampleAwsIamRole.arn}
sourceS3Path:
bucket: ${exampleAwsS3Bucket.id}
key: example/suggestions.txt
tags:
Name: Example Kendra Index

Import

Using pulumi import, import the aws_kendra_query_suggestions_block_list resource using the unique identifiers of the block list and index separated by a slash (/). For example:

$ pulumi import aws:kendra/querySuggestionsBlockList:QuerySuggestionsBlockList example blocklist-123456780/idx-8012925589

Properties

Link copied to clipboard
val arn: Output<String>

ARN of the block list.

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

Identifier of the index for a block list.

Link copied to clipboard
val name: Output<String>

Name for the block list.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Unique identifier of the block list.

Link copied to clipboard
val roleArn: Output<String>

IAM (Identity and Access Management) role used to access the block list text file in S3.

Link copied to clipboard

S3 path where your block list text file is located. See details below.

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

Map of tags assigned to the resource, including those inherited from the provider's default_tags configuration block.

Link copied to clipboard
val urn: Output<String>