alicloud.elasticsearch.Instance
Explore with Pulumi AI
Import
Elasticsearch can be imported using the id, e.g.
$ pulumi import alicloud:elasticsearch/instance:Instance example es-cn-abcde123456
Create Instance Resource
new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
@overload
def Instance(resource_name: str,
opts: Optional[ResourceOptions] = None,
auto_renew_duration: Optional[int] = None,
client_node_amount: Optional[int] = None,
client_node_spec: Optional[str] = None,
data_node_amount: Optional[int] = None,
data_node_disk_encrypted: Optional[bool] = None,
data_node_disk_performance_level: Optional[str] = None,
data_node_disk_size: Optional[int] = None,
data_node_disk_type: Optional[str] = None,
data_node_spec: Optional[str] = None,
description: Optional[str] = None,
enable_kibana_private_network: Optional[bool] = None,
enable_kibana_public_network: Optional[bool] = None,
enable_public: Optional[bool] = None,
instance_charge_type: Optional[str] = None,
kibana_node_spec: Optional[str] = None,
kibana_private_whitelists: Optional[Sequence[str]] = None,
kibana_whitelists: Optional[Sequence[str]] = None,
kms_encrypted_password: Optional[str] = None,
kms_encryption_context: Optional[Mapping[str, Any]] = None,
master_node_disk_type: Optional[str] = None,
master_node_spec: Optional[str] = None,
password: Optional[str] = None,
period: Optional[int] = None,
private_whitelists: Optional[Sequence[str]] = None,
protocol: Optional[str] = None,
public_whitelists: Optional[Sequence[str]] = None,
renew_status: Optional[str] = None,
renewal_duration_unit: Optional[str] = None,
resource_group_id: Optional[str] = None,
setting_config: Optional[Mapping[str, Any]] = None,
tags: Optional[Mapping[str, Any]] = None,
version: Optional[str] = None,
vswitch_id: Optional[str] = None,
zone_count: Optional[int] = None)
@overload
def Instance(resource_name: str,
args: InstanceArgs,
opts: Optional[ResourceOptions] = None)
func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)
type: alicloud:elasticsearch:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Instance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Instance resource accepts the following input properties:
- Data
Node intAmount The Elasticsearch cluster's data node quantity, between 2 and 50.
- Data
Node intDisk Size The single data node storage space.
- Data
Node stringDisk Type The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
- Data
Node stringSpec The data node specifications of the Elasticsearch instance.
- Version string
Elasticsearch version. Supported values:
5.5.3_with_X-Pack
,6.3_with_X-Pack
,6.7_with_X-Pack
,6.8_with_X-Pack
,7.4_with_X-Pack
and7.7_with_X-Pack
.- Vswitch
Id string The ID of VSwitch.
- Auto
Renew intDuration Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when
instance_charge_type
isPrePaid
andrenew_status
isAutoRenewal
.- Client
Node intAmount The Elasticsearch cluster's client node quantity, between 2 and 25.
- Client
Node stringSpec The client node spec. If specified, client node will be created.
- Data
Node boolDisk Encrypted If encrypt the data node disk. Valid values are
true
,false
. Default tofalse
.- Data
Node stringDisk Performance Level Cloud disk performance level. Valid values are
PL0
,PL1
,PL2
,PL3
. Thedata_node_disk_type
muse becloud_essd
.- Description string
The description of instance. It a string of 0 to 30 characters.
- Enable
Kibana boolPrivate Network Bool, default to false. When it set to true, the instance can close kibana private network access。
- Enable
Kibana boolPublic Network Bool, default to true. When it set to false, the instance can enable kibana public network access。
- Enable
Public bool Bool, default to false. When it set to true, the instance can enable public network access。
- Instance
Charge stringType Valid values are
PrePaid
,PostPaid
. Default toPostPaid
. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype fromPostPaid
toPrePaid
, the following attributes are required:period
. But, updating fromPostPaid
toPrePaid
is not supported.- Kibana
Node stringSpec The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small
.- Kibana
Private List<string>Whitelists Set the Kibana's IP whitelist in private network.
- Kibana
Whitelists List<string> Set the Kibana's IP whitelist in internet network.
- Kms
Encrypted stringPassword An KMS encrypts password used to an instance. If the
password
is filled in, this field will be ignored, but you have to specify one ofpassword
andkms_encrypted_password
fields.- Kms
Encryption Dictionary<string, object>Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- Master
Node stringDisk Type The single master node storage space. Valid values are
PrePaid
,PostPaid
.- Master
Node stringSpec The dedicated master node spec. If specified, dedicated master node will be created.
- Password string
The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (
!@#$%^&*()_+-=
).- Period int
The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is
PrePaid
. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaid
instance.- Private
Whitelists List<string> Set the instance's IP whitelist in VPC network.
- Protocol string
Elasticsearch protocol. Supported values:
HTTP
,HTTPS
.default isHTTP
.- Public
Whitelists List<string> Set the instance's IP whitelist in internet network.
- Renew
Status string The renewal status of the specified instance. Valid values:
AutoRenewal
,ManualRenewal
,NotRenewal
.Theinstance_charge_type
must bePrePaid
.- Renewal
Duration stringUnit Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values:
M
,Y
.- Resource
Group stringId The ID of resource group which the Elasticsearch instance belongs.
- Setting
Config Dictionary<string, object> The YML configuration of the instance.Detailed introduction.
- Dictionary<string, object>
A mapping of tags to assign to the resource.
- Zone
Count int The Multi-AZ supported for Elasticsearch, between 1 and 3. The
data_node_amount
value must be an integral multiple of thezone_count
value.
- Data
Node intAmount The Elasticsearch cluster's data node quantity, between 2 and 50.
- Data
Node intDisk Size The single data node storage space.
- Data
Node stringDisk Type The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
- Data
Node stringSpec The data node specifications of the Elasticsearch instance.
- Version string
Elasticsearch version. Supported values:
5.5.3_with_X-Pack
,6.3_with_X-Pack
,6.7_with_X-Pack
,6.8_with_X-Pack
,7.4_with_X-Pack
and7.7_with_X-Pack
.- Vswitch
Id string The ID of VSwitch.
- Auto
Renew intDuration Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when
instance_charge_type
isPrePaid
andrenew_status
isAutoRenewal
.- Client
Node intAmount The Elasticsearch cluster's client node quantity, between 2 and 25.
- Client
Node stringSpec The client node spec. If specified, client node will be created.
- Data
Node boolDisk Encrypted If encrypt the data node disk. Valid values are
true
,false
. Default tofalse
.- Data
Node stringDisk Performance Level Cloud disk performance level. Valid values are
PL0
,PL1
,PL2
,PL3
. Thedata_node_disk_type
muse becloud_essd
.- Description string
The description of instance. It a string of 0 to 30 characters.
- Enable
Kibana boolPrivate Network Bool, default to false. When it set to true, the instance can close kibana private network access。
- Enable
Kibana boolPublic Network Bool, default to true. When it set to false, the instance can enable kibana public network access。
- Enable
Public bool Bool, default to false. When it set to true, the instance can enable public network access。
- Instance
Charge stringType Valid values are
PrePaid
,PostPaid
. Default toPostPaid
. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype fromPostPaid
toPrePaid
, the following attributes are required:period
. But, updating fromPostPaid
toPrePaid
is not supported.- Kibana
Node stringSpec The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small
.- Kibana
Private []stringWhitelists Set the Kibana's IP whitelist in private network.
- Kibana
Whitelists []string Set the Kibana's IP whitelist in internet network.
- Kms
Encrypted stringPassword An KMS encrypts password used to an instance. If the
password
is filled in, this field will be ignored, but you have to specify one ofpassword
andkms_encrypted_password
fields.- Kms
Encryption map[string]interface{}Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- Master
Node stringDisk Type The single master node storage space. Valid values are
PrePaid
,PostPaid
.- Master
Node stringSpec The dedicated master node spec. If specified, dedicated master node will be created.
- Password string
The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (
!@#$%^&*()_+-=
).- Period int
The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is
PrePaid
. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaid
instance.- Private
Whitelists []string Set the instance's IP whitelist in VPC network.
- Protocol string
Elasticsearch protocol. Supported values:
HTTP
,HTTPS
.default isHTTP
.- Public
Whitelists []string Set the instance's IP whitelist in internet network.
- Renew
Status string The renewal status of the specified instance. Valid values:
AutoRenewal
,ManualRenewal
,NotRenewal
.Theinstance_charge_type
must bePrePaid
.- Renewal
Duration stringUnit Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values:
M
,Y
.- Resource
Group stringId The ID of resource group which the Elasticsearch instance belongs.
- Setting
Config map[string]interface{} The YML configuration of the instance.Detailed introduction.
- map[string]interface{}
A mapping of tags to assign to the resource.
- Zone
Count int The Multi-AZ supported for Elasticsearch, between 1 and 3. The
data_node_amount
value must be an integral multiple of thezone_count
value.
- data
Node IntegerAmount The Elasticsearch cluster's data node quantity, between 2 and 50.
- data
Node IntegerDisk Size The single data node storage space.
- data
Node StringDisk Type The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
- data
Node StringSpec The data node specifications of the Elasticsearch instance.
- version String
Elasticsearch version. Supported values:
5.5.3_with_X-Pack
,6.3_with_X-Pack
,6.7_with_X-Pack
,6.8_with_X-Pack
,7.4_with_X-Pack
and7.7_with_X-Pack
.- vswitch
Id String The ID of VSwitch.
- auto
Renew IntegerDuration Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when
instance_charge_type
isPrePaid
andrenew_status
isAutoRenewal
.- client
Node IntegerAmount The Elasticsearch cluster's client node quantity, between 2 and 25.
- client
Node StringSpec The client node spec. If specified, client node will be created.
- data
Node BooleanDisk Encrypted If encrypt the data node disk. Valid values are
true
,false
. Default tofalse
.- data
Node StringDisk Performance Level Cloud disk performance level. Valid values are
PL0
,PL1
,PL2
,PL3
. Thedata_node_disk_type
muse becloud_essd
.- description String
The description of instance. It a string of 0 to 30 characters.
- enable
Kibana BooleanPrivate Network Bool, default to false. When it set to true, the instance can close kibana private network access。
- enable
Kibana BooleanPublic Network Bool, default to true. When it set to false, the instance can enable kibana public network access。
- enable
Public Boolean Bool, default to false. When it set to true, the instance can enable public network access。
- instance
Charge StringType Valid values are
PrePaid
,PostPaid
. Default toPostPaid
. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype fromPostPaid
toPrePaid
, the following attributes are required:period
. But, updating fromPostPaid
toPrePaid
is not supported.- kibana
Node StringSpec The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small
.- kibana
Private List<String>Whitelists Set the Kibana's IP whitelist in private network.
- kibana
Whitelists List<String> Set the Kibana's IP whitelist in internet network.
- kms
Encrypted StringPassword An KMS encrypts password used to an instance. If the
password
is filled in, this field will be ignored, but you have to specify one ofpassword
andkms_encrypted_password
fields.- kms
Encryption Map<String,Object>Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- master
Node StringDisk Type The single master node storage space. Valid values are
PrePaid
,PostPaid
.- master
Node StringSpec The dedicated master node spec. If specified, dedicated master node will be created.
- password String
The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (
!@#$%^&*()_+-=
).- period Integer
The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is
PrePaid
. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaid
instance.- private
Whitelists List<String> Set the instance's IP whitelist in VPC network.
- protocol String
Elasticsearch protocol. Supported values:
HTTP
,HTTPS
.default isHTTP
.- public
Whitelists List<String> Set the instance's IP whitelist in internet network.
- renew
Status String The renewal status of the specified instance. Valid values:
AutoRenewal
,ManualRenewal
,NotRenewal
.Theinstance_charge_type
must bePrePaid
.- renewal
Duration StringUnit Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values:
M
,Y
.- resource
Group StringId The ID of resource group which the Elasticsearch instance belongs.
- setting
Config Map<String,Object> The YML configuration of the instance.Detailed introduction.
- Map<String,Object>
A mapping of tags to assign to the resource.
- zone
Count Integer The Multi-AZ supported for Elasticsearch, between 1 and 3. The
data_node_amount
value must be an integral multiple of thezone_count
value.
- data
Node numberAmount The Elasticsearch cluster's data node quantity, between 2 and 50.
- data
Node numberDisk Size The single data node storage space.
- data
Node stringDisk Type The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
- data
Node stringSpec The data node specifications of the Elasticsearch instance.
- version string
Elasticsearch version. Supported values:
5.5.3_with_X-Pack
,6.3_with_X-Pack
,6.7_with_X-Pack
,6.8_with_X-Pack
,7.4_with_X-Pack
and7.7_with_X-Pack
.- vswitch
Id string The ID of VSwitch.
- auto
Renew numberDuration Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when
instance_charge_type
isPrePaid
andrenew_status
isAutoRenewal
.- client
Node numberAmount The Elasticsearch cluster's client node quantity, between 2 and 25.
- client
Node stringSpec The client node spec. If specified, client node will be created.
- data
Node booleanDisk Encrypted If encrypt the data node disk. Valid values are
true
,false
. Default tofalse
.- data
Node stringDisk Performance Level Cloud disk performance level. Valid values are
PL0
,PL1
,PL2
,PL3
. Thedata_node_disk_type
muse becloud_essd
.- description string
The description of instance. It a string of 0 to 30 characters.
- enable
Kibana booleanPrivate Network Bool, default to false. When it set to true, the instance can close kibana private network access。
- enable
Kibana booleanPublic Network Bool, default to true. When it set to false, the instance can enable kibana public network access。
- enable
Public boolean Bool, default to false. When it set to true, the instance can enable public network access。
- instance
Charge stringType Valid values are
PrePaid
,PostPaid
. Default toPostPaid
. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype fromPostPaid
toPrePaid
, the following attributes are required:period
. But, updating fromPostPaid
toPrePaid
is not supported.- kibana
Node stringSpec The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small
.- kibana
Private string[]Whitelists Set the Kibana's IP whitelist in private network.
- kibana
Whitelists string[] Set the Kibana's IP whitelist in internet network.
- kms
Encrypted stringPassword An KMS encrypts password used to an instance. If the
password
is filled in, this field will be ignored, but you have to specify one ofpassword
andkms_encrypted_password
fields.- kms
Encryption {[key: string]: any}Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- master
Node stringDisk Type The single master node storage space. Valid values are
PrePaid
,PostPaid
.- master
Node stringSpec The dedicated master node spec. If specified, dedicated master node will be created.
- password string
The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (
!@#$%^&*()_+-=
).- period number
The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is
PrePaid
. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaid
instance.- private
Whitelists string[] Set the instance's IP whitelist in VPC network.
- protocol string
Elasticsearch protocol. Supported values:
HTTP
,HTTPS
.default isHTTP
.- public
Whitelists string[] Set the instance's IP whitelist in internet network.
- renew
Status string The renewal status of the specified instance. Valid values:
AutoRenewal
,ManualRenewal
,NotRenewal
.Theinstance_charge_type
must bePrePaid
.- renewal
Duration stringUnit Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values:
M
,Y
.- resource
Group stringId The ID of resource group which the Elasticsearch instance belongs.
- setting
Config {[key: string]: any} The YML configuration of the instance.Detailed introduction.
- {[key: string]: any}
A mapping of tags to assign to the resource.
- zone
Count number The Multi-AZ supported for Elasticsearch, between 1 and 3. The
data_node_amount
value must be an integral multiple of thezone_count
value.
- data_
node_ intamount The Elasticsearch cluster's data node quantity, between 2 and 50.
- data_
node_ intdisk_ size The single data node storage space.
- data_
node_ strdisk_ type The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
- data_
node_ strspec The data node specifications of the Elasticsearch instance.
- version str
Elasticsearch version. Supported values:
5.5.3_with_X-Pack
,6.3_with_X-Pack
,6.7_with_X-Pack
,6.8_with_X-Pack
,7.4_with_X-Pack
and7.7_with_X-Pack
.- vswitch_
id str The ID of VSwitch.
- auto_
renew_ intduration Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when
instance_charge_type
isPrePaid
andrenew_status
isAutoRenewal
.- client_
node_ intamount The Elasticsearch cluster's client node quantity, between 2 and 25.
- client_
node_ strspec The client node spec. If specified, client node will be created.
- data_
node_ booldisk_ encrypted If encrypt the data node disk. Valid values are
true
,false
. Default tofalse
.- data_
node_ strdisk_ performance_ level Cloud disk performance level. Valid values are
PL0
,PL1
,PL2
,PL3
. Thedata_node_disk_type
muse becloud_essd
.- description str
The description of instance. It a string of 0 to 30 characters.
- enable_
kibana_ boolprivate_ network Bool, default to false. When it set to true, the instance can close kibana private network access。
- enable_
kibana_ boolpublic_ network Bool, default to true. When it set to false, the instance can enable kibana public network access。
- enable_
public bool Bool, default to false. When it set to true, the instance can enable public network access。
- instance_
charge_ strtype Valid values are
PrePaid
,PostPaid
. Default toPostPaid
. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype fromPostPaid
toPrePaid
, the following attributes are required:period
. But, updating fromPostPaid
toPrePaid
is not supported.- kibana_
node_ strspec The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small
.- kibana_
private_ Sequence[str]whitelists Set the Kibana's IP whitelist in private network.
- kibana_
whitelists Sequence[str] Set the Kibana's IP whitelist in internet network.
- kms_
encrypted_ strpassword An KMS encrypts password used to an instance. If the
password
is filled in, this field will be ignored, but you have to specify one ofpassword
andkms_encrypted_password
fields.- kms_
encryption_ Mapping[str, Any]context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- master_
node_ strdisk_ type The single master node storage space. Valid values are
PrePaid
,PostPaid
.- master_
node_ strspec The dedicated master node spec. If specified, dedicated master node will be created.
- password str
The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (
!@#$%^&*()_+-=
).- period int
The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is
PrePaid
. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaid
instance.- private_
whitelists Sequence[str] Set the instance's IP whitelist in VPC network.
- protocol str
Elasticsearch protocol. Supported values:
HTTP
,HTTPS
.default isHTTP
.- public_
whitelists Sequence[str] Set the instance's IP whitelist in internet network.
- renew_
status str The renewal status of the specified instance. Valid values:
AutoRenewal
,ManualRenewal
,NotRenewal
.Theinstance_charge_type
must bePrePaid
.- renewal_
duration_ strunit Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values:
M
,Y
.- resource_
group_ strid The ID of resource group which the Elasticsearch instance belongs.
- setting_
config Mapping[str, Any] The YML configuration of the instance.Detailed introduction.
- Mapping[str, Any]
A mapping of tags to assign to the resource.
- zone_
count int The Multi-AZ supported for Elasticsearch, between 1 and 3. The
data_node_amount
value must be an integral multiple of thezone_count
value.
- data
Node NumberAmount The Elasticsearch cluster's data node quantity, between 2 and 50.
- data
Node NumberDisk Size The single data node storage space.
- data
Node StringDisk Type The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
- data
Node StringSpec The data node specifications of the Elasticsearch instance.
- version String
Elasticsearch version. Supported values:
5.5.3_with_X-Pack
,6.3_with_X-Pack
,6.7_with_X-Pack
,6.8_with_X-Pack
,7.4_with_X-Pack
and7.7_with_X-Pack
.- vswitch
Id String The ID of VSwitch.
- auto
Renew NumberDuration Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when
instance_charge_type
isPrePaid
andrenew_status
isAutoRenewal
.- client
Node NumberAmount The Elasticsearch cluster's client node quantity, between 2 and 25.
- client
Node StringSpec The client node spec. If specified, client node will be created.
- data
Node BooleanDisk Encrypted If encrypt the data node disk. Valid values are
true
,false
. Default tofalse
.- data
Node StringDisk Performance Level Cloud disk performance level. Valid values are
PL0
,PL1
,PL2
,PL3
. Thedata_node_disk_type
muse becloud_essd
.- description String
The description of instance. It a string of 0 to 30 characters.
- enable
Kibana BooleanPrivate Network Bool, default to false. When it set to true, the instance can close kibana private network access。
- enable
Kibana BooleanPublic Network Bool, default to true. When it set to false, the instance can enable kibana public network access。
- enable
Public Boolean Bool, default to false. When it set to true, the instance can enable public network access。
- instance
Charge StringType Valid values are
PrePaid
,PostPaid
. Default toPostPaid
. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype fromPostPaid
toPrePaid
, the following attributes are required:period
. But, updating fromPostPaid
toPrePaid
is not supported.- kibana
Node StringSpec The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small
.- kibana
Private List<String>Whitelists Set the Kibana's IP whitelist in private network.
- kibana
Whitelists List<String> Set the Kibana's IP whitelist in internet network.
- kms
Encrypted StringPassword An KMS encrypts password used to an instance. If the
password
is filled in, this field will be ignored, but you have to specify one ofpassword
andkms_encrypted_password
fields.- kms
Encryption Map<Any>Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- master
Node StringDisk Type The single master node storage space. Valid values are
PrePaid
,PostPaid
.- master
Node StringSpec The dedicated master node spec. If specified, dedicated master node will be created.
- password String
The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (
!@#$%^&*()_+-=
).- period Number
The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is
PrePaid
. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaid
instance.- private
Whitelists List<String> Set the instance's IP whitelist in VPC network.
- protocol String
Elasticsearch protocol. Supported values:
HTTP
,HTTPS
.default isHTTP
.- public
Whitelists List<String> Set the instance's IP whitelist in internet network.
- renew
Status String The renewal status of the specified instance. Valid values:
AutoRenewal
,ManualRenewal
,NotRenewal
.Theinstance_charge_type
must bePrePaid
.- renewal
Duration StringUnit Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values:
M
,Y
.- resource
Group StringId The ID of resource group which the Elasticsearch instance belongs.
- setting
Config Map<Any> The YML configuration of the instance.Detailed introduction.
- Map<Any>
A mapping of tags to assign to the resource.
- zone
Count Number The Multi-AZ supported for Elasticsearch, between 1 and 3. The
data_node_amount
value must be an integral multiple of thezone_count
value.
Outputs
All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:
- Domain string
Instance connection domain (only VPC network access supported).
- Id string
The provider-assigned unique ID for this managed resource.
- Kibana
Domain string Kibana console domain (Internet access supported).
- Kibana
Port int Kibana console port.
- Port int
Instance connection port.
- Public
Domain string Instance connection public domain.
- Public
Port int Instance connection public port.
- Status string
The Elasticsearch instance status. Includes
active
,activating
,inactive
. Some operations are denied when status is notactive
.
- Domain string
Instance connection domain (only VPC network access supported).
- Id string
The provider-assigned unique ID for this managed resource.
- Kibana
Domain string Kibana console domain (Internet access supported).
- Kibana
Port int Kibana console port.
- Port int
Instance connection port.
- Public
Domain string Instance connection public domain.
- Public
Port int Instance connection public port.
- Status string
The Elasticsearch instance status. Includes
active
,activating
,inactive
. Some operations are denied when status is notactive
.
- domain String
Instance connection domain (only VPC network access supported).
- id String
The provider-assigned unique ID for this managed resource.
- kibana
Domain String Kibana console domain (Internet access supported).
- kibana
Port Integer Kibana console port.
- port Integer
Instance connection port.
- public
Domain String Instance connection public domain.
- public
Port Integer Instance connection public port.
- status String
The Elasticsearch instance status. Includes
active
,activating
,inactive
. Some operations are denied when status is notactive
.
- domain string
Instance connection domain (only VPC network access supported).
- id string
The provider-assigned unique ID for this managed resource.
- kibana
Domain string Kibana console domain (Internet access supported).
- kibana
Port number Kibana console port.
- port number
Instance connection port.
- public
Domain string Instance connection public domain.
- public
Port number Instance connection public port.
- status string
The Elasticsearch instance status. Includes
active
,activating
,inactive
. Some operations are denied when status is notactive
.
- domain str
Instance connection domain (only VPC network access supported).
- id str
The provider-assigned unique ID for this managed resource.
- kibana_
domain str Kibana console domain (Internet access supported).
- kibana_
port int Kibana console port.
- port int
Instance connection port.
- public_
domain str Instance connection public domain.
- public_
port int Instance connection public port.
- status str
The Elasticsearch instance status. Includes
active
,activating
,inactive
. Some operations are denied when status is notactive
.
- domain String
Instance connection domain (only VPC network access supported).
- id String
The provider-assigned unique ID for this managed resource.
- kibana
Domain String Kibana console domain (Internet access supported).
- kibana
Port Number Kibana console port.
- port Number
Instance connection port.
- public
Domain String Instance connection public domain.
- public
Port Number Instance connection public port.
- status String
The Elasticsearch instance status. Includes
active
,activating
,inactive
. Some operations are denied when status is notactive
.
Look up Existing Instance Resource
Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auto_renew_duration: Optional[int] = None,
client_node_amount: Optional[int] = None,
client_node_spec: Optional[str] = None,
data_node_amount: Optional[int] = None,
data_node_disk_encrypted: Optional[bool] = None,
data_node_disk_performance_level: Optional[str] = None,
data_node_disk_size: Optional[int] = None,
data_node_disk_type: Optional[str] = None,
data_node_spec: Optional[str] = None,
description: Optional[str] = None,
domain: Optional[str] = None,
enable_kibana_private_network: Optional[bool] = None,
enable_kibana_public_network: Optional[bool] = None,
enable_public: Optional[bool] = None,
instance_charge_type: Optional[str] = None,
kibana_domain: Optional[str] = None,
kibana_node_spec: Optional[str] = None,
kibana_port: Optional[int] = None,
kibana_private_whitelists: Optional[Sequence[str]] = None,
kibana_whitelists: Optional[Sequence[str]] = None,
kms_encrypted_password: Optional[str] = None,
kms_encryption_context: Optional[Mapping[str, Any]] = None,
master_node_disk_type: Optional[str] = None,
master_node_spec: Optional[str] = None,
password: Optional[str] = None,
period: Optional[int] = None,
port: Optional[int] = None,
private_whitelists: Optional[Sequence[str]] = None,
protocol: Optional[str] = None,
public_domain: Optional[str] = None,
public_port: Optional[int] = None,
public_whitelists: Optional[Sequence[str]] = None,
renew_status: Optional[str] = None,
renewal_duration_unit: Optional[str] = None,
resource_group_id: Optional[str] = None,
setting_config: Optional[Mapping[str, Any]] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, Any]] = None,
version: Optional[str] = None,
vswitch_id: Optional[str] = None,
zone_count: Optional[int] = None) -> Instance
func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Auto
Renew intDuration Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when
instance_charge_type
isPrePaid
andrenew_status
isAutoRenewal
.- Client
Node intAmount The Elasticsearch cluster's client node quantity, between 2 and 25.
- Client
Node stringSpec The client node spec. If specified, client node will be created.
- Data
Node intAmount The Elasticsearch cluster's data node quantity, between 2 and 50.
- Data
Node boolDisk Encrypted If encrypt the data node disk. Valid values are
true
,false
. Default tofalse
.- Data
Node stringDisk Performance Level Cloud disk performance level. Valid values are
PL0
,PL1
,PL2
,PL3
. Thedata_node_disk_type
muse becloud_essd
.- Data
Node intDisk Size The single data node storage space.
- Data
Node stringDisk Type The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
- Data
Node stringSpec The data node specifications of the Elasticsearch instance.
- Description string
The description of instance. It a string of 0 to 30 characters.
- Domain string
Instance connection domain (only VPC network access supported).
- Enable
Kibana boolPrivate Network Bool, default to false. When it set to true, the instance can close kibana private network access。
- Enable
Kibana boolPublic Network Bool, default to true. When it set to false, the instance can enable kibana public network access。
- Enable
Public bool Bool, default to false. When it set to true, the instance can enable public network access。
- Instance
Charge stringType Valid values are
PrePaid
,PostPaid
. Default toPostPaid
. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype fromPostPaid
toPrePaid
, the following attributes are required:period
. But, updating fromPostPaid
toPrePaid
is not supported.- Kibana
Domain string Kibana console domain (Internet access supported).
- Kibana
Node stringSpec The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small
.- Kibana
Port int Kibana console port.
- Kibana
Private List<string>Whitelists Set the Kibana's IP whitelist in private network.
- Kibana
Whitelists List<string> Set the Kibana's IP whitelist in internet network.
- Kms
Encrypted stringPassword An KMS encrypts password used to an instance. If the
password
is filled in, this field will be ignored, but you have to specify one ofpassword
andkms_encrypted_password
fields.- Kms
Encryption Dictionary<string, object>Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- Master
Node stringDisk Type The single master node storage space. Valid values are
PrePaid
,PostPaid
.- Master
Node stringSpec The dedicated master node spec. If specified, dedicated master node will be created.
- Password string
The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (
!@#$%^&*()_+-=
).- Period int
The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is
PrePaid
. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaid
instance.- Port int
Instance connection port.
- Private
Whitelists List<string> Set the instance's IP whitelist in VPC network.
- Protocol string
Elasticsearch protocol. Supported values:
HTTP
,HTTPS
.default isHTTP
.- Public
Domain string Instance connection public domain.
- Public
Port int Instance connection public port.
- Public
Whitelists List<string> Set the instance's IP whitelist in internet network.
- Renew
Status string The renewal status of the specified instance. Valid values:
AutoRenewal
,ManualRenewal
,NotRenewal
.Theinstance_charge_type
must bePrePaid
.- Renewal
Duration stringUnit Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values:
M
,Y
.- Resource
Group stringId The ID of resource group which the Elasticsearch instance belongs.
- Setting
Config Dictionary<string, object> The YML configuration of the instance.Detailed introduction.
- Status string
The Elasticsearch instance status. Includes
active
,activating
,inactive
. Some operations are denied when status is notactive
.- Dictionary<string, object>
A mapping of tags to assign to the resource.
- Version string
Elasticsearch version. Supported values:
5.5.3_with_X-Pack
,6.3_with_X-Pack
,6.7_with_X-Pack
,6.8_with_X-Pack
,7.4_with_X-Pack
and7.7_with_X-Pack
.- Vswitch
Id string The ID of VSwitch.
- Zone
Count int The Multi-AZ supported for Elasticsearch, between 1 and 3. The
data_node_amount
value must be an integral multiple of thezone_count
value.
- Auto
Renew intDuration Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when
instance_charge_type
isPrePaid
andrenew_status
isAutoRenewal
.- Client
Node intAmount The Elasticsearch cluster's client node quantity, between 2 and 25.
- Client
Node stringSpec The client node spec. If specified, client node will be created.
- Data
Node intAmount The Elasticsearch cluster's data node quantity, between 2 and 50.
- Data
Node boolDisk Encrypted If encrypt the data node disk. Valid values are
true
,false
. Default tofalse
.- Data
Node stringDisk Performance Level Cloud disk performance level. Valid values are
PL0
,PL1
,PL2
,PL3
. Thedata_node_disk_type
muse becloud_essd
.- Data
Node intDisk Size The single data node storage space.
- Data
Node stringDisk Type The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
- Data
Node stringSpec The data node specifications of the Elasticsearch instance.
- Description string
The description of instance. It a string of 0 to 30 characters.
- Domain string
Instance connection domain (only VPC network access supported).
- Enable
Kibana boolPrivate Network Bool, default to false. When it set to true, the instance can close kibana private network access。
- Enable
Kibana boolPublic Network Bool, default to true. When it set to false, the instance can enable kibana public network access。
- Enable
Public bool Bool, default to false. When it set to true, the instance can enable public network access。
- Instance
Charge stringType Valid values are
PrePaid
,PostPaid
. Default toPostPaid
. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype fromPostPaid
toPrePaid
, the following attributes are required:period
. But, updating fromPostPaid
toPrePaid
is not supported.- Kibana
Domain string Kibana console domain (Internet access supported).
- Kibana
Node stringSpec The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small
.- Kibana
Port int Kibana console port.
- Kibana
Private []stringWhitelists Set the Kibana's IP whitelist in private network.
- Kibana
Whitelists []string Set the Kibana's IP whitelist in internet network.
- Kms
Encrypted stringPassword An KMS encrypts password used to an instance. If the
password
is filled in, this field will be ignored, but you have to specify one ofpassword
andkms_encrypted_password
fields.- Kms
Encryption map[string]interface{}Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- Master
Node stringDisk Type The single master node storage space. Valid values are
PrePaid
,PostPaid
.- Master
Node stringSpec The dedicated master node spec. If specified, dedicated master node will be created.
- Password string
The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (
!@#$%^&*()_+-=
).- Period int
The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is
PrePaid
. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaid
instance.- Port int
Instance connection port.
- Private
Whitelists []string Set the instance's IP whitelist in VPC network.
- Protocol string
Elasticsearch protocol. Supported values:
HTTP
,HTTPS
.default isHTTP
.- Public
Domain string Instance connection public domain.
- Public
Port int Instance connection public port.
- Public
Whitelists []string Set the instance's IP whitelist in internet network.
- Renew
Status string The renewal status of the specified instance. Valid values:
AutoRenewal
,ManualRenewal
,NotRenewal
.Theinstance_charge_type
must bePrePaid
.- Renewal
Duration stringUnit Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values:
M
,Y
.- Resource
Group stringId The ID of resource group which the Elasticsearch instance belongs.
- Setting
Config map[string]interface{} The YML configuration of the instance.Detailed introduction.
- Status string
The Elasticsearch instance status. Includes
active
,activating
,inactive
. Some operations are denied when status is notactive
.- map[string]interface{}
A mapping of tags to assign to the resource.
- Version string
Elasticsearch version. Supported values:
5.5.3_with_X-Pack
,6.3_with_X-Pack
,6.7_with_X-Pack
,6.8_with_X-Pack
,7.4_with_X-Pack
and7.7_with_X-Pack
.- Vswitch
Id string The ID of VSwitch.
- Zone
Count int The Multi-AZ supported for Elasticsearch, between 1 and 3. The
data_node_amount
value must be an integral multiple of thezone_count
value.
- auto
Renew IntegerDuration Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when
instance_charge_type
isPrePaid
andrenew_status
isAutoRenewal
.- client
Node IntegerAmount The Elasticsearch cluster's client node quantity, between 2 and 25.
- client
Node StringSpec The client node spec. If specified, client node will be created.
- data
Node IntegerAmount The Elasticsearch cluster's data node quantity, between 2 and 50.
- data
Node BooleanDisk Encrypted If encrypt the data node disk. Valid values are
true
,false
. Default tofalse
.- data
Node StringDisk Performance Level Cloud disk performance level. Valid values are
PL0
,PL1
,PL2
,PL3
. Thedata_node_disk_type
muse becloud_essd
.- data
Node IntegerDisk Size The single data node storage space.
- data
Node StringDisk Type The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
- data
Node StringSpec The data node specifications of the Elasticsearch instance.
- description String
The description of instance. It a string of 0 to 30 characters.
- domain String
Instance connection domain (only VPC network access supported).
- enable
Kibana BooleanPrivate Network Bool, default to false. When it set to true, the instance can close kibana private network access。
- enable
Kibana BooleanPublic Network Bool, default to true. When it set to false, the instance can enable kibana public network access。
- enable
Public Boolean Bool, default to false. When it set to true, the instance can enable public network access。
- instance
Charge StringType Valid values are
PrePaid
,PostPaid
. Default toPostPaid
. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype fromPostPaid
toPrePaid
, the following attributes are required:period
. But, updating fromPostPaid
toPrePaid
is not supported.- kibana
Domain String Kibana console domain (Internet access supported).
- kibana
Node StringSpec The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small
.- kibana
Port Integer Kibana console port.
- kibana
Private List<String>Whitelists Set the Kibana's IP whitelist in private network.
- kibana
Whitelists List<String> Set the Kibana's IP whitelist in internet network.
- kms
Encrypted StringPassword An KMS encrypts password used to an instance. If the
password
is filled in, this field will be ignored, but you have to specify one ofpassword
andkms_encrypted_password
fields.- kms
Encryption Map<String,Object>Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- master
Node StringDisk Type The single master node storage space. Valid values are
PrePaid
,PostPaid
.- master
Node StringSpec The dedicated master node spec. If specified, dedicated master node will be created.
- password String
The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (
!@#$%^&*()_+-=
).- period Integer
The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is
PrePaid
. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaid
instance.- port Integer
Instance connection port.
- private
Whitelists List<String> Set the instance's IP whitelist in VPC network.
- protocol String
Elasticsearch protocol. Supported values:
HTTP
,HTTPS
.default isHTTP
.- public
Domain String Instance connection public domain.
- public
Port Integer Instance connection public port.
- public
Whitelists List<String> Set the instance's IP whitelist in internet network.
- renew
Status String The renewal status of the specified instance. Valid values:
AutoRenewal
,ManualRenewal
,NotRenewal
.Theinstance_charge_type
must bePrePaid
.- renewal
Duration StringUnit Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values:
M
,Y
.- resource
Group StringId The ID of resource group which the Elasticsearch instance belongs.
- setting
Config Map<String,Object> The YML configuration of the instance.Detailed introduction.
- status String
The Elasticsearch instance status. Includes
active
,activating
,inactive
. Some operations are denied when status is notactive
.- Map<String,Object>
A mapping of tags to assign to the resource.
- version String
Elasticsearch version. Supported values:
5.5.3_with_X-Pack
,6.3_with_X-Pack
,6.7_with_X-Pack
,6.8_with_X-Pack
,7.4_with_X-Pack
and7.7_with_X-Pack
.- vswitch
Id String The ID of VSwitch.
- zone
Count Integer The Multi-AZ supported for Elasticsearch, between 1 and 3. The
data_node_amount
value must be an integral multiple of thezone_count
value.
- auto
Renew numberDuration Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when
instance_charge_type
isPrePaid
andrenew_status
isAutoRenewal
.- client
Node numberAmount The Elasticsearch cluster's client node quantity, between 2 and 25.
- client
Node stringSpec The client node spec. If specified, client node will be created.
- data
Node numberAmount The Elasticsearch cluster's data node quantity, between 2 and 50.
- data
Node booleanDisk Encrypted If encrypt the data node disk. Valid values are
true
,false
. Default tofalse
.- data
Node stringDisk Performance Level Cloud disk performance level. Valid values are
PL0
,PL1
,PL2
,PL3
. Thedata_node_disk_type
muse becloud_essd
.- data
Node numberDisk Size The single data node storage space.
- data
Node stringDisk Type The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
- data
Node stringSpec The data node specifications of the Elasticsearch instance.
- description string
The description of instance. It a string of 0 to 30 characters.
- domain string
Instance connection domain (only VPC network access supported).
- enable
Kibana booleanPrivate Network Bool, default to false. When it set to true, the instance can close kibana private network access。
- enable
Kibana booleanPublic Network Bool, default to true. When it set to false, the instance can enable kibana public network access。
- enable
Public boolean Bool, default to false. When it set to true, the instance can enable public network access。
- instance
Charge stringType Valid values are
PrePaid
,PostPaid
. Default toPostPaid
. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype fromPostPaid
toPrePaid
, the following attributes are required:period
. But, updating fromPostPaid
toPrePaid
is not supported.- kibana
Domain string Kibana console domain (Internet access supported).
- kibana
Node stringSpec The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small
.- kibana
Port number Kibana console port.
- kibana
Private string[]Whitelists Set the Kibana's IP whitelist in private network.
- kibana
Whitelists string[] Set the Kibana's IP whitelist in internet network.
- kms
Encrypted stringPassword An KMS encrypts password used to an instance. If the
password
is filled in, this field will be ignored, but you have to specify one ofpassword
andkms_encrypted_password
fields.- kms
Encryption {[key: string]: any}Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- master
Node stringDisk Type The single master node storage space. Valid values are
PrePaid
,PostPaid
.- master
Node stringSpec The dedicated master node spec. If specified, dedicated master node will be created.
- password string
The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (
!@#$%^&*()_+-=
).- period number
The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is
PrePaid
. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaid
instance.- port number
Instance connection port.
- private
Whitelists string[] Set the instance's IP whitelist in VPC network.
- protocol string
Elasticsearch protocol. Supported values:
HTTP
,HTTPS
.default isHTTP
.- public
Domain string Instance connection public domain.
- public
Port number Instance connection public port.
- public
Whitelists string[] Set the instance's IP whitelist in internet network.
- renew
Status string The renewal status of the specified instance. Valid values:
AutoRenewal
,ManualRenewal
,NotRenewal
.Theinstance_charge_type
must bePrePaid
.- renewal
Duration stringUnit Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values:
M
,Y
.- resource
Group stringId The ID of resource group which the Elasticsearch instance belongs.
- setting
Config {[key: string]: any} The YML configuration of the instance.Detailed introduction.
- status string
The Elasticsearch instance status. Includes
active
,activating
,inactive
. Some operations are denied when status is notactive
.- {[key: string]: any}
A mapping of tags to assign to the resource.
- version string
Elasticsearch version. Supported values:
5.5.3_with_X-Pack
,6.3_with_X-Pack
,6.7_with_X-Pack
,6.8_with_X-Pack
,7.4_with_X-Pack
and7.7_with_X-Pack
.- vswitch
Id string The ID of VSwitch.
- zone
Count number The Multi-AZ supported for Elasticsearch, between 1 and 3. The
data_node_amount
value must be an integral multiple of thezone_count
value.
- auto_
renew_ intduration Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when
instance_charge_type
isPrePaid
andrenew_status
isAutoRenewal
.- client_
node_ intamount The Elasticsearch cluster's client node quantity, between 2 and 25.
- client_
node_ strspec The client node spec. If specified, client node will be created.
- data_
node_ intamount The Elasticsearch cluster's data node quantity, between 2 and 50.
- data_
node_ booldisk_ encrypted If encrypt the data node disk. Valid values are
true
,false
. Default tofalse
.- data_
node_ strdisk_ performance_ level Cloud disk performance level. Valid values are
PL0
,PL1
,PL2
,PL3
. Thedata_node_disk_type
muse becloud_essd
.- data_
node_ intdisk_ size The single data node storage space.
- data_
node_ strdisk_ type The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
- data_
node_ strspec The data node specifications of the Elasticsearch instance.
- description str
The description of instance. It a string of 0 to 30 characters.
- domain str
Instance connection domain (only VPC network access supported).
- enable_
kibana_ boolprivate_ network Bool, default to false. When it set to true, the instance can close kibana private network access。
- enable_
kibana_ boolpublic_ network Bool, default to true. When it set to false, the instance can enable kibana public network access。
- enable_
public bool Bool, default to false. When it set to true, the instance can enable public network access。
- instance_
charge_ strtype Valid values are
PrePaid
,PostPaid
. Default toPostPaid
. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype fromPostPaid
toPrePaid
, the following attributes are required:period
. But, updating fromPostPaid
toPrePaid
is not supported.- kibana_
domain str Kibana console domain (Internet access supported).
- kibana_
node_ strspec The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small
.- kibana_
port int Kibana console port.
- kibana_
private_ Sequence[str]whitelists Set the Kibana's IP whitelist in private network.
- kibana_
whitelists Sequence[str] Set the Kibana's IP whitelist in internet network.
- kms_
encrypted_ strpassword An KMS encrypts password used to an instance. If the
password
is filled in, this field will be ignored, but you have to specify one ofpassword
andkms_encrypted_password
fields.- kms_
encryption_ Mapping[str, Any]context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- master_
node_ strdisk_ type The single master node storage space. Valid values are
PrePaid
,PostPaid
.- master_
node_ strspec The dedicated master node spec. If specified, dedicated master node will be created.
- password str
The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (
!@#$%^&*()_+-=
).- period int
The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is
PrePaid
. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaid
instance.- port int
Instance connection port.
- private_
whitelists Sequence[str] Set the instance's IP whitelist in VPC network.
- protocol str
Elasticsearch protocol. Supported values:
HTTP
,HTTPS
.default isHTTP
.- public_
domain str Instance connection public domain.
- public_
port int Instance connection public port.
- public_
whitelists Sequence[str] Set the instance's IP whitelist in internet network.
- renew_
status str The renewal status of the specified instance. Valid values:
AutoRenewal
,ManualRenewal
,NotRenewal
.Theinstance_charge_type
must bePrePaid
.- renewal_
duration_ strunit Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values:
M
,Y
.- resource_
group_ strid The ID of resource group which the Elasticsearch instance belongs.
- setting_
config Mapping[str, Any] The YML configuration of the instance.Detailed introduction.
- status str
The Elasticsearch instance status. Includes
active
,activating
,inactive
. Some operations are denied when status is notactive
.- Mapping[str, Any]
A mapping of tags to assign to the resource.
- version str
Elasticsearch version. Supported values:
5.5.3_with_X-Pack
,6.3_with_X-Pack
,6.7_with_X-Pack
,6.8_with_X-Pack
,7.4_with_X-Pack
and7.7_with_X-Pack
.- vswitch_
id str The ID of VSwitch.
- zone_
count int The Multi-AZ supported for Elasticsearch, between 1 and 3. The
data_node_amount
value must be an integral multiple of thezone_count
value.
- auto
Renew NumberDuration Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when
instance_charge_type
isPrePaid
andrenew_status
isAutoRenewal
.- client
Node NumberAmount The Elasticsearch cluster's client node quantity, between 2 and 25.
- client
Node StringSpec The client node spec. If specified, client node will be created.
- data
Node NumberAmount The Elasticsearch cluster's data node quantity, between 2 and 50.
- data
Node BooleanDisk Encrypted If encrypt the data node disk. Valid values are
true
,false
. Default tofalse
.- data
Node StringDisk Performance Level Cloud disk performance level. Valid values are
PL0
,PL1
,PL2
,PL3
. Thedata_node_disk_type
muse becloud_essd
.- data
Node NumberDisk Size The single data node storage space.
- data
Node StringDisk Type The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
- data
Node StringSpec The data node specifications of the Elasticsearch instance.
- description String
The description of instance. It a string of 0 to 30 characters.
- domain String
Instance connection domain (only VPC network access supported).
- enable
Kibana BooleanPrivate Network Bool, default to false. When it set to true, the instance can close kibana private network access。
- enable
Kibana BooleanPublic Network Bool, default to true. When it set to false, the instance can enable kibana public network access。
- enable
Public Boolean Bool, default to false. When it set to true, the instance can enable public network access。
- instance
Charge StringType Valid values are
PrePaid
,PostPaid
. Default toPostPaid
. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype fromPostPaid
toPrePaid
, the following attributes are required:period
. But, updating fromPostPaid
toPrePaid
is not supported.- kibana
Domain String Kibana console domain (Internet access supported).
- kibana
Node StringSpec The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small
.- kibana
Port Number Kibana console port.
- kibana
Private List<String>Whitelists Set the Kibana's IP whitelist in private network.
- kibana
Whitelists List<String> Set the Kibana's IP whitelist in internet network.
- kms
Encrypted StringPassword An KMS encrypts password used to an instance. If the
password
is filled in, this field will be ignored, but you have to specify one ofpassword
andkms_encrypted_password
fields.- kms
Encryption Map<Any>Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- master
Node StringDisk Type The single master node storage space. Valid values are
PrePaid
,PostPaid
.- master
Node StringSpec The dedicated master node spec. If specified, dedicated master node will be created.
- password String
The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (
!@#$%^&*()_+-=
).- period Number
The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is
PrePaid
. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaid
instance.- port Number
Instance connection port.
- private
Whitelists List<String> Set the instance's IP whitelist in VPC network.
- protocol String
Elasticsearch protocol. Supported values:
HTTP
,HTTPS
.default isHTTP
.- public
Domain String Instance connection public domain.
- public
Port Number Instance connection public port.
- public
Whitelists List<String> Set the instance's IP whitelist in internet network.
- renew
Status String The renewal status of the specified instance. Valid values:
AutoRenewal
,ManualRenewal
,NotRenewal
.Theinstance_charge_type
must bePrePaid
.- renewal
Duration StringUnit Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values:
M
,Y
.- resource
Group StringId The ID of resource group which the Elasticsearch instance belongs.
- setting
Config Map<Any> The YML configuration of the instance.Detailed introduction.
- status String
The Elasticsearch instance status. Includes
active
,activating
,inactive
. Some operations are denied when status is notactive
.- Map<Any>
A mapping of tags to assign to the resource.
- version String
Elasticsearch version. Supported values:
5.5.3_with_X-Pack
,6.3_with_X-Pack
,6.7_with_X-Pack
,6.8_with_X-Pack
,7.4_with_X-Pack
and7.7_with_X-Pack
.- vswitch
Id String The ID of VSwitch.
- zone
Count Number The Multi-AZ supported for Elasticsearch, between 1 and 3. The
data_node_amount
value must be an integral multiple of thezone_count
value.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
alicloud
Terraform Provider.