CfnIndexProps

class aws_cdk.aws_s3vectors.CfnIndexProps(*, data_type, dimension, distance_metric, index_name=None, metadata_configuration=None, vector_bucket_arn=None, vector_bucket_name=None)

Bases: object

Properties for defining a CfnIndex.

Parameters:

data_type (str) – The data type of the vectors to be inserted into the vector index.
dimension (Union[int, float]) – The dimensions of the vectors to be inserted into the vector index.
distance_metric (str) – The distance metric to be used for similarity search.
index_name (Optional[str]) – The name of the vector index to create.
metadata_configuration (Union[IResolvable, MetadataConfigurationProperty, Dict[str, Any], None]) – The metadata configuration for the vector index.
vector_bucket_arn (Optional[str]) – The Amazon Resource Name (ARN) of the vector bucket.
vector_bucket_name (Optional[str]) – The name of the vector bucket that contains the vector index.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-index.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_s3vectors as s3vectors

cfn_index_props = s3vectors.CfnIndexProps(
    data_type="dataType",
    dimension=123,
    distance_metric="distanceMetric",

    # the properties below are optional
    index_name="indexName",
    metadata_configuration=s3vectors.CfnIndex.MetadataConfigurationProperty(
        non_filterable_metadata_keys=["nonFilterableMetadataKeys"]
    ),
    vector_bucket_arn="vectorBucketArn",
    vector_bucket_name="vectorBucketName"
)