latest--aws-kendra-index

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-kendra-index.json
Parent schema serverless-framework-configuration
Type: object

A Kendra index. Source:- https://docs.aws.amazon.com/kendra/latest/dg/hiw-index.html

Properties

Name string | Aws_CF_FunctionString required

Name of index

RoleArn string | Aws_CF_FunctionString required

Role Arn

Edition string | Aws_CF_FunctionString required

Edition of index

Description string | Aws_CF_FunctionString
ServerSideEncryptionConfiguration object
1 nested properties
KmsKeyId string | Aws_CF_FunctionString
Tags Tag[]

List of tags

maxItems=200
DocumentMetadataConfigurations DocumentMetadataConfiguration[]
maxItems=500
CapacityUnits object
2 nested properties
StorageCapacityUnits integer required
min=0
QueryCapacityUnits integer required
min=0
UserContextPolicy string | Aws_CF_FunctionString
UserTokenConfigurations UserTokenConfiguration[]
maxItems=1

Definitions

ServerSideEncryptionConfiguration object
KmsKeyId string | Aws_CF_FunctionString
Description string | Aws_CF_FunctionString
KmsKeyId string | Aws_CF_FunctionString
Tag object

A label for tagging Kendra resources

Key string | Aws_CF_FunctionString required

A string used to identify this tag

Value string | Aws_CF_FunctionString required

A string containing the value for the tag

TagList Tag[]

List of tags

Importance integer
Freshness boolean
Duration string | Aws_CF_FunctionString
Order string | Aws_CF_FunctionString
Relevance object
Freshness boolean
Importance integer
min=1max=10
Duration string | Aws_CF_FunctionString
RankOrder string | Aws_CF_FunctionString
ValueImportanceItems ValueImportanceItem[]
ValueImportanceItems ValueImportanceItem[]
ValueImportanceItem object
Key string | Aws_CF_FunctionString
Value integer
min=1max=10
ValueImportanceItemKey string | Aws_CF_FunctionString
DocumentMetadataConfigurationName string | Aws_CF_FunctionString
DocumentAttributeValueType string | Aws_CF_FunctionString
DocumentMetadataConfiguration object
Name string | Aws_CF_FunctionString required
Type string | Aws_CF_FunctionString required
Relevance object
5 nested properties
Freshness boolean
Importance integer
min=1max=10
Duration string | Aws_CF_FunctionString
RankOrder string | Aws_CF_FunctionString
ValueImportanceItems ValueImportanceItem[]
Search object
4 nested properties
Facetable boolean
Searchable boolean
Displayable boolean
Sortable boolean
DocumentMetadataConfigurationList DocumentMetadataConfiguration[]
StorageCapacityUnits integer
QueryCapacityUnits integer
CapacityUnitsConfiguration object
StorageCapacityUnits integer required
min=0
QueryCapacityUnits integer required
min=0
Edition string | Aws_CF_FunctionString

Edition of index

Name string | Aws_CF_FunctionString

Name of index

RoleArn string | Aws_CF_FunctionString

Role Arn

Id string | Aws_CF_FunctionString

Unique ID of index

Arn string | Aws_CF_FunctionString
UserContextPolicy string | Aws_CF_FunctionString
UserNameAttributeField string | Aws_CF_FunctionString
GroupAttributeField string | Aws_CF_FunctionString
KeyLocation string | Aws_CF_FunctionString
Issuer string | Aws_CF_FunctionString
ClaimRegex string | Aws_CF_FunctionString
Url string | Aws_CF_FunctionString
JsonTokenTypeConfiguration object
UserNameAttributeField string | Aws_CF_FunctionString required
GroupAttributeField string | Aws_CF_FunctionString required
JwtTokenTypeConfiguration object
KeyLocation string | Aws_CF_FunctionString required
URL string | Aws_CF_FunctionString
SecretManagerArn string | Aws_CF_FunctionString

Role Arn

UserNameAttributeField string | Aws_CF_FunctionString
GroupAttributeField string | Aws_CF_FunctionString
Issuer string | Aws_CF_FunctionString
ClaimRegex string | Aws_CF_FunctionString
UserTokenConfiguration object
JwtTokenTypeConfiguration object
7 nested properties
KeyLocation string | Aws_CF_FunctionString required
URL string | Aws_CF_FunctionString
SecretManagerArn string | Aws_CF_FunctionString

Role Arn

UserNameAttributeField string | Aws_CF_FunctionString
GroupAttributeField string | Aws_CF_FunctionString
Issuer string | Aws_CF_FunctionString
ClaimRegex string | Aws_CF_FunctionString
JsonTokenTypeConfiguration object
2 nested properties
UserNameAttributeField string | Aws_CF_FunctionString required
GroupAttributeField string | Aws_CF_FunctionString required
UserTokenConfigurationList UserTokenConfiguration[]