Class CfnCollectionProps
Properties for defining a CfnCollection
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.OpenSearchServerless
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCollectionProps : Object, ICfnCollectionProps
Syntax (vb)
Public Class CfnCollectionProps
Inherits Object
Implements ICfnCollectionProps
Remarks
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;
var cfnCollectionProps = new CfnCollectionProps {
Name = "name",
// the properties below are optional
Description = "description",
StandbyReplicas = "standbyReplicas",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Type = "type"
};
Synopsis
Constructors
CfnCollectionProps() |
Properties
Description | A description of the collection. |
Name | The name of the collection. |
StandbyReplicas | Indicates whether to use standby replicas for the collection. |
Tags | An arbitrary set of tags (key–value pairs) to associate with the collection. |
Type | The type of collection. |
Constructors
CfnCollectionProps()
public CfnCollectionProps()
Properties
Description
A description of the collection.
public string Description { get; set; }
Property Value
System.String
Remarks
Name
The name of the collection.
public string Name { get; set; }
Property Value
System.String
Remarks
Collection names must meet the following criteria:
StandbyReplicas
Indicates whether to use standby replicas for the collection.
public string StandbyReplicas { get; set; }
Property Value
System.String
Remarks
You can't update this property after the collection is already created. If you attempt to modify this property, the collection continues to use the original value.
Tags
An arbitrary set of tags (key–value pairs) to associate with the collection.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
Type
The type of collection.
public string Type { get; set; }
Property Value
System.String
Remarks
Possible values are SEARCH
, TIMESERIES
, and VECTORSEARCH
. For more information, see Choosing a collection type .