AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Kendra::Index

CfnIndex

Creates an Amazon Kendra index. Once the index is active you can add documents to your index using the [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/dg/BatchPutDocument.html) operation or using one of the supported data sources.

Import

import { CfnIndex } from 'aws-cdk-lib/aws-kendra';

Or use the module namespace:

import * as kendra from 'aws-cdk-lib/aws-kendra';
// kendra.CfnIndex

Properties

Configuration passed to the constructor as CfnIndexProps.

editionRequired
string

Indicates whether the index is a Enterprise Edition index, a Developer Edition index, or a GenAI Enterprise Edition index.

nameRequired
string

The name of the index.

roleArnRequired
string | IRoleRef

An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/dg/BatchPutDocument.html) operation to index documents from an Amazon S3 bucket.

capacityUnitsOptional
IResolvable | CapacityUnitsConfigurationProperty

Specifies additional capacity units configured for your Enterprise Edition index. You can add and remove capacity units to fit your usage requirements.

descriptionOptional
string

A description for the index.

documentMetadataConfigurationsOptional
IResolvable | IResolvable | DocumentMetadataConfigurationProperty[]

Specifies the properties of an index field. You can add either a custom or a built-in field. You can add and remove built-in fields at any time. When a built-in field is removed it's configuration reverts to the default for the field. Custom fields can't be removed from an index after they are added.

serverSideEncryptionConfigurationOptional
IResolvable | ServerSideEncryptionConfigurationProperty

The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

tagsOptional
CfnTag[]

An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

userContextPolicyOptional
string

The user context policy. ATTRIBUTE_FILTER - All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of `_user_id` and `_group_ids` or you can provide user and group information in `UserContext` . USER_TOKEN - Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

userTokenConfigurationsOptional
IResolvable | IResolvable | UserTokenConfigurationProperty[]

Defines the type of user token used for the index.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

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

LevelL1 (CloudFormation)
Moduleaws-kendra
CFN TypeAWS::Kendra::Index
Properties10

Related Constructs

External Links