AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::S3Vectors::VectorBucket

CfnVectorBucket

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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) . > 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)

Import

import { CfnVectorBucket } from 'aws-cdk-lib/aws-s3vectors';

Or use the module namespace:

import * as s3vectors from 'aws-cdk-lib/aws-s3vectors';
// s3vectors.CfnVectorBucket

Properties

Configuration passed to the constructor as CfnVectorBucketProps.

encryptionConfigurationOptional
IResolvable | EncryptionConfigurationProperty

The encryption configuration for the vector bucket.

tagsOptional
CfnTag[]

User tags (key-value pairs) to associate with the vector bucket.

vectorBucketNameOptional
string

A name for the vector bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). The bucket name must be unique in the same AWS account for each AWS Region. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must be between 3 and 63 characters long and must not contain uppercase characters or underscores. > If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-s3vectors
CFN TypeAWS::S3Vectors::VectorBucket
Properties3

Related Constructs

External Links