class CfnVectorBucketPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.S3Vectors.Mixins.CfnVectorBucketPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awss3vectors/mixins#CfnVectorBucketPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.s3vectors.mixins.CfnVectorBucketPropsMixin
Python	aws_cdk.mixins_preview.aws_s3vectors.mixins.CfnVectorBucketPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_s3vectors » mixins » CfnVectorBucketPropsMixin

Implements IMixin

Extends Mixin

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

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)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucket.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as s3vectors_mixins } from '@aws-cdk/mixins-preview/aws-s3vectors';
const cfnVectorBucketPropsMixin = new s3vectors_mixins.CfnVectorBucketPropsMixin({
  encryptionConfiguration: {
    kmsKeyArn: 'kmsKeyArn',
    sseType: 'sseType',
  },
  vectorBucketName: 'vectorBucketName',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnVectorBucketPropsMixin(props: CfnVectorBucketMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnVectorBucketMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::S3Vectors::VectorBucket.

Properties

Name	Type	Description
props	CfnVectorBucketMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnVectorBucketMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.