Package software.amazon.awscdk.services.s3vectors

Interface CfnIndexProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndexProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:17.278Z")
@Stability(Stable)
public interface CfnIndexProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIndex.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3vectors.*;
 CfnIndexProps cfnIndexProps = CfnIndexProps.builder()
         .dataType("dataType")
         .dimension(123)
         .distanceMetric("distanceMetric")
         // the properties below are optional
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .sseType("sseType")
                 .build())
         .indexName("indexName")
         .metadataConfiguration(MetadataConfigurationProperty.builder()
                 .nonFilterableMetadataKeys(List.of("nonFilterableMetadataKeys"))
                 .build())
         .vectorBucketArn("vectorBucketArn")
         .vectorBucketName("vectorBucketName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIndexProps.Builder	A builder for CfnIndexProps
static final class	CfnIndexProps.Jsii$Proxy	An implementation for CfnIndexProps

Method Summary

Modifier and Type	Method	Description
static CfnIndexProps.Builder	builder()
String	getDataType()	The data type of the vectors to be inserted into the vector index.
Number	getDimension()	The dimensions of the vectors to be inserted into the vector index.
String	getDistanceMetric()	The distance metric to be used for similarity search.
default Object	getEncryptionConfiguration()	The encryption configuration for a vector index.
default String	getIndexName()	The name of the vector index to create.
default Object	getMetadataConfiguration()	The metadata configuration for the vector index.
default String	getVectorBucketArn()	The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
default String	getVectorBucketName()	The name of the vector bucket that contains the vector index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataType

@Stability(Stable)
@NotNull
String getDataType()

The data type of the vectors to be inserted into the vector index.

Currently, only float32 is supported, which represents 32-bit floating-point numbers.

See Also:

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

getDimension

@Stability(Stable)
@NotNull
Number getDimension()

The dimensions of the vectors to be inserted into the vector index.

This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.

The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.

See Also:

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

getDistanceMetric

@Stability(Stable)
@NotNull
String getDistanceMetric()

The distance metric to be used for similarity search. Valid values are:.

• cosine - Measures the cosine of the angle between two vectors.
• euclidean - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity.

See Also:

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

getEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getEncryptionConfiguration()

The encryption configuration for a vector index.

By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.

Returns union: either IResolvable or CfnIndex.EncryptionConfigurationProperty

See Also:

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

getIndexName

@Stability(Stable)
@Nullable
default String getIndexName()

The name of the vector index to create.

The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.

If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.

See Also:

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

getMetadataConfiguration

@Stability(Stable)
@Nullable
default Object getMetadataConfiguration()

The metadata configuration for the vector index.

Returns union: either IResolvable or CfnIndex.MetadataConfigurationProperty

See Also:

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

getVectorBucketArn

@Stability(Stable)
@Nullable
default String getVectorBucketArn()

The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.

See Also:

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

getVectorBucketName

@Stability(Stable)
@Nullable
default String getVectorBucketName()

The name of the vector bucket that contains the vector index.

See Also:

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

builder

@Stability(Stable)
static CfnIndexProps.Builder builder()

Returns:

a CfnIndexProps.Builder of CfnIndexProps