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

Class CfnVectorBucketPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.s3vectors.CfnVectorBucketPropsMixin
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.852Z") @Stability(Stable) public class CfnVectorBucketPropsMixin extends Mixin implements software.constructs.IMixin
Defines an Amazon S3 vector bucket in the same AWS Region where you create the AWS CloudFormation stack.

Vector buckets are specialized storage containers designed for storing and managing vector data used in machine learning and AI applications. They provide optimized storage and retrieval capabilities for high-dimensional vector data.

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

You can only delete empty vector buckets. Deletion fails for buckets that have contents.

  • Permissions - The required permissions for CloudFormation to use are based on the operations that are performed on the stack.
  • Create
  • s3vectors:CreateVectorBucket
  • s3vectors:GetVectorBucket
  • kms:GenerateDataKey (if using KMS encryption)
  • Read
  • s3vectors:GetVectorBucket
  • kms:GenerateDataKey (if using KMS encryption)
  • Delete
  • s3vectors:DeleteVectorBucket
  • s3vectors:GetVectorBucket
  • kms:GenerateDataKey (if using KMS encryption)
  • List
  • s3vectors:ListVectorBuckets
  • kms:GenerateDataKey (if using KMS encryption)

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;
 CfnVectorBucketPropsMixin cfnVectorBucketPropsMixin = CfnVectorBucketPropsMixin.Builder.create(CfnVectorBucketMixinProps.builder()
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .sseType("sseType")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnVectorBucketPropsMixin

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

    • CfnVectorBucketPropsMixin

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

    • CfnVectorBucketPropsMixin

      @Stability(Stable) public CfnVectorBucketPropsMixin(@NotNull CfnVectorBucketMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::S3Vectors::VectorBucket.

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

    • CfnVectorBucketPropsMixin

      @Stability(Stable) public CfnVectorBucketPropsMixin(@NotNull CfnVectorBucketMixinProps props)
      Create a mixin to apply properties to AWS::S3Vectors::VectorBucket.

      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 CfnVectorBucketMixinProps getProps()

    • getStrategy

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