Package software.amazon.awscdk.cfnpropertymixins.services.dynamodb

Interface CfnTablePropsMixin.VectorIndexProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTablePropsMixin.VectorIndexProperty.Jsii$Proxy

Enclosing class:

CfnTablePropsMixin

@Stability(Stable)
public static interface CfnTablePropsMixin.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.cfnpropertymixins.services.dynamodb.*;
 VectorIndexProperty vectorIndexProperty = VectorIndexProperty.builder()
         .dimensions(123)
         .distanceFunction("distanceFunction")
         .indexName("indexName")
         .projection(ProjectionProperty.builder()
                 .nonKeyAttributes(List.of("nonKeyAttributes"))
                 .projectionType("projectionType")
                 .build())
         .searchSchema(List.of(SearchSchemaElementProperty.builder()
                 .attributeName("attributeName")
                 .searchSchemaElementType("searchSchemaElementType")
                 .build()))
         .vectorAttribute(VectorAttributeProperty.builder()
                 .attributeName("attributeName")
                 .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	CfnTablePropsMixin.VectorIndexProperty.Builder	A builder for CfnTablePropsMixin.VectorIndexProperty
static final class	CfnTablePropsMixin.VectorIndexProperty.Jsii$Proxy	An implementation for CfnTablePropsMixin.VectorIndexProperty

Method Summary

Modifier and Type	Method	Description
static CfnTablePropsMixin.VectorIndexProperty.Builder	builder()
default Number	getDimensions()
default String	getDistanceFunction()
default String	getIndexName()
default 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 CfnTablePropsMixin.SearchSchemaElementProperty>
default Object	getVectorAttribute()	Returns union: either IResolvable or CfnTablePropsMixin.VectorAttributeProperty

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDimensions

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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 CfnTablePropsMixin.ProjectionProperty

See Also:

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

getSearchSchema

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

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

See Also:

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

getVectorAttribute

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

Returns union: either IResolvable or CfnTablePropsMixin.VectorAttributeProperty

See Also:

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

builder

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

Returns:

a CfnTablePropsMixin.VectorIndexProperty.Builder of CfnTablePropsMixin.VectorIndexProperty