Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer 

import { InstanceProps } from '@alicloud/ros-cdk-elasticsearch'
const instanceProps: InstanceProps = { ... }

Properties

Name Type Description
dataNode DataNodeProperty | @alicloud/ros-cdk-core.IResolvable Property dataNode: The Elasticsearch cluster's data node setting.
password string | @alicloud/ros-cdk-core.IResolvable Property password: The password of the instance.
version string | @alicloud/ros-cdk-core.IResolvable Property version: Elasticsearch version.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The ID of VSwitch.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of instance.
enableKibanaPrivate boolean | @alicloud/ros-cdk-core.IResolvable Property enableKibanaPrivate: Enables or disables intranet access to Kibana.
enableKibanaPublic boolean | @alicloud/ros-cdk-core.IResolvable Property enableKibanaPublic: Enables or disables Internet access to Kibana.
enablePublic boolean | @alicloud/ros-cdk-core.IResolvable Property enablePublic: Whether enable public access.
instanceCategory string | @alicloud/ros-cdk-core.IResolvable Property instanceCategory: Version Type: - x-pack: Create a commercial instance or a kernel-enhanced instance without Indexing Service and OpenStore enabled.
instanceChargeType string | @alicloud/ros-cdk-core.IResolvable Property instanceChargeType: Valid values are PrePaid, PostPaid, Default to PostPaid.
kibanaNode @alicloud/ros-cdk-core.IResolvable | KibanaNodeProperty Property kibanaNode: The dedicated kibana node setting.
kibanaWhitelist any[] | @alicloud/ros-cdk-core.IResolvable Property kibanaWhitelist: Set the Kibana's IP whitelist in internet network.
masterNode @alicloud/ros-cdk-core.IResolvable | MasterNodeProperty Property masterNode: The dedicated master node setting.
period number | @alicloud/ros-cdk-core.IResolvable Property period: The duration that you will buy Elasticsearch instance.
periodUnit string | @alicloud/ros-cdk-core.IResolvable Property periodUnit: Unit of prepaid time period, it could be Month\/Year.
privateWhitelist any[] | @alicloud/ros-cdk-core.IResolvable Property privateWhitelist: Set the instance's IP whitelist in VPC network.
publicWhitelist any[] | @alicloud/ros-cdk-core.IResolvable Property publicWhitelist: Set the instance's IP whitelist in Internet.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
tags TagsProperty[] Property tags: Tags to attach to instance.
ymlConfig @alicloud/ros-cdk-core.IResolvable | YMLConfigProperty 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 number | @alicloud/ros-cdk-core.IResolvable Property zoneCount: undefined.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The zone id of elasticsearch.

dataNodeRequired 

public readonly dataNode: DataNodeProperty | IResolvable;

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

passwordRequired 

public readonly password: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 readonly version: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The ID of VSwitch.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 readonly enableKibanaPrivate: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableKibanaPrivate: Enables or disables intranet access to Kibana.

enableKibanaPublicOptional 

public readonly enableKibanaPublic: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableKibanaPublic: Enables or disables Internet access to Kibana.

enablePublicOptional 

public readonly enablePublic: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enablePublic: Whether enable public access.

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

instanceCategoryOptional 

public readonly instanceCategory: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 readonly instanceChargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

kibanaNodeOptional 

public readonly kibanaNode: IResolvable | KibanaNodeProperty;

Property kibanaNode: The dedicated kibana node setting.

kibanaWhitelistOptional 

public readonly kibanaWhitelist: any[] | IResolvable;
  • Type: any[] | @alicloud/ros-cdk-core.IResolvable

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

masterNodeOptional 

public readonly masterNode: IResolvable | MasterNodeProperty;

Property masterNode: The dedicated master node setting.

If specified, dedicated master node will be created.

periodOptional 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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 readonly periodUnit: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

Default value is Month.

privateWhitelistOptional 

public readonly privateWhitelist: any[] | IResolvable;
  • Type: any[] | @alicloud/ros-cdk-core.IResolvable

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

publicWhitelistOptional 

public readonly publicWhitelist: any[] | IResolvable;
  • Type: any[] | @alicloud/ros-cdk-core.IResolvable

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

The AllocatePublicAddress should be true.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.

tagsOptional 

public readonly tags: TagsProperty[];

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 readonly ymlConfig: IResolvable | YMLConfigProperty;

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 readonly zoneCount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property zoneCount: undefined.

zoneIdOptional 

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property zoneId: The zone id of elasticsearch.