AWS Fundamentals Logo
AWS Fundamentals
AWS::S3Vectors::Index

S3Vectors Index

Resource Type definition for AWS::S3Vectors::Index

Properties

9 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
DataType
string
RequiredCreate-only
Dimension
integer
RequiredCreate-only
DistanceMetric
string
RequiredCreate-only
EncryptionConfiguration
EncryptionConfiguration
Create-only
IndexName
string
Create-only
MetadataConfiguration
MetadataConfiguration
Create-only
Tags
Array<Tag>
VectorBucketArn
string
Create-only
VectorBucketName
string
Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
CreationTimestring-
IndexArnstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::S3Vectors::Index

Resources:
  MyResource:
    Type: AWS::S3Vectors::Index
    Properties:
      DataType: "value"
      Dimension: "value"
      DistanceMetric: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

s3vectors:GetIndexs3vectors:CreateIndexs3vectors:TagResourcekms:GenerateDataKeykms:Decrypt

read

s3vectors:GetIndexs3vectors:ListTagsForResource

update

s3vectors:GetIndexs3vectors:TagResources3vectors:UntagResources3vectors:ListTagsForResource

delete

s3vectors:GetIndexs3vectors:DeleteIndex

list

s3vectors:ListIndexes

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

ServiceS3Vectors
Properties11
Required3
TaggingSupported
Primary IDIndexArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DataTypeDimensionDistanceMetricEncryptionConfigurationIndexNameMetadataConfigurationVectorBucketArnVectorBucketName

Related Resources

External Links