Class CapacityConfig
Configures the capacity of the cluster such as the instance type and the number of instances.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.OpenSearchService
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CapacityConfig : Object, ICapacityConfig
Syntax (vb)
Public Class CapacityConfig
Inherits Object
Implements ICapacityConfig
Remarks
ExampleMetadata: infused
Examples
var domain = new Domain(this, "Domain", new DomainProps {
Version = EngineVersion.OPENSEARCH_1_0,
Capacity = new CapacityConfig {
MasterNodes = 2,
WarmNodes = 2,
WarmInstanceType = "ultrawarm1.medium.search"
},
ColdStorageEnabled = true
});
Synopsis
Constructors
CapacityConfig() |
Properties
DataNodeInstanceType | The instance type for your data nodes, such as |
DataNodes | The number of data nodes (instances) to use in the Amazon OpenSearch Service domain. |
MasterNodeInstanceType | The hardware configuration of the computer that hosts the dedicated master node, such as |
MasterNodes | The number of instances to use for the master node. |
MultiAzWithStandbyEnabled | Indicates whether Multi-AZ with Standby deployment option is enabled. |
WarmInstanceType | The instance type for your UltraWarm node, such as |
WarmNodes | The number of UltraWarm nodes (instances) to use in the Amazon OpenSearch Service domain. |
Constructors
CapacityConfig()
public CapacityConfig()
Properties
DataNodeInstanceType
The instance type for your data nodes, such as m3.medium.search
. For valid values, see Supported Instance Types in the Amazon OpenSearch Service Developer Guide.
public string DataNodeInstanceType { get; set; }
Property Value
System.String
Remarks
Default: - r5.large.search
DataNodes
The number of data nodes (instances) to use in the Amazon OpenSearch Service domain.
public Nullable<double> DataNodes { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - 1
MasterNodeInstanceType
The hardware configuration of the computer that hosts the dedicated master node, such as m3.medium.search
. For valid values, see Supported Instance Types in the Amazon OpenSearch Service Developer Guide.
public string MasterNodeInstanceType { get; set; }
Property Value
System.String
Remarks
Default: - r5.large.search
MasterNodes
The number of instances to use for the master node.
public Nullable<double> MasterNodes { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - no dedicated master nodes
MultiAzWithStandbyEnabled
Indicates whether Multi-AZ with Standby deployment option is enabled.
public Nullable<bool> MultiAzWithStandbyEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
For more information, see Multi-AZ with Standby
Default: - multi-az with standby if the feature flag ENABLE_OPENSEARCH_MULTIAZ_WITH_STANDBY
is true, no multi-az with standby otherwise
WarmInstanceType
The instance type for your UltraWarm node, such as ultrawarm1.medium.search
. For valid values, see UltraWarm Storage Limits in the Amazon OpenSearch Service Developer Guide.
public string WarmInstanceType { get; set; }
Property Value
System.String
Remarks
Default: - ultrawarm1.medium.search
WarmNodes
The number of UltraWarm nodes (instances) to use in the Amazon OpenSearch Service domain.
public Nullable<double> WarmNodes { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - no UltraWarm nodes