Interface CreateIndexRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>, S3VectorsRequest.Builder, SdkBuilder<CreateIndexRequest.Builder,CreateIndexRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateIndexRequest

@Mutable
@NotThreadSafe
public static interface CreateIndexRequest.Builder
extends S3VectorsRequest.Builder, SdkPojo, CopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

Method Summary

Modifier and Type	Method	Description
CreateIndexRequest.Builder	dataType(String dataType)	The data type of the vectors to be inserted into the vector index.
CreateIndexRequest.Builder	dataType(DataType dataType)	The data type of the vectors to be inserted into the vector index.
CreateIndexRequest.Builder	dimension(Integer dimension)	The dimensions of the vectors to be inserted into the vector index.
CreateIndexRequest.Builder	distanceMetric(String distanceMetric)	The distance metric to be used for similarity search.
CreateIndexRequest.Builder	distanceMetric(DistanceMetric distanceMetric)	The distance metric to be used for similarity search.
default CreateIndexRequest.Builder	encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)	The encryption configuration for a vector index.
CreateIndexRequest.Builder	encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)	The encryption configuration for a vector index.
CreateIndexRequest.Builder	indexName(String indexName)	The name of the vector index to create.
default CreateIndexRequest.Builder	metadataConfiguration(Consumer<MetadataConfiguration.Builder> metadataConfiguration)	The metadata configuration for the vector index.
CreateIndexRequest.Builder	metadataConfiguration(MetadataConfiguration metadataConfiguration)	The metadata configuration for the vector index.
CreateIndexRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateIndexRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateIndexRequest.Builder	tags(Map<String,String> tags)	An array of user-defined tags that you would like to apply to the vector index that you are creating.
CreateIndexRequest.Builder	vectorBucketArn(String vectorBucketArn)	The Amazon Resource Name (ARN) of the vector bucket to create the vector index in.
CreateIndexRequest.Builder	vectorBucketName(String vectorBucketName)	The name of the vector bucket to create the vector index in.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.s3vectors.model.S3VectorsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

vectorBucketName

CreateIndexRequest.Builder vectorBucketName(String vectorBucketName)

The name of the vector bucket to create the vector index in.

Parameters:

vectorBucketName - The name of the vector bucket to create the vector index in.

Returns:

Returns a reference to this object so that method calls can be chained together.

vectorBucketArn

CreateIndexRequest.Builder vectorBucketArn(String vectorBucketArn)

The Amazon Resource Name (ARN) of the vector bucket to create the vector index in.

Parameters:

vectorBucketArn - The Amazon Resource Name (ARN) of the vector bucket to create the vector index in.

Returns:

Returns a reference to this object so that method calls can be chained together.

indexName

CreateIndexRequest.Builder indexName(String indexName)

The name of the vector index to create.

Parameters:

indexName - The name of the vector index to create.

Returns:

Returns a reference to this object so that method calls can be chained together.

dataType

CreateIndexRequest.Builder dataType(String dataType)

The data type of the vectors to be inserted into the vector index.

Parameters:

dataType - The data type of the vectors to be inserted into the vector index.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• DataType
• DataType

dataType

CreateIndexRequest.Builder dataType(DataType dataType)

The data type of the vectors to be inserted into the vector index.

Parameters:

dataType - The data type of the vectors to be inserted into the vector index.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• DataType
• DataType

dimension

CreateIndexRequest.Builder dimension(Integer dimension)

The dimensions of the vectors to be inserted into the vector index.

Parameters:

dimension - The dimensions of the vectors to be inserted into the vector index.

Returns:

Returns a reference to this object so that method calls can be chained together.

distanceMetric

CreateIndexRequest.Builder distanceMetric(String distanceMetric)

The distance metric to be used for similarity search.

Parameters:

distanceMetric - The distance metric to be used for similarity search.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• DistanceMetric
• DistanceMetric

distanceMetric

CreateIndexRequest.Builder distanceMetric(DistanceMetric distanceMetric)

The distance metric to be used for similarity search.

Parameters:

distanceMetric - The distance metric to be used for similarity search.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• DistanceMetric
• DistanceMetric

metadataConfiguration

CreateIndexRequest.Builder metadataConfiguration(MetadataConfiguration metadataConfiguration)

The metadata configuration for the vector index.

Parameters:

metadataConfiguration - The metadata configuration for the vector index.

Returns:

Returns a reference to this object so that method calls can be chained together.

metadataConfiguration

default CreateIndexRequest.Builder metadataConfiguration(Consumer<MetadataConfiguration.Builder> metadataConfiguration)

The metadata configuration for the vector index.

This is a convenience method that creates an instance of the MetadataConfiguration.Builder avoiding the need to create one manually via MetadataConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metadataConfiguration(MetadataConfiguration).

Parameters:

metadataConfiguration - a consumer that will call methods on MetadataConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• metadataConfiguration(MetadataConfiguration)

encryptionConfiguration

CreateIndexRequest.Builder encryptionConfiguration(EncryptionConfiguration 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. By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionConfiguration

default CreateIndexRequest.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> 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.

This is a convenience method that creates an instance of the EncryptionConfiguration.Builder avoiding the need to create one manually via EncryptionConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionConfiguration(EncryptionConfiguration).

Parameters:

encryptionConfiguration - a consumer that will call methods on EncryptionConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• encryptionConfiguration(EncryptionConfiguration)

tags

CreateIndexRequest.Builder tags(Map<String,String> tags)

An array of user-defined tags that you would like to apply to the vector index that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs, and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).

You must have the s3vectors:TagResource permission in addition to s3vectors:CreateIndex permission to create a vector index with tags.

Parameters:

tags - An array of user-defined tags that you would like to apply to the vector index that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs, and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).

You must have the s3vectors:TagResource permission in addition to s3vectors:CreateIndex permission to create a vector index with tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateIndexRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateIndexRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.