Resource: awsKendraQuerySuggestionsBlockList
Terraform resource for managing an AWS Kendra block list used for query suggestions for an index.
Example Usage
Basic Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.kendraQuerySuggestionsBlockList.KendraQuerySuggestionsBlockList(
this,
"example",
{
indexId: "${aws_kendra_index.example.id}",
name: "Example",
roleArn: "${aws_iam_role.example.arn}",
sourceS3Path: {
bucket: "${aws_s3_bucket.example.id}",
key: "example/suggestions.txt",
},
tags: {
Name: "Example Kendra Index",
},
}
);
Argument Reference
The following arguments are required:
indexId
- (Required, Forces new resource) The identifier of the index for a block list.name
- (Required) The name for the block list.roleArn
- (Required) The IAM (Identity and Access Management) role used to access the block list text file in S3.sourceS3Path
- (Required) The S3 path where your block list text file sits in S3. Detailed below.
The sourceS3Path
configuration block supports the following arguments:
bucket
- (Required) The name of the S3 bucket that contains the file.key
- (Required) The name of the file.
The following arguments are optional:
description
- (Optional) The description for a block list.tags
- (Optional) Key-value map of resource tags. If configured with a providerdefaultTags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
arn
- ARN of the block list.querySuggestionsBlockListId
- The unique indentifier of the block list.tagsAll
- A map of tags assigned to the resource, including those inherited from the providerdefaultTags
configuration block.
Timeouts
create
- (Default30M
)update
- (Default30M
)delete
- (Default30M
)
Import
awsKendraQuerySuggestionsBlockList
can be imported using the unique identifiers of the block list and index separated by a slash (/
), e.g.,