Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer 

import com.aliyun.ros.cdk.elasticsearch.InstanceProps;
InstanceProps.builder()
    .dataNode(DataNodeProperty)
    .dataNode(IResolvable)
    .password(java.lang.String)
    .password(IResolvable)
    .version(java.lang.String)
    .version(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .enableKibanaPrivate(java.lang.Boolean)
//  .enableKibanaPrivate(IResolvable)
//  .enableKibanaPublic(java.lang.Boolean)
//  .enableKibanaPublic(IResolvable)
//  .enablePublic(java.lang.Boolean)
//  .enablePublic(IResolvable)
//  .instanceCategory(java.lang.String)
//  .instanceCategory(IResolvable)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .kibanaNode(IResolvable)
//  .kibanaNode(KibanaNodeProperty)
//  .kibanaWhitelist(java.util.List<java.lang.Object>)
//  .kibanaWhitelist(IResolvable)
//  .masterNode(IResolvable)
//  .masterNode(MasterNodeProperty)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .privateWhitelist(java.util.List<java.lang.Object>)
//  .privateWhitelist(IResolvable)
//  .publicWhitelist(java.util.List<java.lang.Object>)
//  .publicWhitelist(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .ymlConfig(IResolvable)
//  .ymlConfig(YMLConfigProperty)
//  .zoneCount(java.lang.Number)
//  .zoneCount(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();

Properties

Name Type Description
dataNode DataNodeProperty OR com.aliyun.ros.cdk.core.IResolvable Property dataNode: The Elasticsearch cluster's data node setting.
password java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property password: The password of the instance.
version java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property version: Elasticsearch version.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The ID of VSwitch.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of instance.
enableKibanaPrivate java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableKibanaPrivate: Enables or disables intranet access to Kibana.
enableKibanaPublic java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableKibanaPublic: Enables or disables Internet access to Kibana.
enablePublic java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enablePublic: Whether enable public access.
instanceCategory java.lang.String OR com.aliyun.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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceChargeType: Valid values are PrePaid, PostPaid, Default to PostPaid.
kibanaNode com.aliyun.ros.cdk.core.IResolvable OR KibanaNodeProperty Property kibanaNode: The dedicated kibana node setting.
kibanaWhitelist java.util.List OR com.aliyun.ros.cdk.core.IResolvable Property kibanaWhitelist: Set the Kibana's IP whitelist in internet network.
masterNode com.aliyun.ros.cdk.core.IResolvable OR MasterNodeProperty Property masterNode: The dedicated master node setting.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The duration that you will buy Elasticsearch instance.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodUnit: Unit of prepaid time period, it could be Month\/Year.
privateWhitelist java.util.List OR com.aliyun.ros.cdk.core.IResolvable Property privateWhitelist: Set the instance's IP whitelist in VPC network.
publicWhitelist java.util.List OR com.aliyun.ros.cdk.core.IResolvable Property publicWhitelist: Set the instance's IP whitelist in Internet.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.
ymlConfig com.aliyun.ros.cdk.core.IResolvable OR 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 java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property zoneCount: undefined.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The zone id of elasticsearch.

dataNodeRequired 

public java.lang.Object getDataNode();

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

passwordRequired 

public java.lang.Object getPassword();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getVersion();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The ID of VSwitch.

descriptionOptional 

public java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getEnableKibanaPrivate();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property enableKibanaPrivate: Enables or disables intranet access to Kibana.

enableKibanaPublicOptional 

public java.lang.Object getEnableKibanaPublic();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property enableKibanaPublic: Enables or disables Internet access to Kibana.

enablePublicOptional 

public java.lang.Object getEnablePublic();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property enablePublic: Whether enable public access.

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

instanceCategoryOptional 

public java.lang.Object getInstanceCategory();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getInstanceChargeType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

kibanaNodeOptional 

public java.lang.Object getKibanaNode();

Property kibanaNode: The dedicated kibana node setting.

kibanaWhitelistOptional 

public java.lang.Object getKibanaWhitelist();
  • Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

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

masterNodeOptional 

public java.lang.Object getMasterNode();

Property masterNode: The dedicated master node setting.

If specified, dedicated master node will be created.

periodOptional 

public java.lang.Object getPeriod();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getPeriodUnit();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Default value is Month.

privateWhitelistOptional 

public java.lang.Object getPrivateWhitelist();
  • Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

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

publicWhitelistOptional 

public java.lang.Object getPublicWhitelist();
  • Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

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

The AllocatePublicAddress should be true.

resourceGroupIdOptional 

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

tagsOptional 

public java.util.List<TagsProperty> getTags();

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 java.lang.Object getYmlConfig();

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 java.lang.Object getZoneCount();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property zoneCount: undefined.

zoneIdOptional 

public java.lang.Object getZoneId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: The zone id of elasticsearch.