Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkelasticsearch"
&alicloudroscdkelasticsearch.InstanceProps {
    DataNode: interface{},
    Password: interface{},
    Version: interface{},
    VSwitchId: interface{},
    DeleteType: interface{},
    Description: interface{},
    EnableKibanaPrivate: interface{},
    EnableKibanaPublic: interface{},
    EnablePublic: interface{},
    InstanceCategory: interface{},
    InstanceChargeType: interface{},
    KibanaNode: interface{},
    KibanaWhitelist: interface{},
    MasterNode: interface{},
    Period: interface{},
    PeriodUnit: interface{},
    PrivateWhitelist: interface{},
    PublicWhitelist: interface{},
    ResourceGroupId: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkelasticsearch.RosInstance.TagsProperty,
    YmlConfig: interface{},
    ZoneCount: interface{},
    ZoneId: interface{},
}

Properties

Name Type Description
DataNode interface{} Property dataNode: The Elasticsearch cluster's data node setting.
Password interface{} Property password: The password of the instance.
Version interface{} Property version: Elasticsearch version.
VSwitchId interface{} Property vSwitchId: The ID of VSwitch.
DeleteType interface{} Property deleteType: The release type.
Description interface{} Property description: The description of instance.
EnableKibanaPrivate interface{} Property enableKibanaPrivate: Enables or disables intranet access to Kibana.
EnableKibanaPublic interface{} Property enableKibanaPublic: Enables or disables Internet access to Kibana.
EnablePublic interface{} Property enablePublic: Whether enable public access.
InstanceCategory interface{} Property instanceCategory: Version Type: - x-pack: Create a commercial instance or a kernel-enhanced instance without Indexing Service and OpenStore enabled.
InstanceChargeType interface{} Property instanceChargeType: Valid values are PrePaid, PostPaid, Default to PostPaid.
KibanaNode interface{} Property kibanaNode: The dedicated kibana node setting.
KibanaWhitelist interface{} Property kibanaWhitelist: Set the Kibana's IP whitelist in internet network.
MasterNode interface{} Property masterNode: The dedicated master node setting.
Period interface{} Property period: The duration that you will buy Elasticsearch instance.
PeriodUnit interface{} Property periodUnit: Unit of prepaid time period, it could be Month\/Year.
PrivateWhitelist interface{} Property privateWhitelist: Set the instance's IP whitelist in VPC network.
PublicWhitelist interface{} Property publicWhitelist: Set the instance's IP whitelist in Internet.
ResourceGroupId interface{} Property resourceGroupId: The ID of the resource group.
Tags *[]TagsProperty Property tags: Tags to attach to instance.
YmlConfig interface{} 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 interface{} Property zoneCount: undefined.
ZoneId interface{} Property zoneId: The zone id of elasticsearch.

DataNodeRequired

DataNode interface{}
  • Type: interface{}

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


PasswordRequired

Password interface{}
  • Type: interface{}

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

Version interface{}
  • Type: interface{}

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

VSwitchId interface{}
  • Type: interface{}

Property vSwitchId: The ID of VSwitch.


DeleteTypeOptional

DeleteType interface{}
  • Type: interface{}

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.

DescriptionOptional

Description interface{}
  • Type: interface{}

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.


EnableKibanaPrivateOptional

EnableKibanaPrivate interface{}
  • Type: interface{}

Property enableKibanaPrivate: Enables or disables intranet access to Kibana.


EnableKibanaPublicOptional

EnableKibanaPublic interface{}
  • Type: interface{}

Property enableKibanaPublic: Enables or disables Internet access to Kibana.


EnablePublicOptional

EnablePublic interface{}
  • Type: interface{}

Property enablePublic: Whether enable public access.

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


InstanceCategoryOptional

InstanceCategory interface{}
  • Type: interface{}

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

InstanceChargeType interface{}
  • Type: interface{}

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


KibanaNodeOptional

KibanaNode interface{}
  • Type: interface{}

Property kibanaNode: The dedicated kibana node setting.


KibanaWhitelistOptional

KibanaWhitelist interface{}
  • Type: interface{}

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


MasterNodeOptional

MasterNode interface{}
  • Type: interface{}

Property masterNode: The dedicated master node setting.

If specified, dedicated master node will be created.


PeriodOptional

Period interface{}
  • Type: interface{}

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

PeriodUnit interface{}
  • Type: interface{}

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

Default value is Month.


PrivateWhitelistOptional

PrivateWhitelist interface{}
  • Type: interface{}

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


PublicWhitelistOptional

PublicWhitelist interface{}
  • Type: interface{}

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

The AllocatePublicAddress should be true.


ResourceGroupIdOptional

ResourceGroupId interface{}
  • Type: interface{}

Property resourceGroupId: The ID of the resource group.


TagsOptional

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

YmlConfig interface{}
  • Type: interface{}

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

ZoneCount interface{}
  • Type: interface{}

Property zoneCount: undefined.


ZoneIdOptional

ZoneId interface{}
  • Type: interface{}

Property zoneId: The zone id of elasticsearch.