InstanceProps

Properties for defining a Instance.

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

Initializer

import ros_cdk_elasticsearch
ros_cdk_elasticsearch.InstanceProps(
  data_node: typing.Union[DataNodeProperty, IResolvable],
  password: typing.Union[str, IResolvable],
  version: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  delete_type: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  enable_kibana_private: typing.Union[bool, IResolvable] = None,
  enable_kibana_public: typing.Union[bool, IResolvable] = None,
  enable_public: typing.Union[bool, IResolvable] = None,
  instance_category: typing.Union[str, IResolvable] = None,
  instance_charge_type: typing.Union[str, IResolvable] = None,
  kibana_node: typing.Union[IResolvable, KibanaNodeProperty] = None,
  kibana_whitelist: typing.Union[typing.List[typing.Any], IResolvable] = None,
  master_node: typing.Union[IResolvable, MasterNodeProperty] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  private_whitelist: typing.Union[typing.List[typing.Any], IResolvable] = None,
  public_whitelist: typing.Union[typing.List[typing.Any], IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  yml_config: typing.Union[IResolvable, YMLConfigProperty] = None,
  zone_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None
)

Properties

data_node^Required

data_node: typing.Union[DataNodeProperty, IResolvable]

• Type: typing.Union[DataNodeProperty, ros_cdk_core.IResolvable]

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

password^Required

password: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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 (!@#$%&*()_+-=).

version^Required

version: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

v_switch_id^Required

v_switch_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vSwitchId: The ID of VSwitch.

delete_type^Optional

delete_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property deleteType: The release type.

Valid values:

• immediate: The cluster is immediately deleted when it is released. After the cluster is deleted, the data stored in the cluster is deleted, and the system removes the cluster from the Logstash cluster list.
• protective (default): The instance is frozen for 24 hours before data is completely cleared. During this period, the instance is still displayed in the instance list. You can select Restore Instance or Release Now.

description^Optional

description: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of instance.

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

enable_kibana_private^Optional

enable_kibana_private: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enableKibanaPrivate: Enables or disables intranet access to Kibana.

enable_kibana_public^Optional

enable_kibana_public: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enableKibanaPublic: Enables or disables Internet access to Kibana.

enable_public^Optional

enable_public: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enablePublic: Whether enable public access.

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

instance_category^Optional

instance_category: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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

instance_charge_type^Optional

instance_charge_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

kibana_node^Optional

kibana_node: typing.Union[IResolvable, KibanaNodeProperty]

• Type: typing.Union[ros_cdk_core.IResolvable, KibanaNodeProperty]

Property kibanaNode: The dedicated kibana node setting.

kibana_whitelist^Optional

kibana_whitelist: typing.Union[typing.List[typing.Any], IResolvable]

• Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]

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

master_node^Optional

master_node: typing.Union[IResolvable, MasterNodeProperty]

• Type: typing.Union[ros_cdk_core.IResolvable, MasterNodeProperty]

Property masterNode: The dedicated master node setting.

If specified, dedicated master node will be created.

period^Optional

period: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], 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.

period_unit^Optional

period_unit: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

Default value is Month.

private_whitelist^Optional

private_whitelist: typing.Union[typing.List[typing.Any], IResolvable]

• Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]

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

public_whitelist^Optional

public_whitelist: typing.Union[typing.List[typing.Any], IResolvable]

• Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]

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

The AllocatePublicAddress should be true.

resource_group_id^Optional

resource_group_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group.

tags^Optional

tags: typing.List[TagsProperty]

• Type: typing.List[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.

yml_config^Optional

yml_config: typing.Union[IResolvable, YMLConfigProperty]

• Type: typing.Union[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.

zone_count^Optional

zone_count: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property zoneCount: undefined.

zone_id^Optional

zone_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property zoneId: The zone id of elasticsearch.