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

Class CfnIndexMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.s3vectors.CfnIndexMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnIndexMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnIndexMixinProps

@Stability(Stable)
@Internal
public static final class CfnIndexMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnIndexMixinProps

An implementation for CfnIndexMixinProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.s3vectors.CfnIndexMixinProps

CfnIndexMixinProps.Builder, CfnIndexMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnIndexMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnIndexMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getDataType()	The data type of the vectors to be inserted into the vector index.
final Number	getDimension()	The dimensions of the vectors to be inserted into the vector index.
final String	getDistanceMetric()	The distance metric to be used for similarity search.
final Object	getEncryptionConfiguration()	The encryption configuration for a vector index.
final String	getIndexName()	The name of the vector index to create.
final Object	getMetadataConfiguration()	The metadata configuration for the vector index.
final List<CfnTag>	getTags()	User tags (key-value pairs) to associate with the index.
final String	getVectorBucketArn()	The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
final String	getVectorBucketName()	The name of the vector bucket that contains the vector index.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnIndexMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnIndexMixinProps.Builder.

Method Details

getDataType

public final String getDataType()

Description copied from interface: CfnIndexMixinProps

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.

Specified by:

getDataType in interface CfnIndexMixinProps

See Also:

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

getDimension

public final Number getDimension()

Description copied from interface: CfnIndexMixinProps

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.

Specified by:

getDimension in interface CfnIndexMixinProps

See Also:

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

getDistanceMetric

public final String getDistanceMetric()

Description copied from interface: CfnIndexMixinProps

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.

Specified by:

getDistanceMetric in interface CfnIndexMixinProps

See Also:

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

getEncryptionConfiguration

public final Object getEncryptionConfiguration()

Description copied from interface: CfnIndexMixinProps

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 union: either IResolvable or CfnIndexPropsMixin.EncryptionConfigurationProperty

Specified by:

getEncryptionConfiguration in interface CfnIndexMixinProps

See Also:

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

getIndexName

public final String getIndexName()

Description copied from interface: CfnIndexMixinProps

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.

Specified by:

getIndexName in interface CfnIndexMixinProps

See Also:

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

getMetadataConfiguration

public final Object getMetadataConfiguration()

Description copied from interface: CfnIndexMixinProps

The metadata configuration for the vector index.

Returns union: either IResolvable or CfnIndexPropsMixin.MetadataConfigurationProperty

Specified by:

getMetadataConfiguration in interface CfnIndexMixinProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnIndexMixinProps

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

Specified by:

getTags in interface CfnIndexMixinProps

See Also:

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

getVectorBucketArn

public final String getVectorBucketArn()

Description copied from interface: CfnIndexMixinProps

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

Specified by:

getVectorBucketArn in interface CfnIndexMixinProps

See Also:

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

getVectorBucketName

public final String getVectorBucketName()

Description copied from interface: CfnIndexMixinProps

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

Specified by:

getVectorBucketName in interface CfnIndexMixinProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object