CfnVectorBucketPropsMixin

class aws_cdk.mixins_preview.aws_s3vectors.mixins.CfnVectorBucketPropsMixin(props, *, strategy=None)

Bases: 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 . .. epigraph:

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucket.html
CloudformationResource:: AWS::S3Vectors::VectorBucket
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_s3vectors import mixins as s3vectors_mixins

cfn_vector_bucket_props_mixin = s3vectors_mixins.CfnVectorBucketPropsMixin(s3vectors_mixins.CfnVectorBucketMixinProps(
    encryption_configuration=s3vectors_mixins.CfnVectorBucketPropsMixin.EncryptionConfigurationProperty(
        kms_key_arn="kmsKeyArn",
        sse_type="sseType"
    ),
    vector_bucket_name="vectorBucketName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnVectorBucketMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['encryptionConfiguration', 'vectorBucketName']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

EncryptionConfigurationProperty

class CfnVectorBucketPropsMixin.EncryptionConfigurationProperty(*, kms_key_arn=None, sse_type=None)

Bases: object

Specifies the encryption configuration for the vector bucket.

By default, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.

Parameters:

kms_key_arn (Optional[str]) – AWS Key Management Service (KMS) customer managed key ARN to use for the encryption configuration. This parameter is required if and only if SseType is set to aws:kms . You must specify the full ARN of the KMS key. Key IDs or key aliases aren’t supported. .. epigraph:: Amazon S3 Vectors only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in AWS KMS in the AWS Key Management Service Developer Guide .
sse_type (Optional[str]) – The server-side encryption type to use for the encryption configuration of the vector bucket. Valid values are AES256 for Amazon S3 managed keys and aws:kms for AWS KMS keys. Default: - “AES256”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-vectorbucket-encryptionconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3vectors import mixins as s3vectors_mixins

encryption_configuration_property = s3vectors_mixins.CfnVectorBucketPropsMixin.EncryptionConfigurationProperty(
    kms_key_arn="kmsKeyArn",
    sse_type="sseType"
)

Attributes

kms_key_arn

AWS Key Management Service (KMS) customer managed key ARN to use for the encryption configuration.

This parameter is required if and only if SseType is set to aws:kms .

You must specify the full ARN of the KMS key. Key IDs or key aliases aren’t supported. .. epigraph:

Amazon S3 Vectors only supports symmetric encryption KMS keys. For more information, see `Asymmetric keys in AWS KMS <https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html>`_ in the *AWS Key Management Service Developer Guide* .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-vectorbucket-encryptionconfiguration.html#cfn-s3vectors-vectorbucket-encryptionconfiguration-kmskeyarn

sse_type

The server-side encryption type to use for the encryption configuration of the vector bucket.

Valid values are AES256 for Amazon S3 managed keys and aws:kms for AWS KMS keys.

Default:

“AES256”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3vectors-vectorbucket-encryptionconfiguration.html#cfn-s3vectors-vectorbucket-encryptionconfiguration-ssetype