Package software.amazon.awscdk.services.opensearchserverless

Interface CfnIndex.PropertyMappingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndex.PropertyMappingProperty.Jsii$Proxy

Enclosing class:

CfnIndex

@Stability(Stable)
public static interface CfnIndex.PropertyMappingProperty
extends software.amazon.jsii.JsiiSerializable

Property mappings for the OpenSearch Serverless index.

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.opensearchserverless.*;
 PropertyMappingProperty propertyMappingProperty_;
 PropertyMappingProperty propertyMappingProperty = PropertyMappingProperty.builder()
         .type("type")
         // the properties below are optional
         .dimension(123)
         .index(false)
         .method(MethodProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .engine("engine")
                 .parameters(ParametersProperty.builder()
                         .efConstruction(123)
                         .m(123)
                         .build())
                 .spaceType("spaceType")
                 .build())
         .properties(Map.of(
                 "propertiesKey", propertyMappingProperty_))
         .value("value")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIndex.PropertyMappingProperty.Builder	builder()
default Number	getDimension()	Dimension size for vector fields, defines the number of dimensions in the vector.
default Object	getIndex()	Whether a field should be indexed.
default Object	getMethod()	Configuration for k-NN search method.
default Object	getProperties()	Defines the fields within the mapping, including their types and configurations.
String	getType()	The field data type.
default String	getValue()	Default value for the field when not specified in a document.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

The field data type.

Must be a valid OpenSearch field type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-type

getDimension

@Stability(Stable)
@Nullable
default Number getDimension()

Dimension size for vector fields, defines the number of dimensions in the vector.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-dimension

getIndex

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

Whether a field should be indexed.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-index

getMethod

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

Configuration for k-NN search method.

Returns union: either IResolvable or CfnIndex.MethodProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-method

getProperties

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

Defines the fields within the mapping, including their types and configurations.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnIndex.PropertyMappingProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-properties

getValue

@Stability(Stable)
@Nullable
default String getValue()

Default value for the field when not specified in a document.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-value

builder

@Stability(Stable)
static CfnIndex.PropertyMappingProperty.Builder builder()

Returns:

a CfnIndex.PropertyMappingProperty.Builder of CfnIndex.PropertyMappingProperty