Resource Type definition for AWS::OpenSearchServerless::Index
Create Index Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def Index(resource_name: str,
args: IndexArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Index(resource_name: str,
opts: Optional[ResourceOptions] = None,
collection_endpoint: Optional[str] = None,
index_name: Optional[str] = None,
mappings: Optional[MappingsPropertiesArgs] = None,
settings: Optional[IndexSettingsArgs] = None)
public Index(String name, IndexArgs args)
public Index(String name, IndexArgs args, CustomResourceOptions options)
type: aws-native:opensearchserverless:Index
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_opensearchserverless_index" "name" {
# resource properties
}
Parameters
- name
string
- The unique name of the resource.
- args
IndexArgs
- The arguments to resource properties.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resource.
- args
IndexArgs
- The arguments to resource properties.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resource.
- args
IndexArgs
- The arguments to resource properties.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resource.
- args
IndexArgs
- The arguments to resource properties.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resource.
- args
IndexArgs
- The arguments to resource properties.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Index Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Index resource accepts the following input properties:
Outputs
All input properties are implicitly available as output properties. Additionally, the Index resource produces the following output properties:
- Id
string
- The provider-assigned unique ID for this managed resource.
- Uuid
string
- The unique identifier for the index.
- Id
string
- The provider-assigned unique ID for this managed resource.
- Uuid
string
- The unique identifier for the index.
- id
string
- The provider-assigned unique ID for this managed resource.
- uuid
string
- The unique identifier for the index.
- id
String
- The provider-assigned unique ID for this managed resource.
- uuid
String
- The unique identifier for the index.
- id
string
- The provider-assigned unique ID for this managed resource.
- uuid
string
- The unique identifier for the index.
- id
str
- The provider-assigned unique ID for this managed resource.
- uuid
str
- The unique identifier for the index.
- id
String
- The provider-assigned unique ID for this managed resource.
- uuid
String
- The unique identifier for the index.
Look up Existing Index Resource
Get an existing Index resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static Index get(String name, Output<String> id, CustomResourceOptions options)
resources: existingIndex: type: aws-native:opensearchserverless:Index get: id: ${id}
import {
to = aws-native_opensearchserverless_index.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
IndexState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
IndexPropertyMapping, IndexPropertyMappingArgs
IndexPropertyMappingCompressionLevel
The compression level for knn_vector fields
| Name | Value |
|---|
| IndexPropertyMappingCompressionLevel_16x | 16x |
| IndexPropertyMappingCompressionLevel_32x | 32x |
| IndexPropertyMappingCompressionLevel_8x | 8x |
| IndexPropertyMappingCompressionLevel_4x | 4x |
| IndexPropertyMappingCompressionLevel_2x | 2x |
| IndexPropertyMappingCompressionLevel_1x | 1x |
| Name | Value |
|---|
| IndexPropertyMappingCompressionLevel_16x | 16x |
| IndexPropertyMappingCompressionLevel_32x | 32x |
| IndexPropertyMappingCompressionLevel_8x | 8x |
| IndexPropertyMappingCompressionLevel_4x | 4x |
| IndexPropertyMappingCompressionLevel_2x | 2x |
| IndexPropertyMappingCompressionLevel_1x | 1x |
| Name | Value |
|---|
| _16x | 16x |
| _32x | 32x |
| _8x | 8x |
| _4x | 4x |
| _2x | 2x |
| _1x | 1x |
| Name | Value |
|---|
| IndexPropertyMappingCompressionLevel_16x | 16x |
| IndexPropertyMappingCompressionLevel_32x | 32x |
| IndexPropertyMappingCompressionLevel_8x | 8x |
| IndexPropertyMappingCompressionLevel_4x | 4x |
| IndexPropertyMappingCompressionLevel_2x | 2x |
| IndexPropertyMappingCompressionLevel_1x | 1x |
| Name | Value |
|---|
| INDEX_PROPERTY_MAPPING_COMPRESSION_LEVEL_16X | 16x |
| INDEX_PROPERTY_MAPPING_COMPRESSION_LEVEL_32X | 32x |
| INDEX_PROPERTY_MAPPING_COMPRESSION_LEVEL_8X | 8x |
| INDEX_PROPERTY_MAPPING_COMPRESSION_LEVEL_4X | 4x |
| INDEX_PROPERTY_MAPPING_COMPRESSION_LEVEL_2X | 2x |
| INDEX_PROPERTY_MAPPING_COMPRESSION_LEVEL_1X | 1x |
IndexPropertyMappingDataType
The data type for knn_vector fields (e.g. float, byte). Controls how vector values are stored.
| Name | Value |
|---|
| Float | float |
| Byte | byte |
| Name | Value |
|---|
| IndexPropertyMappingDataTypeFloat | float |
| IndexPropertyMappingDataTypeByte | byte |
| Name | Value |
|---|
| Float | float |
| Byte | byte |
| Name | Value |
|---|
| Float | float |
| Byte | byte |
| Name | Value |
|---|
| FLOAT | float |
| BYTE | byte |
IndexPropertyMappingMethodProperties, IndexPropertyMappingMethodPropertiesArgs
Configuration for k-NN search method
IndexPropertyMappingMethodPropertiesEngine
The k-NN search engine to use
| Name | Value |
|---|
| Nmslib | nmslib |
| Faiss | faiss |
| Lucene | lucene |
| Name | Value |
|---|
| IndexPropertyMappingMethodPropertiesEngineNmslib | nmslib |
| IndexPropertyMappingMethodPropertiesEngineFaiss | faiss |
| IndexPropertyMappingMethodPropertiesEngineLucene | lucene |
| Name | Value |
|---|
| Nmslib | nmslib |
| Faiss | faiss |
| Lucene | lucene |
| Name | Value |
|---|
| Nmslib | nmslib |
| Faiss | faiss |
| Lucene | lucene |
| Name | Value |
|---|
| NMSLIB | nmslib |
| FAISS | faiss |
| LUCENE | lucene |
IndexPropertyMappingMethodPropertiesName
The algorithm name for k-NN search
| Name | Value |
|---|
| IndexPropertyMappingMethodPropertiesNameHnsw | hnsw |
| IndexPropertyMappingMethodPropertiesNameIvf | ivf |
IndexPropertyMappingMethodPropertiesParametersProperties, IndexPropertyMappingMethodPropertiesParametersPropertiesArgs
Additional parameters for the k-NN algorithm
- EfConstruction
int
- The size of the dynamic list used during k-NN graph creation
- M
int
- Number of neighbors to consider during k-NN search
- EfConstruction
int
- The size of the dynamic list used during k-NN graph creation
- M
int
- Number of neighbors to consider during k-NN search
- ef_construction
number
- The size of the dynamic list used during k-NN graph creation
- m
number
- Number of neighbors to consider during k-NN search
- efConstruction
Integer
- The size of the dynamic list used during k-NN graph creation
- m
Integer
- Number of neighbors to consider during k-NN search
- efConstruction
number
- The size of the dynamic list used during k-NN graph creation
- m
number
- Number of neighbors to consider during k-NN search
- ef_construction
int
- The size of the dynamic list used during k-NN graph creation
- m
int
- Number of neighbors to consider during k-NN search
- efConstruction
Number
- The size of the dynamic list used during k-NN graph creation
- m
Number
- Number of neighbors to consider during k-NN search
IndexPropertyMappingMethodPropertiesSpaceType
The distance function used for k-NN search
| Name | Value |
|---|
| L2 | l2 |
| L1 | l1 |
| Linf | linf |
| Cosinesimil | cosinesimil |
| Innerproduct | innerproduct |
| Hamming | hamming |
| Name | Value |
|---|
| IndexPropertyMappingMethodPropertiesSpaceTypeL2 | l2 |
| IndexPropertyMappingMethodPropertiesSpaceTypeL1 | l1 |
| IndexPropertyMappingMethodPropertiesSpaceTypeLinf | linf |
| IndexPropertyMappingMethodPropertiesSpaceTypeCosinesimil | cosinesimil |
| IndexPropertyMappingMethodPropertiesSpaceTypeInnerproduct | innerproduct |
| IndexPropertyMappingMethodPropertiesSpaceTypeHamming | hamming |
| Value |
|---|
l2 |
l1 |
linf |
cosinesimil |
innerproduct |
hamming |
| Name | Value |
|---|
| L2 | l2 |
| L1 | l1 |
| Linf | linf |
| Cosinesimil | cosinesimil |
| Innerproduct | innerproduct |
| Hamming | hamming |
| Name | Value |
|---|
| L2 | l2 |
| L1 | l1 |
| Linf | linf |
| Cosinesimil | cosinesimil |
| Innerproduct | innerproduct |
| Hamming | hamming |
| Name | Value |
|---|
| L2 | l2 |
| L1 | l1 |
| LINF | linf |
| COSINESIMIL | cosinesimil |
| INNERPRODUCT | innerproduct |
| HAMMING | hamming |
| Value |
|---|
l2 |
l1 |
linf |
cosinesimil |
innerproduct |
hamming |
IndexPropertyMappingSpaceType
The distance function used for k-NN search (field-level, outside Method)
| Name | Value |
|---|
| L2 | l2 |
| L1 | l1 |
| Linf | linf |
| Cosinesimil | cosinesimil |
| Innerproduct | innerproduct |
| Hamming | hamming |
| Name | Value |
|---|
| IndexPropertyMappingSpaceTypeL2 | l2 |
| IndexPropertyMappingSpaceTypeL1 | l1 |
| IndexPropertyMappingSpaceTypeLinf | linf |
| IndexPropertyMappingSpaceTypeCosinesimil | cosinesimil |
| IndexPropertyMappingSpaceTypeInnerproduct | innerproduct |
| IndexPropertyMappingSpaceTypeHamming | hamming |
| Value |
|---|
l2 |
l1 |
linf |
cosinesimil |
innerproduct |
hamming |
| Name | Value |
|---|
| L2 | l2 |
| L1 | l1 |
| Linf | linf |
| Cosinesimil | cosinesimil |
| Innerproduct | innerproduct |
| Hamming | hamming |
| Name | Value |
|---|
| L2 | l2 |
| L1 | l1 |
| Linf | linf |
| Cosinesimil | cosinesimil |
| Innerproduct | innerproduct |
| Hamming | hamming |
| Name | Value |
|---|
| L2 | l2 |
| L1 | l1 |
| LINF | linf |
| COSINESIMIL | cosinesimil |
| INNERPRODUCT | innerproduct |
| HAMMING | hamming |
| Value |
|---|
l2 |
l1 |
linf |
cosinesimil |
innerproduct |
hamming |
IndexPropertyMappingType
The field data type. Must be a valid OpenSearch field type.
| Name | Value |
|---|
| Text | text |
| KnnVector | knn_vector |
| Keyword | keyword |
| Integer | integer |
| Name | Value |
|---|
| IndexPropertyMappingTypeText | text |
| IndexPropertyMappingTypeKnnVector | knn_vector |
| IndexPropertyMappingTypeKeyword | keyword |
| IndexPropertyMappingTypeInteger | integer |
| Value |
|---|
text |
knn_vector |
keyword |
integer |
| Name | Value |
|---|
| Text | text |
| KnnVector | knn_vector |
| Keyword | keyword |
| Integer | integer |
| Name | Value |
|---|
| Text | text |
| KnnVector | knn_vector |
| Keyword | keyword |
| Integer | integer |
| Name | Value |
|---|
| TEXT | text |
| KNN_VECTOR | knn_vector |
| KEYWORD | keyword |
| INTEGER | integer |
| Value |
|---|
text |
knn_vector |
keyword |
integer |
IndexSettings, IndexSettingsArgs
IndexSettingsAnalysisProperties, IndexSettingsAnalysisPropertiesArgs
Custom analysis configuration including analyzers, tokenizers, and filters
- Analyzer
Dictionary<string, Pulumi.AwsNative.OpenSearchServerless.Inputs.IndexSettingsAnalysisPropertiesAnalyzerValueProperties>
- Custom analyzer definitions
- Analyzer
map[string]IndexSettingsAnalysisPropertiesAnalyzerValueProperties
- Custom analyzer definitions
- analyzer
map(object)
- Custom analyzer definitions
- analyzer
Map<String,IndexSettingsAnalysisPropertiesAnalyzerValueProperties>
- Custom analyzer definitions
- analyzer
{[key: string]: IndexSettingsAnalysisPropertiesAnalyzerValueProperties}
- Custom analyzer definitions
- analyzer
Mapping[str, IndexSettingsAnalysisPropertiesAnalyzerValueProperties]
- Custom analyzer definitions
- analyzer
Map<Property Map>
- Custom analyzer definitions
IndexSettingsAnalysisPropertiesAnalyzerValueProperties, IndexSettingsAnalysisPropertiesAnalyzerValuePropertiesArgs
- CharFilter
List<string>
- Character filters to apply
- Filter
List<string>
- Token filters to apply
- Tokenizer
string
- The tokenizer to use
- Type
string
- The analyzer type (e.g. custom, standard, simple)
- CharFilter
[]string
- Character filters to apply
- Filter
[]string
- Token filters to apply
- Tokenizer
string
- The tokenizer to use
- Type
string
- The analyzer type (e.g. custom, standard, simple)
- char_filter
list(string)
- Character filters to apply
- filter
list(string)
- Token filters to apply
- tokenizer
string
- The tokenizer to use
- type
string
- The analyzer type (e.g. custom, standard, simple)
- charFilter
List<String>
- Character filters to apply
- filter
List<String>
- Token filters to apply
- tokenizer
String
- The tokenizer to use
- type
String
- The analyzer type (e.g. custom, standard, simple)
- charFilter
string[]
- Character filters to apply
- filter
string[]
- Token filters to apply
- tokenizer
string
- The tokenizer to use
- type
string
- The analyzer type (e.g. custom, standard, simple)
- char_filter
Sequence[str]
- Character filters to apply
- filter
Sequence[str]
- Token filters to apply
- tokenizer
str
- The tokenizer to use
- type
str
- The analyzer type (e.g. custom, standard, simple)
- charFilter
List<String>
- Character filters to apply
- filter
List<String>
- Token filters to apply
- tokenizer
String
- The tokenizer to use
- type
String
- The analyzer type (e.g. custom, standard, simple)
IndexSettingsIndexProperties, IndexSettingsIndexPropertiesArgs
Index settings.
- Knn
bool
- Enable/disable k-nearest neighbor search capability
- KnnAlgoParamEfSearch
int
- Size of the dynamic list for the nearest neighbors
- RefreshInterval
string
- How often to perform refresh operation (e.g. '1s', '5s')
- Knn
bool
- Enable/disable k-nearest neighbor search capability
- KnnAlgoParamEfSearch
int
- Size of the dynamic list for the nearest neighbors
- RefreshInterval
string
- How often to perform refresh operation (e.g. '1s', '5s')
- knn
bool
- Enable/disable k-nearest neighbor search capability
- knn_algo_param_ef_search
number
- Size of the dynamic list for the nearest neighbors
- refresh_interval
string
- How often to perform refresh operation (e.g. '1s', '5s')
- knn
Boolean
- Enable/disable k-nearest neighbor search capability
- knnAlgoParamEfSearch
Integer
- Size of the dynamic list for the nearest neighbors
- refreshInterval
String
- How often to perform refresh operation (e.g. '1s', '5s')
- knn
boolean
- Enable/disable k-nearest neighbor search capability
- knnAlgoParamEfSearch
number
- Size of the dynamic list for the nearest neighbors
- refreshInterval
string
- How often to perform refresh operation (e.g. '1s', '5s')
- knn
Boolean
- Enable/disable k-nearest neighbor search capability
- knnAlgoParamEfSearch
Number
- Size of the dynamic list for the nearest neighbors
- refreshInterval
String
- How often to perform refresh operation (e.g. '1s', '5s')
MappingsProperties, MappingsPropertiesArgs
Index Mappings
- Properties
Dictionary<string, Pulumi.AwsNative.OpenSearchServerless.Inputs.IndexPropertyMapping>
- Defines the fields within the mapping, including their types and configurations
- Properties
map[string]IndexPropertyMapping
- Defines the fields within the mapping, including their types and configurations
- properties
map(object)
- Defines the fields within the mapping, including their types and configurations
- properties
Map<String,IndexPropertyMapping>
- Defines the fields within the mapping, including their types and configurations
- properties
{[key: string]: IndexPropertyMapping}
- Defines the fields within the mapping, including their types and configurations
- properties
Mapping[str, IndexPropertyMapping]
- Defines the fields within the mapping, including their types and configurations
- properties
Map<Property Map>
- Defines the fields within the mapping, including their types and configurations
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0