Skip to main content
← back to extensions

@swamp/aws/s3vectors

v2026.04.23.3

AWS S3VECTORS infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

awss3vectorscloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/s3vectors

@swamp/aws/s3vectors/indexv2026.04.23.2index.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
DataTypeenumThe data type of the vectors to be inserted into the vector index.
DimensionnumberThe dimensions of the vectors to be inserted into the vector index.
DistanceMetricenumThe distance metric to be used for similarity search.
EncryptionConfiguration?objectThe encryption configuration for the index.
IndexName?stringThe name of the vector index to create.
MetadataConfiguration?objectThe metadata configuration for the vector index.
VectorBucketArn?stringThe Amazon Resource Name (ARN) of the vector bucket.
VectorBucketName?stringThe name of the vector bucket that contains the vector index.
Tags?arrayUser tags (key-value pairs) to associate with the index.
createCreate a S3Vectors Index
getGet a S3Vectors Index
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Vectors Index
updateUpdate a S3Vectors Index
deleteDelete a S3Vectors Index
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Vectors Index
syncSync S3Vectors Index state from AWS

Resources

state(infinite)— S3Vectors Index resource state
@swamp/aws/s3vectors/vector-bucketv2026.04.23.2vector_bucket.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
VectorBucketName?stringThe name of the vector bucket.
EncryptionConfiguration?objectThe encryption configuration for the vector bucket.
Tags?arrayUser tags (key-value pairs) to associate with the vector bucket.
createCreate a S3Vectors VectorBucket
getGet a S3Vectors VectorBucket
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Vectors VectorBucket
updateUpdate a S3Vectors VectorBucket
deleteDelete a S3Vectors VectorBucket
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Vectors VectorBucket
syncSync S3Vectors VectorBucket state from AWS

Resources

state(infinite)— S3Vectors VectorBucket resource state
@swamp/aws/s3vectors/vector-bucket-policyv2026.04.23.2vector_bucket_policy.ts

Global Arguments

ArgumentTypeDescription
PolicystringA policy document containing permissions to add to the specified vector bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
VectorBucketArn?stringThe Amazon Resource Name (ARN) of the vector bucket.
VectorBucketName?stringThe name of the vector bucket
createCreate a S3Vectors VectorBucketPolicy
getGet a S3Vectors VectorBucketPolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Vectors VectorBucketPolicy
updateUpdate a S3Vectors VectorBucketPolicy
deleteDelete a S3Vectors VectorBucketPolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Vectors VectorBucketPolicy
syncSync S3Vectors VectorBucketPolicy state from AWS

Resources

state(infinite)— S3Vectors VectorBucketPolicy resource state