Skip to content

InstanceProps

Properties for defining a Instance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-elasticsearch-instance

Initializer

using AlibabaCloud.SDK.ROS.CDK.Elasticsearch;
new InstanceProps {
    object DataNode,
    object Password,
    object Version,
    object VSwitchId,
    object Description = null,
    object EnableKibanaPrivate = null,
    object EnableKibanaPublic = null,
    object EnablePublic = null,
    object InstanceCategory = null,
    object InstanceChargeType = null,
    object KibanaNode = null,
    object KibanaWhitelist = null,
    object MasterNode = null,
    object Period = null,
    object PeriodUnit = null,
    object PrivateWhitelist = null,
    object PublicWhitelist = null,
    object ResourceGroupId = null,
    TagsProperty[] Tags = null,
    object YmlConfig = null,
    object ZoneCount = null,
    object ZoneId = null
};

Properties

Name Type Description
DataNode object Property dataNode: The Elasticsearch cluster's data node setting.
Password object Property password: The password of the instance.
Version object Property version: Elasticsearch version.
VSwitchId object Property vSwitchId: The ID of VSwitch.
Description object Property description: The description of instance.
EnableKibanaPrivate object Property enableKibanaPrivate: Enables or disables intranet access to Kibana.
EnableKibanaPublic object Property enableKibanaPublic: Enables or disables Internet access to Kibana.
EnablePublic object Property enablePublic: Whether enable public access.
InstanceCategory object Property instanceCategory: Version Type: - x-pack: Create a commercial instance or a kernel-enhanced instance without Indexing Service and OpenStore enabled.
InstanceChargeType object Property instanceChargeType: Valid values are PrePaid, PostPaid, Default to PostPaid.
KibanaNode object Property kibanaNode: The dedicated kibana node setting.
KibanaWhitelist object Property kibanaWhitelist: Set the Kibana's IP whitelist in internet network.
MasterNode object Property masterNode: The dedicated master node setting.
Period object Property period: The duration that you will buy Elasticsearch instance.
PeriodUnit object Property periodUnit: Unit of prepaid time period, it could be Month\/Year.
PrivateWhitelist object Property privateWhitelist: Set the instance's IP whitelist in VPC network.
PublicWhitelist object Property publicWhitelist: Set the instance's IP whitelist in Internet.
ResourceGroupId object Property resourceGroupId: The ID of the resource group.
Tags TagsProperty[] Property tags: Tags to attach to instance.
YmlConfig object Property ymlConfig: In the YML Configuration section of the Cluster Configuration page of your Alibaba Cloud Elasticsearch cluster, you can enable the Auto Indexing, Audit Log Indexing, or Watcher feature.
ZoneCount object Property zoneCount: undefined.
ZoneId object Property zoneId: The zone id of elasticsearch.

DataNodeRequired

public object DataNode { get; set; }
  • Type: object

Property dataNode: The Elasticsearch cluster's data node setting.


PasswordRequired

public object Password { get; set; }
  • Type: object

Property password: The password of the instance.

The password can be 8 to 32 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (!@#$%&*()_+-=).


VersionRequired

public object Version { get; set; }
  • Type: object

Property version: Elasticsearch version.

Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 7.4_with_X-Pack, 6.8, 7.4, 7.7 and so on.


VSwitchIdRequired

public object VSwitchId { get; set; }
  • Type: object

Property vSwitchId: The ID of VSwitch.


DescriptionOptional

public object Description { get; set; }
  • Type: object

Property description: The description of instance.

It a string of 0 to 30 characters. It can contain numbers, letters, underscores, (_) and hyphens (-). It must start with a letter, a number or Chinese character.


EnableKibanaPrivateOptional

public object EnableKibanaPrivate { get; set; }
  • Type: object

Property enableKibanaPrivate: Enables or disables intranet access to Kibana.


EnableKibanaPublicOptional

public object EnableKibanaPublic { get; set; }
  • Type: object

Property enableKibanaPublic: Enables or disables Internet access to Kibana.


EnablePublicOptional

public object EnablePublic { get; set; }
  • Type: object

Property enablePublic: Whether enable public access.

If properties is true, will allocate public address.Default: false.


InstanceCategoryOptional

public object InstanceCategory { get; set; }
  • Type: object

Property instanceCategory: Version Type: - x-pack: Create a commercial instance or a kernel-enhanced instance without Indexing Service and OpenStore enabled.

  • IS: Creates a kernel-enhanced instance with Indexing Service or OpenStore enabled

InstanceChargeTypeOptional

public object InstanceChargeType { get; set; }
  • Type: object

Property instanceChargeType: Valid values are PrePaid, PostPaid, Default to PostPaid.


KibanaNodeOptional

public object KibanaNode { get; set; }
  • Type: object

Property kibanaNode: The dedicated kibana node setting.


KibanaWhitelistOptional

public object KibanaWhitelist { get; set; }
  • Type: object

Property kibanaWhitelist: Set the Kibana's IP whitelist in internet network.


MasterNodeOptional

public object MasterNode { get; set; }
  • Type: object

Property masterNode: The dedicated master node setting.

If specified, dedicated master node will be created.


PeriodOptional

public object Period { get; set; }
  • Type: object

Property period: The duration that you will buy Elasticsearch instance.

It is valid when instance_charge_type is PrePaid. Unit is Month, it could be from 1 to 9 or 12, 24, 36, 48, 60. Unit is Year, it could be from 1 to 3. Default value is 1.


PeriodUnitOptional

public object PeriodUnit { get; set; }
  • Type: object

Property periodUnit: Unit of prepaid time period, it could be Month\/Year.

Default value is Month.


PrivateWhitelistOptional

public object PrivateWhitelist { get; set; }
  • Type: object

Property privateWhitelist: Set the instance's IP whitelist in VPC network.


PublicWhitelistOptional

public object PublicWhitelist { get; set; }
  • Type: object

Property publicWhitelist: Set the instance's IP whitelist in Internet.

The AllocatePublicAddress should be true.


ResourceGroupIdOptional

public object ResourceGroupId { get; set; }
  • Type: object

Property resourceGroupId: The ID of the resource group.


TagsOptional

public TagsProperty[] Tags { get; set; }

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.


YmlConfigOptional

public object YmlConfig { get; set; }
  • Type: object

Property ymlConfig: In the YML Configuration section of the Cluster Configuration page of your Alibaba Cloud Elasticsearch cluster, you can enable the Auto Indexing, Audit Log Indexing, or Watcher feature.


ZoneCountOptional

public object ZoneCount { get; set; }
  • Type: object

Property zoneCount: undefined.


ZoneIdOptional

public object ZoneId { get; set; }
  • Type: object

Property zoneId: The zone id of elasticsearch.