Alibaba Cloud v3.63.0 published on Monday, Sep 30, 2024 by Pulumi
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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
@overload
def Instance(resource_name: str,
args: InstanceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Instance(resource_name: str,
opts: Optional[ResourceOptions] = None,
data_node_disk_size: Optional[int] = None,
vswitch_id: Optional[str] = None,
version: Optional[str] = None,
data_node_amount: Optional[int] = None,
data_node_spec: Optional[str] = None,
data_node_disk_type: Optional[str] = None,
master_node_disk_type: Optional[str] = None,
period: Optional[int] = None,
data_node_disk_encrypted: Optional[bool] = 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_security_group_id: 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, str]] = None,
auto_renew_duration: Optional[int] = None,
master_node_spec: Optional[str] = None,
password: Optional[str] = None,
data_node_disk_performance_level: Optional[str] = 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, str]] = None,
tags: Optional[Mapping[str, str]] = None,
client_node_spec: Optional[str] = None,
client_node_amount: Optional[int] = None,
warm_node_amount: Optional[int] = None,
warm_node_disk_encrypted: Optional[bool] = None,
warm_node_disk_size: Optional[int] = None,
warm_node_disk_type: Optional[str] = None,
warm_node_spec: Optional[str] = None,
zone_count: Optional[int] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampleinstanceResourceResourceFromElasticsearchinstance = new AliCloud.ElasticSearch.Instance("exampleinstanceResourceResourceFromElasticsearchinstance", new()
{
DataNodeDiskSize = 0,
VswitchId = "string",
Version = "string",
DataNodeAmount = 0,
DataNodeSpec = "string",
DataNodeDiskType = "string",
MasterNodeDiskType = "string",
Period = 0,
DataNodeDiskEncrypted = false,
Description = "string",
EnableKibanaPrivateNetwork = false,
EnableKibanaPublicNetwork = false,
EnablePublic = false,
InstanceChargeType = "string",
KibanaNodeSpec = "string",
KibanaPrivateSecurityGroupId = "string",
KibanaPrivateWhitelists = new[]
{
"string",
},
KibanaWhitelists = new[]
{
"string",
},
KmsEncryptedPassword = "string",
KmsEncryptionContext =
{
{ "string", "string" },
},
AutoRenewDuration = 0,
MasterNodeSpec = "string",
Password = "string",
DataNodeDiskPerformanceLevel = "string",
PrivateWhitelists = new[]
{
"string",
},
Protocol = "string",
PublicWhitelists = new[]
{
"string",
},
RenewStatus = "string",
RenewalDurationUnit = "string",
ResourceGroupId = "string",
SettingConfig =
{
{ "string", "string" },
},
Tags =
{
{ "string", "string" },
},
ClientNodeSpec = "string",
ClientNodeAmount = 0,
WarmNodeAmount = 0,
WarmNodeDiskEncrypted = false,
WarmNodeDiskSize = 0,
WarmNodeDiskType = "string",
WarmNodeSpec = "string",
ZoneCount = 0,
});
example, err := elasticsearch.NewInstance(ctx, "exampleinstanceResourceResourceFromElasticsearchinstance", &elasticsearch.InstanceArgs{
DataNodeDiskSize: pulumi.Int(0),
VswitchId: pulumi.String("string"),
Version: pulumi.String("string"),
DataNodeAmount: pulumi.Int(0),
DataNodeSpec: pulumi.String("string"),
DataNodeDiskType: pulumi.String("string"),
MasterNodeDiskType: pulumi.String("string"),
Period: pulumi.Int(0),
DataNodeDiskEncrypted: pulumi.Bool(false),
Description: pulumi.String("string"),
EnableKibanaPrivateNetwork: pulumi.Bool(false),
EnableKibanaPublicNetwork: pulumi.Bool(false),
EnablePublic: pulumi.Bool(false),
InstanceChargeType: pulumi.String("string"),
KibanaNodeSpec: pulumi.String("string"),
KibanaPrivateSecurityGroupId: pulumi.String("string"),
KibanaPrivateWhitelists: pulumi.StringArray{
pulumi.String("string"),
},
KibanaWhitelists: pulumi.StringArray{
pulumi.String("string"),
},
KmsEncryptedPassword: pulumi.String("string"),
KmsEncryptionContext: pulumi.StringMap{
"string": pulumi.String("string"),
},
AutoRenewDuration: pulumi.Int(0),
MasterNodeSpec: pulumi.String("string"),
Password: pulumi.String("string"),
DataNodeDiskPerformanceLevel: pulumi.String("string"),
PrivateWhitelists: pulumi.StringArray{
pulumi.String("string"),
},
Protocol: pulumi.String("string"),
PublicWhitelists: pulumi.StringArray{
pulumi.String("string"),
},
RenewStatus: pulumi.String("string"),
RenewalDurationUnit: pulumi.String("string"),
ResourceGroupId: pulumi.String("string"),
SettingConfig: pulumi.StringMap{
"string": pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
ClientNodeSpec: pulumi.String("string"),
ClientNodeAmount: pulumi.Int(0),
WarmNodeAmount: pulumi.Int(0),
WarmNodeDiskEncrypted: pulumi.Bool(false),
WarmNodeDiskSize: pulumi.Int(0),
WarmNodeDiskType: pulumi.String("string"),
WarmNodeSpec: pulumi.String("string"),
ZoneCount: pulumi.Int(0),
})
var exampleinstanceResourceResourceFromElasticsearchinstance = new Instance("exampleinstanceResourceResourceFromElasticsearchinstance", InstanceArgs.builder()
.dataNodeDiskSize(0)
.vswitchId("string")
.version("string")
.dataNodeAmount(0)
.dataNodeSpec("string")
.dataNodeDiskType("string")
.masterNodeDiskType("string")
.period(0)
.dataNodeDiskEncrypted(false)
.description("string")
.enableKibanaPrivateNetwork(false)
.enableKibanaPublicNetwork(false)
.enablePublic(false)
.instanceChargeType("string")
.kibanaNodeSpec("string")
.kibanaPrivateSecurityGroupId("string")
.kibanaPrivateWhitelists("string")
.kibanaWhitelists("string")
.kmsEncryptedPassword("string")
.kmsEncryptionContext(Map.of("string", "string"))
.autoRenewDuration(0)
.masterNodeSpec("string")
.password("string")
.dataNodeDiskPerformanceLevel("string")
.privateWhitelists("string")
.protocol("string")
.publicWhitelists("string")
.renewStatus("string")
.renewalDurationUnit("string")
.resourceGroupId("string")
.settingConfig(Map.of("string", "string"))
.tags(Map.of("string", "string"))
.clientNodeSpec("string")
.clientNodeAmount(0)
.warmNodeAmount(0)
.warmNodeDiskEncrypted(false)
.warmNodeDiskSize(0)
.warmNodeDiskType("string")
.warmNodeSpec("string")
.zoneCount(0)
.build());
exampleinstance_resource_resource_from_elasticsearchinstance = alicloud.elasticsearch.Instance("exampleinstanceResourceResourceFromElasticsearchinstance",
data_node_disk_size=0,
vswitch_id="string",
version="string",
data_node_amount=0,
data_node_spec="string",
data_node_disk_type="string",
master_node_disk_type="string",
period=0,
data_node_disk_encrypted=False,
description="string",
enable_kibana_private_network=False,
enable_kibana_public_network=False,
enable_public=False,
instance_charge_type="string",
kibana_node_spec="string",
kibana_private_security_group_id="string",
kibana_private_whitelists=["string"],
kibana_whitelists=["string"],
kms_encrypted_password="string",
kms_encryption_context={
"string": "string",
},
auto_renew_duration=0,
master_node_spec="string",
password="string",
data_node_disk_performance_level="string",
private_whitelists=["string"],
protocol="string",
public_whitelists=["string"],
renew_status="string",
renewal_duration_unit="string",
resource_group_id="string",
setting_config={
"string": "string",
},
tags={
"string": "string",
},
client_node_spec="string",
client_node_amount=0,
warm_node_amount=0,
warm_node_disk_encrypted=False,
warm_node_disk_size=0,
warm_node_disk_type="string",
warm_node_spec="string",
zone_count=0)
const exampleinstanceResourceResourceFromElasticsearchinstance = new alicloud.elasticsearch.Instance("exampleinstanceResourceResourceFromElasticsearchinstance", {
dataNodeDiskSize: 0,
vswitchId: "string",
version: "string",
dataNodeAmount: 0,
dataNodeSpec: "string",
dataNodeDiskType: "string",
masterNodeDiskType: "string",
period: 0,
dataNodeDiskEncrypted: false,
description: "string",
enableKibanaPrivateNetwork: false,
enableKibanaPublicNetwork: false,
enablePublic: false,
instanceChargeType: "string",
kibanaNodeSpec: "string",
kibanaPrivateSecurityGroupId: "string",
kibanaPrivateWhitelists: ["string"],
kibanaWhitelists: ["string"],
kmsEncryptedPassword: "string",
kmsEncryptionContext: {
string: "string",
},
autoRenewDuration: 0,
masterNodeSpec: "string",
password: "string",
dataNodeDiskPerformanceLevel: "string",
privateWhitelists: ["string"],
protocol: "string",
publicWhitelists: ["string"],
renewStatus: "string",
renewalDurationUnit: "string",
resourceGroupId: "string",
settingConfig: {
string: "string",
},
tags: {
string: "string",
},
clientNodeSpec: "string",
clientNodeAmount: 0,
warmNodeAmount: 0,
warmNodeDiskEncrypted: false,
warmNodeDiskSize: 0,
warmNodeDiskType: "string",
warmNodeSpec: "string",
zoneCount: 0,
});
type: alicloud:elasticsearch:Instance
properties:
autoRenewDuration: 0
clientNodeAmount: 0
clientNodeSpec: string
dataNodeAmount: 0
dataNodeDiskEncrypted: false
dataNodeDiskPerformanceLevel: string
dataNodeDiskSize: 0
dataNodeDiskType: string
dataNodeSpec: string
description: string
enableKibanaPrivateNetwork: false
enableKibanaPublicNetwork: false
enablePublic: false
instanceChargeType: string
kibanaNodeSpec: string
kibanaPrivateSecurityGroupId: string
kibanaPrivateWhitelists:
- string
kibanaWhitelists:
- string
kmsEncryptedPassword: string
kmsEncryptionContext:
string: string
masterNodeDiskType: string
masterNodeSpec: string
password: string
period: 0
privateWhitelists:
- string
protocol: string
publicWhitelists:
- string
renewStatus: string
renewalDurationUnit: string
resourceGroupId: string
settingConfig:
string: string
tags:
string: string
version: string
vswitchId: string
warmNodeAmount: 0
warmNodeDiskEncrypted: false
warmNodeDiskSize: 0
warmNodeDiskType: string
warmNodeSpec: string
zoneCount: 0
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
,7.7_with_X-Pack
,7.10_with_X-Pack
,7.16_with_X-Pack
,8.5_with_X-Pack
,8.9_with_X-Pack
,8.13_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 stringSecurity Group Id - the security group id associated with Kibana private network, this param is required when
enable_kibana_private_network
set true, and the security group id should in the same VPC asvswitch_id
- Kibana
Private List<string>Whitelists - Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use
kibana_private_security_group_id
instead - 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, string>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, string> - The YML configuration of the instance.Detailed introduction.
- Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Warm
Node intAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- Warm
Node boolDisk Encrypted - If encrypt the warm node disk. Valid values are
true
,false
. Default tofalse
. - Warm
Node intDisk Size - The single warm node storage space, should between 500 and 20480
- Warm
Node stringDisk Type - The warm node disk type. Supported values: cloud_efficiency.
- Warm
Node stringSpec - The warm node specifications of the Elasticsearch instance.
- 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
,7.7_with_X-Pack
,7.10_with_X-Pack
,7.16_with_X-Pack
,8.5_with_X-Pack
,8.9_with_X-Pack
,8.13_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 stringSecurity Group Id - the security group id associated with Kibana private network, this param is required when
enable_kibana_private_network
set true, and the security group id should in the same VPC asvswitch_id
- Kibana
Private []stringWhitelists - Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use
kibana_private_security_group_id
instead - 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]stringContext - 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]string - The YML configuration of the instance.Detailed introduction.
- map[string]string
- A mapping of tags to assign to the resource.
- Warm
Node intAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- Warm
Node boolDisk Encrypted - If encrypt the warm node disk. Valid values are
true
,false
. Default tofalse
. - Warm
Node intDisk Size - The single warm node storage space, should between 500 and 20480
- Warm
Node stringDisk Type - The warm node disk type. Supported values: cloud_efficiency.
- Warm
Node stringSpec - The warm node specifications of the Elasticsearch instance.
- 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
,7.7_with_X-Pack
,7.10_with_X-Pack
,7.16_with_X-Pack
,8.5_with_X-Pack
,8.9_with_X-Pack
,8.13_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 StringSecurity Group Id - the security group id associated with Kibana private network, this param is required when
enable_kibana_private_network
set true, and the security group id should in the same VPC asvswitch_id
- kibana
Private List<String>Whitelists - Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use
kibana_private_security_group_id
instead - 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,String>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,String> - The YML configuration of the instance.Detailed introduction.
- Map<String,String>
- A mapping of tags to assign to the resource.
- warm
Node IntegerAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm
Node BooleanDisk Encrypted - If encrypt the warm node disk. Valid values are
true
,false
. Default tofalse
. - warm
Node IntegerDisk Size - The single warm node storage space, should between 500 and 20480
- warm
Node StringDisk Type - The warm node disk type. Supported values: cloud_efficiency.
- warm
Node StringSpec - The warm node specifications of the Elasticsearch instance.
- 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
,7.7_with_X-Pack
,7.10_with_X-Pack
,7.16_with_X-Pack
,8.5_with_X-Pack
,8.9_with_X-Pack
,8.13_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 stringSecurity Group Id - the security group id associated with Kibana private network, this param is required when
enable_kibana_private_network
set true, and the security group id should in the same VPC asvswitch_id
- kibana
Private string[]Whitelists - Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use
kibana_private_security_group_id
instead - 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]: string}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]: string} - The YML configuration of the instance.Detailed introduction.
- {[key: string]: string}
- A mapping of tags to assign to the resource.
- warm
Node numberAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm
Node booleanDisk Encrypted - If encrypt the warm node disk. Valid values are
true
,false
. Default tofalse
. - warm
Node numberDisk Size - The single warm node storage space, should between 500 and 20480
- warm
Node stringDisk Type - The warm node disk type. Supported values: cloud_efficiency.
- warm
Node stringSpec - The warm node specifications of the Elasticsearch instance.
- 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
,7.7_with_X-Pack
,7.10_with_X-Pack
,7.16_with_X-Pack
,8.5_with_X-Pack
,8.9_with_X-Pack
,8.13_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_ strsecurity_ group_ id - the security group id associated with Kibana private network, this param is required when
enable_kibana_private_network
set true, and the security group id should in the same VPC asvswitch_id
- kibana_
private_ Sequence[str]whitelists - Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use
kibana_private_security_group_id
instead - 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, str]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, str] - The YML configuration of the instance.Detailed introduction.
- Mapping[str, str]
- A mapping of tags to assign to the resource.
- warm_
node_ intamount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm_
node_ booldisk_ encrypted - If encrypt the warm node disk. Valid values are
true
,false
. Default tofalse
. - warm_
node_ intdisk_ size - The single warm node storage space, should between 500 and 20480
- warm_
node_ strdisk_ type - The warm node disk type. Supported values: cloud_efficiency.
- warm_
node_ strspec - The warm node specifications of the Elasticsearch instance.
- 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
,7.7_with_X-Pack
,7.10_with_X-Pack
,7.16_with_X-Pack
,8.5_with_X-Pack
,8.9_with_X-Pack
,8.13_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 StringSecurity Group Id - the security group id associated with Kibana private network, this param is required when
enable_kibana_private_network
set true, and the security group id should in the same VPC asvswitch_id
- kibana
Private List<String>Whitelists - Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use
kibana_private_security_group_id
instead - 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>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<String> - The YML configuration of the instance.Detailed introduction.
- Map<String>
- A mapping of tags to assign to the resource.
- warm
Node NumberAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm
Node BooleanDisk Encrypted - If encrypt the warm node disk. Valid values are
true
,false
. Default tofalse
. - warm
Node NumberDisk Size - The single warm node storage space, should between 500 and 20480
- warm
Node StringDisk Type - The warm node disk type. Supported values: cloud_efficiency.
- warm
Node StringSpec - The warm node specifications of the Elasticsearch instance.
- 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_security_group_id: 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, str]] = 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, str]] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
version: Optional[str] = None,
vswitch_id: Optional[str] = None,
warm_node_amount: Optional[int] = None,
warm_node_disk_encrypted: Optional[bool] = None,
warm_node_disk_size: Optional[int] = None,
warm_node_disk_type: Optional[str] = None,
warm_node_spec: 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 stringSecurity Group Id - the security group id associated with Kibana private network, this param is required when
enable_kibana_private_network
set true, and the security group id should in the same VPC asvswitch_id
- Kibana
Private List<string>Whitelists - Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use
kibana_private_security_group_id
instead - 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, string>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, string> - 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, string>
- 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
,7.7_with_X-Pack
,7.10_with_X-Pack
,7.16_with_X-Pack
,8.5_with_X-Pack
,8.9_with_X-Pack
,8.13_with_X-Pack
. - Vswitch
Id string - The ID of VSwitch.
- Warm
Node intAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- Warm
Node boolDisk Encrypted - If encrypt the warm node disk. Valid values are
true
,false
. Default tofalse
. - Warm
Node intDisk Size - The single warm node storage space, should between 500 and 20480
- Warm
Node stringDisk Type - The warm node disk type. Supported values: cloud_efficiency.
- Warm
Node stringSpec - The warm node specifications of the Elasticsearch instance.
- 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 stringSecurity Group Id - the security group id associated with Kibana private network, this param is required when
enable_kibana_private_network
set true, and the security group id should in the same VPC asvswitch_id
- Kibana
Private []stringWhitelists - Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use
kibana_private_security_group_id
instead - 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]stringContext - 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]string - 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]string
- 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
,7.7_with_X-Pack
,7.10_with_X-Pack
,7.16_with_X-Pack
,8.5_with_X-Pack
,8.9_with_X-Pack
,8.13_with_X-Pack
. - Vswitch
Id string - The ID of VSwitch.
- Warm
Node intAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- Warm
Node boolDisk Encrypted - If encrypt the warm node disk. Valid values are
true
,false
. Default tofalse
. - Warm
Node intDisk Size - The single warm node storage space, should between 500 and 20480
- Warm
Node stringDisk Type - The warm node disk type. Supported values: cloud_efficiency.
- Warm
Node stringSpec - The warm node specifications of the Elasticsearch instance.
- 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 StringSecurity Group Id - the security group id associated with Kibana private network, this param is required when
enable_kibana_private_network
set true, and the security group id should in the same VPC asvswitch_id
- kibana
Private List<String>Whitelists - Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use
kibana_private_security_group_id
instead - 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,String>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,String> - 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,String>
- 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
,7.7_with_X-Pack
,7.10_with_X-Pack
,7.16_with_X-Pack
,8.5_with_X-Pack
,8.9_with_X-Pack
,8.13_with_X-Pack
. - vswitch
Id String - The ID of VSwitch.
- warm
Node IntegerAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm
Node BooleanDisk Encrypted - If encrypt the warm node disk. Valid values are
true
,false
. Default tofalse
. - warm
Node IntegerDisk Size - The single warm node storage space, should between 500 and 20480
- warm
Node StringDisk Type - The warm node disk type. Supported values: cloud_efficiency.
- warm
Node StringSpec - The warm node specifications of the Elasticsearch instance.
- 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 stringSecurity Group Id - the security group id associated with Kibana private network, this param is required when
enable_kibana_private_network
set true, and the security group id should in the same VPC asvswitch_id
- kibana
Private string[]Whitelists - Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use
kibana_private_security_group_id
instead - 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]: string}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]: string} - 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]: string}
- 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
,7.7_with_X-Pack
,7.10_with_X-Pack
,7.16_with_X-Pack
,8.5_with_X-Pack
,8.9_with_X-Pack
,8.13_with_X-Pack
. - vswitch
Id string - The ID of VSwitch.
- warm
Node numberAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm
Node booleanDisk Encrypted - If encrypt the warm node disk. Valid values are
true
,false
. Default tofalse
. - warm
Node numberDisk Size - The single warm node storage space, should between 500 and 20480
- warm
Node stringDisk Type - The warm node disk type. Supported values: cloud_efficiency.
- warm
Node stringSpec - The warm node specifications of the Elasticsearch instance.
- 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_ strsecurity_ group_ id - the security group id associated with Kibana private network, this param is required when
enable_kibana_private_network
set true, and the security group id should in the same VPC asvswitch_id
- kibana_
private_ Sequence[str]whitelists - Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use
kibana_private_security_group_id
instead - 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, str]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, str] - 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, str]
- 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
,7.7_with_X-Pack
,7.10_with_X-Pack
,7.16_with_X-Pack
,8.5_with_X-Pack
,8.9_with_X-Pack
,8.13_with_X-Pack
. - vswitch_
id str - The ID of VSwitch.
- warm_
node_ intamount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm_
node_ booldisk_ encrypted - If encrypt the warm node disk. Valid values are
true
,false
. Default tofalse
. - warm_
node_ intdisk_ size - The single warm node storage space, should between 500 and 20480
- warm_
node_ strdisk_ type - The warm node disk type. Supported values: cloud_efficiency.
- warm_
node_ strspec - The warm node specifications of the Elasticsearch instance.
- 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 StringSecurity Group Id - the security group id associated with Kibana private network, this param is required when
enable_kibana_private_network
set true, and the security group id should in the same VPC asvswitch_id
- kibana
Private List<String>Whitelists - Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use
kibana_private_security_group_id
instead - 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>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<String> - 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>
- 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
,7.7_with_X-Pack
,7.10_with_X-Pack
,7.16_with_X-Pack
,8.5_with_X-Pack
,8.9_with_X-Pack
,8.13_with_X-Pack
. - vswitch
Id String - The ID of VSwitch.
- warm
Node NumberAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm
Node BooleanDisk Encrypted - If encrypt the warm node disk. Valid values are
true
,false
. Default tofalse
. - warm
Node NumberDisk Size - The single warm node storage space, should between 500 and 20480
- warm
Node StringDisk Type - The warm node disk type. Supported values: cloud_efficiency.
- warm
Node StringSpec - The warm node specifications of the Elasticsearch instance.
- 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.