pulumi-aws-kotlin/com.pulumi.aws.kendra.kotlin/QuerySuggestionsBlockList

QuerySuggestionsBlockList

class QuerySuggestionsBlockList : KotlinCustomResource

Resource for managing an AWS Kendra block list used for query suggestions for an index.

Example Usage

Basic Usage

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(aws_kendra_index.example().id())
            .roleArn(aws_iam_role.example().arn())
            .sourceS3Path(QuerySuggestionsBlockListSourceS3PathArgs.builder()
                .bucket(aws_s3_bucket.example().id())
                .key("example/suggestions.txt")
                .build())
            .tags(Map.of("Name", "Example Kendra Index"))
            .build());
    }
}

Import

aws_kendra_query_suggestions_block_list can be imported using the unique identifiers of the block list and index separated by a slash (/), e.g.,

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

Properties

arn

val arn: Output<String>

ARN of the block list.

description

val description: Output<String>?

The description for a block list.

val id: Output<String>

indexId

val indexId: Output<String>

The identifier of the index for a block list.

name

val name: Output<String>

The name for the block list.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

querySuggestionsBlockListId

val querySuggestionsBlockListId: Output<String>

The unique indentifier of the block list.

roleArn

val roleArn: Output<String>

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

sourceS3Path

val sourceS3Path: Output<QuerySuggestionsBlockListSourceS3Path>

The S3 path where your block list text file sits in S3. Detailed below. The source_s3_path configuration block supports the following arguments:

status

val status: Output<String>