Aws/s3vectors

@swamp/aws/s3vectorsv2026.10.25.1· AGPL-3.0-or-later· 1d agoBEHAVIORS

01README

AWS S3VECTORS infrastructure models

02Behaviors3

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

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
DataType	enum	yes	The data type of the vectors to be inserted into the vector index.
Dimension	number	yes	The dimensions of the vectors to be inserted into the vector index.
DistanceMetric	enum	yes	The distance metric to be used for similarity search.
EncryptionConfiguration?	object	no	The encryption configuration for the index.
IndexName?	string	no	The name of the vector index to create.
MetadataConfiguration?	object	no	The metadata configuration for the vector index.
VectorBucketArn?	string	no	The Amazon Resource Name (ARN) of the vector bucket.
VectorBucketName?	string	no	The name of the vector bucket that contains the vector index.
Tags?	array	no	User tags (key-value pairs) to associate with the index.

fn create()

Create a S3Vectors Index

fn get(identifier: string)

Get a S3Vectors Index

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the S3Vectors Index

fn update()

Update a S3Vectors Index

fn delete(identifier: string)

Delete a S3Vectors Index

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the S3Vectors Index

fn sync()

Sync S3Vectors Index state from AWS

fn list(maxPages?: number, resourceModel?: string)

List S3Vectors Index resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— S3Vectors Index resource state

@swamp/aws/s3vectors/vector-bucketv2026.10.23.1vector_bucket.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
VectorBucketName?	string	no	The name of the vector bucket.
EncryptionConfiguration?	object	no	The encryption configuration for the vector bucket.
Tags?	array	no	User tags (key-value pairs) to associate with the vector bucket.

fn create()

Create a S3Vectors VectorBucket

fn get(identifier: string)

Get a S3Vectors VectorBucket

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the S3Vectors VectorBucket

fn update()

Update a S3Vectors VectorBucket

fn delete(identifier: string)

Delete a S3Vectors VectorBucket

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the S3Vectors VectorBucket

fn sync()

Sync S3Vectors VectorBucket state from AWS

fn list(maxPages?: number, resourceModel?: string)

List S3Vectors VectorBucket resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— S3Vectors VectorBucket resource state

@swamp/aws/s3vectors/vector-bucket-policyv2026.10.23.1vector_bucket_policy.ts

Global Arguments

Argument	Type	Required	Description
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Policy	record	yes	A 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?	string	no	The Amazon Resource Name (ARN) of the vector bucket.
VectorBucketName?	string	no	The name of the vector bucket

fn create()

Create a S3Vectors VectorBucketPolicy

fn get(identifier: string)

Get a S3Vectors VectorBucketPolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the S3Vectors VectorBucketPolicy

fn update()

Update a S3Vectors VectorBucketPolicy

fn delete(identifier: string)

Delete a S3Vectors VectorBucketPolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the S3Vectors VectorBucketPolicy

fn sync()

Sync S3Vectors VectorBucketPolicy state from AWS

fn list(maxPages?: number, resourceModel?: string)

List S3Vectors VectorBucketPolicy resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— S3Vectors VectorBucketPolicy resource state

03Previous Versions19

2026.10.24.1AGPL-3.0-or-laterOct 24, 2026

2026.10.23.1AGPL-3.0-or-later(was none)Oct 24, 2026

Updated: index, vector_bucket, vector_bucket_policy

2026.10.13.1Oct 13, 2026

Updated: index, vector_bucket, vector_bucket_policy

2026.10.08.1Oct 8, 2026

2026.10.06.1Oct 6, 2026

2026.10.04.1Oct 4, 2026

2026.10.03.1Oct 3, 2026

2026.10.02.1Oct 2, 2026

2026.10.01.1Oct 1, 2026

2026.09.30.1Sep 30, 2026

2026.09.29.1Sep 29, 2026

2026.09.28.1Sep 28, 2026

2026.09.27.1Sep 27, 2026

2026.09.26.1Sep 26, 2026

2026.09.25.1Sep 25, 2026

2026.09.24.1Sep 24, 2026

2026.09.23.1Sep 23, 2026

2026.09.21.1Sep 21, 2026

2026.09.20.1Sep 20, 2026

04Stats

100 / 100

Downloads

117

Archive size

622.0 KB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Docs keep secrets in a vault1/1earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License2/2earned
Verified public repository2/2earned

Repository

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

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64 windows · x86_64

06Labels

#aws #s3vectors #cloud #infrastructure