Package software.amazon.awscdk.services.s3vectors

Class CfnIndexProps.Builder

java.lang.Object

software.amazon.awscdk.services.s3vectors.CfnIndexProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIndexProps>

Enclosing interface:

CfnIndexProps

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

A builder for CfnIndexProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnIndexProps	build()	Builds the configured instance.
CfnIndexProps.Builder	dataType(String dataType)	Sets the value of CfnIndexProps.getDataType()
CfnIndexProps.Builder	dimension(Number dimension)	Sets the value of CfnIndexProps.getDimension()
CfnIndexProps.Builder	distanceMetric(String distanceMetric)	Sets the value of CfnIndexProps.getDistanceMetric()
CfnIndexProps.Builder	indexName(String indexName)	Sets the value of CfnIndexProps.getIndexName()
CfnIndexProps.Builder	metadataConfiguration(IResolvable metadataConfiguration)	Sets the value of CfnIndexProps.getMetadataConfiguration()
CfnIndexProps.Builder	metadataConfiguration(CfnIndex.MetadataConfigurationProperty metadataConfiguration)	Sets the value of CfnIndexProps.getMetadataConfiguration()
CfnIndexProps.Builder	vectorBucketArn(String vectorBucketArn)	Sets the value of CfnIndexProps.getVectorBucketArn()
CfnIndexProps.Builder	vectorBucketName(String vectorBucketName)	Sets the value of CfnIndexProps.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 CfnIndexProps.Builder dataType(String dataType)

Sets the value of CfnIndexProps.getDataType()

Parameters:

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

Returns:

this

dimension

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

Sets the value of CfnIndexProps.getDimension()

Parameters:

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

Returns:

this

distanceMetric

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

Sets the value of CfnIndexProps.getDistanceMetric()

Parameters:

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

Returns:

this

indexName

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

Sets the value of CfnIndexProps.getIndexName()

Parameters:

indexName - The name of the vector index to create.

Returns:

this

metadataConfiguration

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

Sets the value of CfnIndexProps.getMetadataConfiguration()

Parameters:

metadataConfiguration - The metadata configuration for the vector index.

Returns:

this

metadataConfiguration

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

Sets the value of CfnIndexProps.getMetadataConfiguration()

Parameters:

metadataConfiguration - The metadata configuration for the vector index.

Returns:

this

vectorBucketArn

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

Sets the value of CfnIndexProps.getVectorBucketArn()

Parameters:

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

Returns:

this

vectorBucketName

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

Sets the value of CfnIndexProps.getVectorBucketName()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnIndexProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnIndexProps

Throws:

NullPointerException - if any required attribute was not provided