AWS::Kendra::QuerySuggestionsBlockList

Kendra QuerySuggestionsBlockList

A block list used for query suggestions for an Amazon Kendra index. A block list contains words or phrases that should not appear as query suggestions.

Properties

6 configurable properties. 4 required. Click a row to see details.

Filter:
PropertyTypeFlags
IndexId
string
RequiredCreate-only
Name
string
Required
RoleArn
string
Required
SourceS3Path
S3Path
Required
Description
string
Tags
Array<Tag>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
ArnstringThe Amazon Resource Name (ARN) of the query suggestions block list.
IdstringThe identifier of the block list.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Kendra::QuerySuggestionsBlockList

Resources:
  MyResource:
    Type: AWS::Kendra::QuerySuggestionsBlockList
    Properties:
      IndexId: "my-indexid"
      Name: "my-name"
      SourceS3Path: "value"
      RoleArn: "arn:aws:service:region:account:resource"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

kendra:CreateQuerySuggestionsBlockListkendra:DescribeQuerySuggestionsBlockListkendra:TagResourceiam:PassRoles3:GetObject

read

kendra:DescribeQuerySuggestionsBlockListkendra:ListTagsForResource

update

kendra:UpdateQuerySuggestionsBlockListkendra:DescribeQuerySuggestionsBlockListkendra:TagResourcekendra:UntagResourcekendra:ListTagsForResourceiam:PassRoles3:GetObject

delete

kendra:DeleteQuerySuggestionsBlockListkendra:DescribeQuerySuggestionsBlockListkendra:ListTagsForResource

list

kendra:ListQuerySuggestionsBlockLists

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceKendra
Properties8
Required4
TaggingSupported
Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

IndexId

External Links