Package software.amazon.awscdk.services.s3vectors

Class CfnIndex.Builder

java.lang.Object

software.amazon.awscdk.services.s3vectors.CfnIndex.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIndex>

Enclosing class:

CfnIndex

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

A fluent builder for CfnIndex.

Method Summary

Modifier and Type	Method	Description
CfnIndex	build()
static CfnIndex.Builder	create(software.constructs.Construct scope, String id)
CfnIndex.Builder	dataType(String dataType)	The data type of the vectors to be inserted into the vector index.
CfnIndex.Builder	dimension(Number dimension)	The dimensions of the vectors to be inserted into the vector index.
CfnIndex.Builder	distanceMetric(String distanceMetric)	The distance metric to be used for similarity search.
CfnIndex.Builder	encryptionConfiguration(IResolvable encryptionConfiguration)	The encryption configuration for a vector index.
CfnIndex.Builder	encryptionConfiguration(CfnIndex.EncryptionConfigurationProperty encryptionConfiguration)	The encryption configuration for a vector index.
CfnIndex.Builder	indexName(String indexName)	The name of the vector index to create.
CfnIndex.Builder	metadataConfiguration(IResolvable metadataConfiguration)	The metadata configuration for the vector index.
CfnIndex.Builder	metadataConfiguration(CfnIndex.MetadataConfigurationProperty metadataConfiguration)	The metadata configuration for the vector index.
CfnIndex.Builder	vectorBucketArn(String vectorBucketArn)	The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
CfnIndex.Builder	vectorBucketName(String vectorBucketName)	The name of the vector bucket that contains the vector index.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnIndex.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnIndex.Builder.

dataType

@Stability(Stable)
public CfnIndex.Builder dataType(String 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.

Parameters:

dataType - The data type of the vectors to be inserted into the vector index. This parameter is required.

Returns:

this

See Also:

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

dimension

@Stability(Stable)
public CfnIndex.Builder dimension(Number 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.

Parameters:

dimension - The dimensions of the vectors to be inserted into the vector index. This parameter is required.

Returns:

this

See Also:

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

distanceMetric

@Stability(Stable)
public CfnIndex.Builder distanceMetric(String 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.

Parameters:

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

Returns:

this

See Also:

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

encryptionConfiguration

@Stability(Stable)
public CfnIndex.Builder encryptionConfiguration(IResolvable 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.

Parameters:

encryptionConfiguration - The encryption configuration for a vector index. This parameter is required.

Returns:

this

See Also:

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

encryptionConfiguration

@Stability(Stable)
public CfnIndex.Builder encryptionConfiguration(CfnIndex.EncryptionConfigurationProperty 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.

Parameters:

encryptionConfiguration - The encryption configuration for a vector index. This parameter is required.

Returns:

this

See Also:

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

indexName

@Stability(Stable)
public CfnIndex.Builder indexName(String 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.

Parameters:

indexName - The name of the vector index to create. This parameter is required.

Returns:

this

See Also:

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

metadataConfiguration

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

The metadata configuration for the vector index.

Parameters:

metadataConfiguration - The metadata configuration for the vector index. This parameter is required.

Returns:

this

See Also:

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

metadataConfiguration

@Stability(Stable)
public CfnIndex.Builder metadataConfiguration(CfnIndex.MetadataConfigurationProperty metadataConfiguration)

The metadata configuration for the vector index.

Parameters:

metadataConfiguration - The metadata configuration for the vector index. This parameter is required.

Returns:

this

See Also:

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

vectorBucketArn

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

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

Parameters:

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

Returns:

this

See Also:

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

vectorBucketName

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

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

Parameters:

vectorBucketName - The name of the vector bucket that contains the vector index. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnIndex build()

Specified by:

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

Returns:

a newly built instance of CfnIndex.