Package software.amazon.awscdk.services.s3vectors

Class CfnIndex

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.s3vectors.CfnIndex
All Implemented Interfaces:
IEnvironmentAware, IInspectable, IIndexRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:14.260Z") @Stability(Stable) public class CfnIndex extends CfnResource implements IInspectable, IIndexRef
Resource Type definition for AWS::S3Vectors::Index.

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.*;
 CfnIndex cfnIndex = CfnIndex.Builder.create(this, "MyCfnIndex")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnIndex

      protected CfnIndex(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnIndex

      protected CfnIndex(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnIndex

      @Stability(Stable) public CfnIndex(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIndexProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      Date and time when the vector index was created.

    • getAttrIndexArn

      @Stability(Stable) @NotNull public String getAttrIndexArn()
      The Amazon Resource Name (ARN) of the index.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getIndexRef

      @Stability(Stable) @NotNull public IndexReference getIndexRef()
      A reference to a Index resource.
      Specified by:
      getIndexRef in interface IIndexRef

    • getDataType

      @Stability(Stable) @NotNull public String getDataType()
      The data type of the vectors to be inserted into the vector index.

    • setDataType

      @Stability(Stable) public void setDataType(@NotNull String value)
      The data type of the vectors to be inserted into the vector index.

    • getDimension

      @Stability(Stable) @NotNull public Number getDimension()
      The dimensions of the vectors to be inserted into the vector index.

    • setDimension

      @Stability(Stable) public void setDimension(@NotNull Number value)
      The dimensions of the vectors to be inserted into the vector index.

    • getDistanceMetric

      @Stability(Stable) @NotNull public String getDistanceMetric()
      The distance metric to be used for similarity search.

    • setDistanceMetric

      @Stability(Stable) public void setDistanceMetric(@NotNull String value)
      The distance metric to be used for similarity search.

    • getIndexName

      @Stability(Stable) @Nullable public String getIndexName()
      The name of the vector index to create.

    • setIndexName

      @Stability(Stable) public void setIndexName(@Nullable String value)
      The name of the vector index to create.

    • getMetadataConfiguration

      @Stability(Stable) @Nullable public Object getMetadataConfiguration()
      The metadata configuration for the vector index.

      Returns union: either IResolvable or CfnIndex.MetadataConfigurationProperty

    • setMetadataConfiguration

      @Stability(Stable) public void setMetadataConfiguration(@Nullable IResolvable value)
      The metadata configuration for the vector index.

    • setMetadataConfiguration

      @Stability(Stable) public void setMetadataConfiguration(@Nullable CfnIndex.MetadataConfigurationProperty value)
      The metadata configuration for the vector index.

    • getVectorBucketArn

      @Stability(Stable) @Nullable public String getVectorBucketArn()
      The Amazon Resource Name (ARN) of the vector bucket.

    • setVectorBucketArn

      @Stability(Stable) public void setVectorBucketArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the vector bucket.

    • getVectorBucketName

      @Stability(Stable) @Nullable public String getVectorBucketName()
      The name of the vector bucket that contains the vector index.

    • setVectorBucketName

      @Stability(Stable) public void setVectorBucketName(@Nullable String value)
      The name of the vector bucket that contains the vector index.