AWS::Kendra::Index

Kendra Index

A Kendra index

Properties

10 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`Edition`	`string`	RequiredCreate-only
`Name`	`string`	Required
`RoleArn`	`string`	Required
`CapacityUnits`	`CapacityUnitsConfiguration`
`Description`	`string`
`DocumentMetadataConfigurations`	`array`
`ServerSideEncryptionConfiguration`	`ServerSideEncryptionConfiguration`	Create-only
`Tags`	`array`
`UserContextPolicy`	`string`
`UserTokenConfigurations`	`array`

Return Values

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

Attribute	Type	Description
`Arn`	`string`	-
`Id`	`string`	-

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::Index

Resources:
  MyResource:
    Type: AWS::Kendra::Index
    Properties:
      Name: "my-name"
      RoleArn: "arn:aws:service:region:account:resource"
      Edition: "value"
      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:CreateIndexkendra:DescribeIndexkendra:UpdateIndexkendra:ListTagsForResourceiam:PassRolekendra:TagResourcekms:DescribeKeykms:CreateGrant

read

kendra:DescribeIndexkendra:ListTagsForResource

update

kendra:DescribeIndexkendra:UpdateIndexkendra:ListTagsForResourcekendra:TagResourcekendra:UntagResourceiam:PassRole

delete

kendra:DescribeIndexkendra:DeleteIndexkms:RetireGrant

list

kendra:ListIndices

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

Properties12

Required3

TaggingSupported

Primary IDId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

EditionServerSideEncryptionConfiguration

Related Resources

External Links

AWS Documentation