Package software.amazon.awscdk.services.dynamodb

Interface CfnTable.VectorIndexProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTable.VectorIndexProperty.Jsii$Proxy

Enclosing class:

CfnTable

@Stability(Stable)
public static interface CfnTable.VectorIndexProperty
extends software.amazon.jsii.JsiiSerializable

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dynamodb.*;
 VectorIndexProperty vectorIndexProperty = VectorIndexProperty.builder()
         .dimensions(123)
         .distanceFunction("distanceFunction")
         .indexName("indexName")
         .projection(ProjectionProperty.builder()
                 .nonKeyAttributes(List.of("nonKeyAttributes"))
                 .projectionType("projectionType")
                 .build())
         .vectorAttribute(VectorAttributeProperty.builder()
                 .attributeName("attributeName")
                 .build())
         // the properties below are optional
         .searchSchema(List.of(SearchSchemaElementProperty.builder()
                 .attributeName("attributeName")
                 .searchSchemaElementType("searchSchemaElementType")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-vectorindex.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTable.VectorIndexProperty.Builder	A builder for CfnTable.VectorIndexProperty
static final class	CfnTable.VectorIndexProperty.Jsii$Proxy	An implementation for CfnTable.VectorIndexProperty

Method Summary

Modifier and Type	Method	Description
static CfnTable.VectorIndexProperty.Builder	builder()
Number	getDimensions()
String	getDistanceFunction()
String	getIndexName()
Object	getProjection()	Represents attributes that are copied (projected) from the table into an index.
default Object	getSearchSchema()	Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTable.SearchSchemaElementProperty>
Object	getVectorAttribute()	Returns union: either IResolvable or CfnTable.VectorAttributeProperty

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDimensions

@Stability(Stable)
@NotNull
Number getDimensions()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-vectorindex.html#cfn-dynamodb-table-vectorindex-dimensions

getDistanceFunction

@Stability(Stable)
@NotNull
String getDistanceFunction()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-vectorindex.html#cfn-dynamodb-table-vectorindex-distancefunction

getIndexName

@Stability(Stable)
@NotNull
String getIndexName()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-vectorindex.html#cfn-dynamodb-table-vectorindex-indexname

getProjection

@Stability(Stable)
@NotNull
Object getProjection()

Represents attributes that are copied (projected) from the table into an index.

These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Returns union: either IResolvable or CfnTable.ProjectionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-vectorindex.html#cfn-dynamodb-table-vectorindex-projection

getVectorAttribute

@Stability(Stable)
@NotNull
Object getVectorAttribute()

Returns union: either IResolvable or CfnTable.VectorAttributeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-vectorindex.html#cfn-dynamodb-table-vectorindex-vectorattribute

getSearchSchema

@Stability(Stable)
@Nullable
default Object getSearchSchema()

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTable.SearchSchemaElementProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-vectorindex.html#cfn-dynamodb-table-vectorindex-searchschema

builder

@Stability(Stable)
static CfnTable.VectorIndexProperty.Builder builder()

Returns:

a CfnTable.VectorIndexProperty.Builder of CfnTable.VectorIndexProperty