Package software.amazon.awscdk.services.s3vectors

Class CfnVectorBucket

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.CfnVectorBucket
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IVectorBucketRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:17.279Z") @Stability(Stable) public class CfnVectorBucket extends CfnResource implements IInspectable, IVectorBucketRef
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.services.s3vectors.*;
 CfnVectorBucket cfnVectorBucket = CfnVectorBucket.Builder.create(this, "MyCfnVectorBucket")
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .sseType("sseType")
                 .build())
         .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

    • CfnVectorBucket

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

    • CfnVectorBucket

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

    • CfnVectorBucket

      @Stability(Stable) public CfnVectorBucket(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnVectorBucketProps props)
      Create a new AWS::S3Vectors::VectorBucket.

      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.

    • CfnVectorBucket

      @Stability(Stable) public CfnVectorBucket(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::S3Vectors::VectorBucket.

      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.

  • Method Details

    • arnForVectorBucket

      @Stability(Stable) @NotNull public static String arnForVectorBucket(@NotNull IVectorBucketRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnVectorBucket

      @Stability(Stable) @NotNull public static Boolean isCfnVectorBucket(@NotNull Object x)
      Checks whether the given object is a CfnVectorBucket.

      Parameters:
      x - This parameter is required.

    • 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()
      Returns the date and time when the vector bucket was created.

      Example: 2024-12-21T10:30:00Z

    • getAttrVectorBucketArn

      @Stability(Stable) @NotNull public String getAttrVectorBucketArn()
      Returns the Amazon Resource Name (ARN) of the specified vector bucket.

      Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket

    • getCfnProperties

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

    • getVectorBucketRef

      @Stability(Stable) @NotNull public VectorBucketReference getVectorBucketRef()
      A reference to a VectorBucket resource.
      Specified by:
      getVectorBucketRef in interface IVectorBucketRef

    • getEncryptionConfiguration

      @Stability(Stable) @Nullable public Object getEncryptionConfiguration()
      The encryption configuration for the vector bucket.

      Returns union: either IResolvable or CfnVectorBucket.EncryptionConfigurationProperty

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable IResolvable value)
      The encryption configuration for the vector bucket.

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable CfnVectorBucket.EncryptionConfigurationProperty value)
      The encryption configuration for the vector bucket.

    • getVectorBucketName

      @Stability(Stable) @Nullable public String getVectorBucketName()
      A name for the vector bucket.

    • setVectorBucketName

      @Stability(Stable) public void setVectorBucketName(@Nullable String value)
      A name for the vector bucket.