# AWS::S3Vectors Construct Library

---

![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)

> All classes with the `Cfn` prefix in this module ([CFN Resources]) are always stable and safe to use.
>
> [CFN Resources]: https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib

---

This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

```ts
import * as s3vectors from 'aws-cdk-lib/aws-s3vectors';
```

There are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:

- Search [Construct Hub for S3Vectors construct libraries](https://constructs.dev/search?q=s3vectors)
- Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::S3Vectors resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_S3Vectors.html) directly.

There are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet.
However, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the [CloudFormation documentation for AWS::S3Vectors](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_S3Vectors.html).

(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)

## Types

| Name | Kind | Summary |
| --- | --- | --- |
| [`CfnIndex`](/v2/docs/aws-cdk-lib.aws_s3vectors.CfnIndex) | Construct (L1) | The `AWS::S3Vectors::Index` resource defines a vector index within an Amazon S3 vector bucket. |
| [`CfnVectorBucket`](/v2/docs/aws-cdk-lib.aws_s3vectors.CfnVectorBucket) | Construct (L1) | Defines an Amazon S3 vector bucket in the same AWS Region where you create the AWS CloudFormation stack. |
| [`CfnVectorBucketPolicy`](/v2/docs/aws-cdk-lib.aws_s3vectors.CfnVectorBucketPolicy) | Construct (L1) | The `AWS::S3Vectors::VectorBucketPolicy` resource defines an Amazon S3 vector bucket policy to control access to an Amazon S3 vector bucket. |
| [`CfnIndex.EncryptionConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_s3vectors.CfnIndex.EncryptionConfigurationProperty) | Struct | The encryption configuration for a vector bucket or index. |
| [`CfnIndex.MetadataConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_s3vectors.CfnIndex.MetadataConfigurationProperty) | Struct | The metadata configuration for the vector index. |
| [`CfnIndexProps`](/v2/docs/aws-cdk-lib.aws_s3vectors.CfnIndexProps) | Struct | Properties for defining a `CfnIndex`. |
| [`CfnVectorBucket.EncryptionConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_s3vectors.CfnVectorBucket.EncryptionConfigurationProperty) | Struct | Specifies the encryption configuration for the vector bucket. |
| [`CfnVectorBucketPolicyProps`](/v2/docs/aws-cdk-lib.aws_s3vectors.CfnVectorBucketPolicyProps) | Struct | Properties for defining a `CfnVectorBucketPolicy`. |
| [`CfnVectorBucketProps`](/v2/docs/aws-cdk-lib.aws_s3vectors.CfnVectorBucketProps) | Struct | Properties for defining a `CfnVectorBucket`. |