AWS::S3Vectors::VectorBucket - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::S3Vectors::VectorBucket

Defines an Amazon S3 vector bucket in the same Amazon Region where you create the Amazon 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 Amazon 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.

Important

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)

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::S3Vectors::VectorBucket",
  "Properties" : {
      "EncryptionConfiguration" : EncryptionConfiguration,
      "VectorBucketName" : String
    }
}

YAML

Type: AWS::S3Vectors::VectorBucket
Properties:
  EncryptionConfiguration: 
    EncryptionConfiguration
  VectorBucketName: String

Properties

EncryptionConfiguration

The encryption configuration for the vector bucket.

Required: No

Type: EncryptionConfiguration

Update requires: Replacement

VectorBucketName

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 Amazon account for each Amazon Region. If you don't specify a name, Amazon 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.

Important

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.

Required: No

Type: String

Minimum: 3

Maximum: 63

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the vector bucket name.

Example: amzn-s3-demo-vector-bucket

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreationTime

Returns the date and time when the vector bucket was created.

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

VectorBucketArn

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