Package software.amazon.awscdk.cfnpropertymixins.services.s3vectors

Interface CfnVectorBucketMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVectorBucketMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:04.850Z")
@Stability(Stable)
public interface CfnVectorBucketMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnVectorBucketPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.s3vectors.*;
 CfnVectorBucketMixinProps cfnVectorBucketMixinProps = CfnVectorBucketMixinProps.builder()
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .sseType("sseType")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vectorBucketName("vectorBucketName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVectorBucketMixinProps.Builder	A builder for CfnVectorBucketMixinProps
static final class	CfnVectorBucketMixinProps.Jsii$Proxy	An implementation for CfnVectorBucketMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnVectorBucketMixinProps.Builder	builder()
default Object	getEncryptionConfiguration()	The encryption configuration for the vector bucket.
default List<CfnTag>	getTags()	User tags (key-value pairs) to associate with the vector bucket.
default String	getVectorBucketName()	A name for the vector bucket.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getEncryptionConfiguration()

The encryption configuration for the vector bucket.

Returns union: either IResolvable or CfnVectorBucketPropsMixin.EncryptionConfigurationProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

User tags (key-value pairs) to associate with the vector bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucket.html#cfn-s3vectors-vectorbucket-tags

getVectorBucketName

@Stability(Stable)
@Nullable
default String getVectorBucketName()

A name for the vector bucket.

The bucket name must contain only lowercase letters, numbers, and hyphens (-). The bucket name must be unique in the same AWS account for each AWS Region. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name.

The bucket name must be between 3 and 63 characters long and must not contain uppercase characters or underscores.

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3vectors-vectorbucket.html#cfn-s3vectors-vectorbucket-vectorbucketname

builder

@Stability(Stable)
static CfnVectorBucketMixinProps.Builder builder()

Returns:

a CfnVectorBucketMixinProps.Builder of CfnVectorBucketMixinProps