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.118.0 (build 02eec31)",
           date="2025-11-10T13:40:14.261Z")
@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
         .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 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.
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.

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.

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.

See Also:

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

getIndexName

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

The name of the vector index to create.

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.

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