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

Class CfnIndexMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.s3vectors.CfnIndexMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIndexMixinProps>

Enclosing interface:

CfnIndexMixinProps

@Stability(Stable)
public static final class CfnIndexMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnIndexMixinProps>

A builder for CfnIndexMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnIndexMixinProps	build()	Builds the configured instance.
CfnIndexMixinProps.Builder	dataType(String dataType)	Sets the value of CfnIndexMixinProps.getDataType()
CfnIndexMixinProps.Builder	dimension(Number dimension)	Sets the value of CfnIndexMixinProps.getDimension()
CfnIndexMixinProps.Builder	distanceMetric(String distanceMetric)	Sets the value of CfnIndexMixinProps.getDistanceMetric()
CfnIndexMixinProps.Builder	encryptionConfiguration(CfnIndexPropsMixin.EncryptionConfigurationProperty encryptionConfiguration)	Sets the value of CfnIndexMixinProps.getEncryptionConfiguration()
CfnIndexMixinProps.Builder	encryptionConfiguration(IResolvable encryptionConfiguration)	Sets the value of CfnIndexMixinProps.getEncryptionConfiguration()
CfnIndexMixinProps.Builder	indexName(String indexName)	Sets the value of CfnIndexMixinProps.getIndexName()
CfnIndexMixinProps.Builder	metadataConfiguration(CfnIndexPropsMixin.MetadataConfigurationProperty metadataConfiguration)	Sets the value of CfnIndexMixinProps.getMetadataConfiguration()
CfnIndexMixinProps.Builder	metadataConfiguration(IResolvable metadataConfiguration)	Sets the value of CfnIndexMixinProps.getMetadataConfiguration()
CfnIndexMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnIndexMixinProps.getTags()
CfnIndexMixinProps.Builder	vectorBucketArn(String vectorBucketArn)	Sets the value of CfnIndexMixinProps.getVectorBucketArn()
CfnIndexMixinProps.Builder	vectorBucketName(String vectorBucketName)	Sets the value of CfnIndexMixinProps.getVectorBucketName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

dataType

@Stability(Stable)
public CfnIndexMixinProps.Builder dataType(String dataType)

Sets the value of CfnIndexMixinProps.getDataType()

Parameters:

dataType - The data type of the vectors to be inserted into the vector index. Currently, only float32 is supported, which represents 32-bit floating-point numbers.

Returns:

this

dimension

@Stability(Stable)
public CfnIndexMixinProps.Builder dimension(Number dimension)

Sets the value of CfnIndexMixinProps.getDimension()

Parameters:

dimension - The dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.

The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.

Returns:

this

distanceMetric

@Stability(Stable)
public CfnIndexMixinProps.Builder distanceMetric(String distanceMetric)

Sets the value of CfnIndexMixinProps.getDistanceMetric()

Parameters:

distanceMetric - The distance metric to be used for similarity search. Valid values are:.

• cosine - Measures the cosine of the angle between two vectors.
• euclidean - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity.

Returns:

this

encryptionConfiguration

@Stability(Stable)
public CfnIndexMixinProps.Builder encryptionConfiguration(IResolvable encryptionConfiguration)

Sets the value of CfnIndexMixinProps.getEncryptionConfiguration()

Parameters:

encryptionConfiguration - The encryption configuration for a vector index. By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.

Returns:

this

encryptionConfiguration

@Stability(Stable)
public CfnIndexMixinProps.Builder encryptionConfiguration(CfnIndexPropsMixin.EncryptionConfigurationProperty encryptionConfiguration)

Sets the value of CfnIndexMixinProps.getEncryptionConfiguration()

Parameters:

encryptionConfiguration - The encryption configuration for a vector index. By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.

Returns:

this

indexName

@Stability(Stable)
public CfnIndexMixinProps.Builder indexName(String indexName)

Sets the value of CfnIndexMixinProps.getIndexName()

Parameters:

indexName - The name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.

If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.

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.

Returns:

this

metadataConfiguration

@Stability(Stable)
public CfnIndexMixinProps.Builder metadataConfiguration(IResolvable metadataConfiguration)

Sets the value of CfnIndexMixinProps.getMetadataConfiguration()

Parameters:

metadataConfiguration - The metadata configuration for the vector index.

Returns:

this

metadataConfiguration

@Stability(Stable)
public CfnIndexMixinProps.Builder metadataConfiguration(CfnIndexPropsMixin.MetadataConfigurationProperty metadataConfiguration)

Sets the value of CfnIndexMixinProps.getMetadataConfiguration()

Parameters:

metadataConfiguration - The metadata configuration for the vector index.

Returns:

this

tags

@Stability(Stable)
public CfnIndexMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnIndexMixinProps.getTags()

Parameters:

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

Returns:

this

vectorBucketArn

@Stability(Stable)
public CfnIndexMixinProps.Builder vectorBucketArn(String vectorBucketArn)

Sets the value of CfnIndexMixinProps.getVectorBucketArn()

Parameters:

vectorBucketArn - The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.

Returns:

this

vectorBucketName

@Stability(Stable)
public CfnIndexMixinProps.Builder vectorBucketName(String vectorBucketName)

Sets the value of CfnIndexMixinProps.getVectorBucketName()

Parameters:

vectorBucketName - The name of the vector bucket that contains the vector index.

Returns:

this

build

@Stability(Stable)
public CfnIndexMixinProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnIndexMixinProps>

Returns:

a new instance of CfnIndexMixinProps

Throws:

NullPointerException - if any required attribute was not provided