aws-cloudformation / aws-cloudformation/cloudformation-coverage-roadmap
[AWS::OpenSearchServerless::Index] - [PropertyMapping] - Type parameter should support Opensearch type fields
- Dominant language
- No language data
- Stars
- 1.1k
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
### Name of the resource
Other
### Resource name
AWS::OpenSearchServerless::Index
### Description
We need to create an OpenSearch index in a dedicated collection for a Bedrock KB with a field mapping that includes 'date' and 'long' types. Unfortunately, "text" and "knn_vector" are the only types supported by the "AWS::OpenSearchServerless::Index" resource type. [cfn documentation type](https://docs.aws.amazon.com/fr_fr/AWSCloudFormation/latest/TemplateReference/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-type), [Supported types from opensearch](https://docs.opensearch.org/latest/mappings/supported-field-types/index/).
Here my example
```yaml
KBCollectionIndex:
Type: AWS::OpenSearchServerless::Index
Properties:
CollectionEndpoint: !GetAtt KBCollection.CollectionEndpoint
IndexName: bedrock-knowledge-base-default-index
Mappings:
Properties:
AMAZON_BEDROCK_METADATA:
Type: text
Index: false
AMAZON_BEDROCK_TEXT:
Type: text
Index: true
AMAZON_BEDROCK_TEXT_CHUNK:
Type: text
bedrock-knowledge-base-default-vector:
Type: 'knn_vector'
Dimension: 1024
Method:
Engine: 'faiss'
Name: 'hnsw'
SpaceType: 'l2'
Parameters: {}
id:
Type: text
Index: true
x-amz-bedrock-kb-author:
Type: text
Index: true
x-amz-bedrock-kb-category:
Type: text
Index: true
x-amz-bedrock-kb-checkOutType:
Type: text
Index: true
x-amz-bedrock-kb-contentTag:
Type: text
Index: true
x-amz-bedrock-kb-createdDate:
Type: text # should be "date"
Index: true
x-amz-bedrock-kb-data-source-id:
Type: text
Index: true
x-amz-bedrock-kb-document-page-number:
Type: text # should be "long"
Index: true
x-amz-bedrock-kb-eTag:
Type: text
Index: true
x-amz-bedrock-kb-irmEnabled:
Type: text
Index: true
x-amz-bedrock-kb-lastModifiedDateTime:
Type: text # should be "date"
Index: true
x-amz-bedrock-kb-level:
Type: text
Index: true
x-amz-bedrock-kb-majorVersion:
Type: text
Index: true
x-amz-bedrock-kb-size:
Type: text
Index: true
x-amz-bedrock-kb-source-file-modality:
Type: text
Index: true
x-amz-bedrock-kb-source-uri:
Type: text
Index: true
x-amz-bedrock-kb-title:
Type: text
Index: true
x-amz-bedrock-kb-uiVersion:
Type: text
Index: true
x-amz-bedrock-kb-uiVersionLabel:
Type: text
Index: true
x-amz-bedrock-kb-uniqueId:
Type: text
Index: true
Settings:
Index:
Knn: true
```
### Other Details
_No response_
Contributor guide
Research direction
The issue names AWS::OpenSearchServerless::Index and its PropertyMapping Type parameter, but no repository files, tests, or entry points. Start by locating the resource schema and validation tests; done means the requested OpenSearch date and long types are accepted and covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws
- Domain
- cloud
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100