Package software.amazon.awscdk.cfnpropertymixins.services.s3vectors

Class CfnIndexPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.s3vectors.CfnIndexPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:04.849Z") @Stability(Stable) public class CfnIndexPropsMixin extends Mixin implements software.constructs.IMixin
The AWS::S3Vectors::Index resource defines a vector index within an Amazon S3 vector bucket.

For more information, see Creating a vector index in a vector bucket in the Amazon Simple Storage Service User Guide .

You must specify either VectorBucketName or VectorBucketArn to identify the bucket that contains the index.

To control how AWS CloudFormation handles the vector index when the stack is deleted, you can set a deletion policy for your index. You can choose to retain the index or to delete the index. For more information, see DeletionPolicy attribute .

  • Permissions - The required permissions for CloudFormation to use are based on the operations that are performed on the stack.
  • Create
  • s3vectors:CreateIndex
  • s3vectors:GetIndex
  • Read
  • s3vectors:GetIndex
  • Delete
  • s3vectors:DeleteIndex
  • s3vectors:GetIndex
  • List
  • s3vectors:ListIndexes

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.s3vectors.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnIndexPropsMixin cfnIndexPropsMixin = CfnIndexPropsMixin.Builder.create(CfnIndexMixinProps.builder()
         .dataType("dataType")
         .dimension(123)
         .distanceMetric("distanceMetric")
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .sseType("sseType")
                 .build())
         .indexName("indexName")
         .metadataConfiguration(MetadataConfigurationProperty.builder()
                 .nonFilterableMetadataKeys(List.of("nonFilterableMetadataKeys"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vectorBucketArn("vectorBucketArn")
         .vectorBucketName("vectorBucketName")
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnIndexPropsMixin

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

    • CfnIndexPropsMixin

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

    • CfnIndexPropsMixin

      @Stability(Stable) public CfnIndexPropsMixin(@NotNull CfnIndexMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::S3Vectors::Index.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnIndexPropsMixin

      @Stability(Stable) public CfnIndexPropsMixin(@NotNull CfnIndexMixinProps props)
      Create a mixin to apply properties to AWS::S3Vectors::Index.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnIndexMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()