Class CfnIndexProps

Properties for defining a CfnIndex.

Inheritance

object

CfnIndexProps

Implements

ICfnIndexProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.OpenSearchServerless

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnIndexProps : ICfnIndexProps

Syntax (vb)

Public Class CfnIndexProps Implements ICfnIndexProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.OpenSearchServerless;

             PropertyMappingProperty propertyMappingProperty_;

             var cfnIndexProps = new CfnIndexProps {
                 CollectionEndpoint = "collectionEndpoint",
                 IndexName = "indexName",

                 // the properties below are optional
                 Mappings = new MappingsProperty {
                     Properties = new Dictionary<string, object> {
                         { "propertiesKey", new PropertyMappingProperty {
                             Type = "type",

                             // the properties below are optional
                             Dimension = 123,
                             Index = false,
                             Method = new MethodProperty {
                                 Engine = "engine",
                                 Name = "name",

                                 // the properties below are optional
                                 Parameters = new ParametersProperty {
                                     EfConstruction = 123,
                                     M = 123
                                 },
                                 SpaceType = "spaceType"
                             },
                             Properties = new Dictionary<string, object> {
                                 { "propertiesKey", propertyMappingProperty_ }
                             },
                             Value = "value"
                         } }
                     }
                 },
                 Settings = new IndexSettingsProperty {
                     Index = new IndexProperty {
                         Knn = false,
                         KnnAlgoParamEfSearch = 123,
                         RefreshInterval = "refreshInterval"
                     }
                 }
             };

Synopsis

Constructors

CfnIndexProps()

Properties for defining a CfnIndex.

Properties

CollectionEndpoint	The endpoint for the collection.
IndexName	The name of the OpenSearch Serverless index.
Mappings	Index mappings for the OpenSearch Serverless index.
Settings	Index settings for the OpenSearch Serverless index.

Constructors

CfnIndexProps()

Properties for defining a CfnIndex.

public CfnIndexProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.OpenSearchServerless;

             PropertyMappingProperty propertyMappingProperty_;

             var cfnIndexProps = new CfnIndexProps {
                 CollectionEndpoint = "collectionEndpoint",
                 IndexName = "indexName",

                 // the properties below are optional
                 Mappings = new MappingsProperty {
                     Properties = new Dictionary<string, object> {
                         { "propertiesKey", new PropertyMappingProperty {
                             Type = "type",

                             // the properties below are optional
                             Dimension = 123,
                             Index = false,
                             Method = new MethodProperty {
                                 Engine = "engine",
                                 Name = "name",

                                 // the properties below are optional
                                 Parameters = new ParametersProperty {
                                     EfConstruction = 123,
                                     M = 123
                                 },
                                 SpaceType = "spaceType"
                             },
                             Properties = new Dictionary<string, object> {
                                 { "propertiesKey", propertyMappingProperty_ }
                             },
                             Value = "value"
                         } }
                     }
                 },
                 Settings = new IndexSettingsProperty {
                     Index = new IndexProperty {
                         Knn = false,
                         KnnAlgoParamEfSearch = 123,
                         RefreshInterval = "refreshInterval"
                     }
                 }
             };

Properties

CollectionEndpoint

The endpoint for the collection.

public string CollectionEndpoint { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#cfn-opensearchserverless-index-collectionendpoint

IndexName

The name of the OpenSearch Serverless index.

public string IndexName { get; set; }

Property Value

string

Remarks

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

Mappings

Index mappings for the OpenSearch Serverless index.

public object? Mappings { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#cfn-opensearchserverless-index-mappings

Settings

Index settings for the OpenSearch Serverless index.

public object? Settings { get; set; }