AWS::Kendra::Index - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Kendra::Index

Creates an Amazon Kendra index

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Kendra::Index",
  "Properties" : {
      "CapacityUnits" : CapacityUnitsConfiguration,
      "Description" : String,
      "DocumentMetadataConfigurations" : [ DocumentMetadataConfiguration, ... ],
      "Edition" : String,
      "Name" : String,
      "RoleArn" : String,
      "ServerSideEncryptionConfiguration" : ServerSideEncryptionConfiguration,
      "Tags" : [ Tag, ... ],
      "UserContextPolicy" : String,
      "UserTokenConfigurations" : [ UserTokenConfiguration, ... ]
    }
}

Properties

CapacityUnits

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

Required: No

Type: CapacityUnitsConfiguration

Update requires: No interruption

Description

A description for the index.

Required: No

Type: String

Maximum: 1000

Update requires: No interruption

DocumentMetadataConfigurations

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.

Required: No

Type: Array of DocumentMetadataConfiguration

Maximum: 500

Update requires: No interruption

Edition

Indicates whether the index is a Enterprise Edition index or a Developer Edition index. Valid values are DEVELOPER_EDITION and ENTERPRISE_EDITION.

Required: Yes

Type: String

Allowed values: DEVELOPER_EDITION | ENTERPRISE_EDITION

Update requires: Replacement

Name

The name of the index.

Required: Yes

Type: String

Minimum: 1

Maximum: 1000

Update requires: No interruption

RoleArn

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 operation to index documents from an Amazon S3 bucket.

Required: Yes

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Minimum: 1

Maximum: 1284

Update requires: No interruption

ServerSideEncryptionConfiguration

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.

Required: No

Type: ServerSideEncryptionConfiguration

Update requires: Replacement

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Maximum: 200

Update requires: No interruption

UserContextPolicy

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.

Required: No

Type: String

Allowed values: ATTRIBUTE_FILTER | USER_TOKEN

Update requires: No interruption

UserTokenConfigurations

Defines the type of user token used for the index.

Required: No

Type: Array of UserTokenConfiguration

Maximum: 1

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the index ID. For example:

{"Ref": "index-id"}

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the index. For example: arn:aws:kendra:us-west-2:111122223333:index/0123456789abcdef.

Id

The identifier for the index. For example: f4aeaa10-8056-4b2c-a343-522ca0f41234.