interface CfnQuerySuggestionsBlockListProps

Language	Type name
.NET	`Amazon.CDK.AWS.Kendra.CfnQuerySuggestionsBlockListProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnQuerySuggestionsBlockListProps`
Java	`software.amazon.awscdk.services.kendra.CfnQuerySuggestionsBlockListProps`
Python	`aws_cdk.aws_kendra.CfnQuerySuggestionsBlockListProps`
TypeScript	`aws-cdk-lib` » `aws_kendra` » `CfnQuerySuggestionsBlockListProps`

Properties for defining a CfnQuerySuggestionsBlockList.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-querysuggestionsblocklist.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const cfnQuerySuggestionsBlockListProps: kendra.CfnQuerySuggestionsBlockListProps = {
  indexId: 'indexId',
  name: 'name',
  roleArn: 'roleArn',
  sourceS3Path: {
    bucket: 'bucket',
    key: 'key',
  },

  // the properties below are optional
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
indexId	`string`	The identifier of the index for the block list.
name	`string`	The name of the block list.
roleArn	`string`	The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file.
sourceS3Path	`IResolvable` `\|` `S3PathProperty`	Information required to find a specific file in an Amazon S3 bucket.
description?	`string`	A description for the block list.
tags?	`CfnTag[]`	A list of key-value pairs that identify or categorize the block list.