Class CfnIndex

An OpenSearch Serverless index resource.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnIndex
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.OpenSearchServerless
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIndex : CfnResource, IInspectable
Syntax (vb)
Public Class CfnIndex Inherits CfnResource Implements IInspectable
Remarks

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

CloudformationResource: AWS::OpenSearchServerless::Index

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 cfnIndex = new CfnIndex(this, "MyCfnIndex", 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

CfnIndex(Construct, string, ICfnIndexProps)

An OpenSearch Serverless index resource.

Properties

AttrUuid

The unique identifier for the index.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

An OpenSearch Serverless index resource.
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.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

An OpenSearch Serverless index resource.

Constructors

CfnIndex(Construct, string, ICfnIndexProps)

An OpenSearch Serverless index resource.

public CfnIndex(Construct scope, string id, ICfnIndexProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnIndexProps

Resource properties.

Remarks

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

CloudformationResource: AWS::OpenSearchServerless::Index

ExampleMetadata: fixture=_generated

Properties

AttrUuid

The unique identifier for the index.

public virtual string AttrUuid { get; }
Property Value

string

Remarks

CloudformationAttribute: Uuid

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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

CloudformationResource: AWS::OpenSearchServerless::Index

ExampleMetadata: fixture=_generated

CfnProperties

An OpenSearch Serverless index resource.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

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

CloudformationResource: AWS::OpenSearchServerless::Index

ExampleMetadata: fixture=_generated

CollectionEndpoint

The endpoint for the collection.

public virtual string CollectionEndpoint { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::OpenSearchServerless::Index

ExampleMetadata: fixture=_generated

IndexName

The name of the OpenSearch Serverless index.

public virtual string IndexName { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::OpenSearchServerless::Index

ExampleMetadata: fixture=_generated

Mappings

Index mappings for the OpenSearch Serverless index.

public virtual object? Mappings { get; set; }
Property Value

object

Remarks

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

CloudformationResource: AWS::OpenSearchServerless::Index

ExampleMetadata: fixture=_generated

Settings

Index settings for the OpenSearch Serverless index.

public virtual object? Settings { get; set; }
Property Value

object

Remarks

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

CloudformationResource: AWS::OpenSearchServerless::Index

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::OpenSearchServerless::Index

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

An OpenSearch Serverless index resource.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

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

CloudformationResource: AWS::OpenSearchServerless::Index

ExampleMetadata: fixture=_generated

Implements