Class CfnIndex

An OpenSearch Serverless index resource.

Inheritance
System.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(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnIndex(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnIndex(Construct, String, ICfnIndexProps)

Properties

AttrUuid

The unique identifier for the index.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
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>)

Constructors

CfnIndex(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnIndex(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnIndex(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnIndex(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnIndex(Construct, String, ICfnIndexProps)

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

Scope in which this resource is defined.

id System.String

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

props ICfnIndexProps

Resource properties.

Properties

AttrUuid

The unique identifier for the index.

public virtual string AttrUuid { get; }
Property Value

System.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

System.String

CfnProperties

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

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CollectionEndpoint

The endpoint for the collection.

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

System.String

IndexName

The name of the OpenSearch Serverless index.

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

System.String

Mappings

Index mappings for the OpenSearch Serverless index.

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

System.Object

Settings

Index settings for the OpenSearch Serverless index.

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

System.Object

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.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements