published on Saturday, Mar 14, 2026 by Pulumi
published on Saturday, Mar 14, 2026 by Pulumi
Provides a Elasticsearch Instance resource.
For information about Elasticsearch Instance and how to use it, see What is Instance.
NOTE: Available since v1.30.0.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "tf-example";
const _default = alicloud.elasticsearch.getZones({});
const defaultNetwork = new alicloud.vpc.Network("default", {
vpcName: name,
cidrBlock: "10.0.0.0/8",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
vswitchName: name,
cidrBlock: "10.1.0.0/16",
vpcId: defaultNetwork.id,
zoneId: _default.then(_default => _default.zones?.[0]?.id),
});
const defaultInstance = new alicloud.elasticsearch.Instance("default", {
description: name,
vswitchId: defaultSwitch.id,
password: "Examplw1234",
version: "7.10_with_X-Pack",
paymentType: "PayAsYouGo",
dataNodeAmount: 2,
dataNodeSpec: "elasticsearch.sn2ne.large",
dataNodeDiskSize: 20,
dataNodeDiskType: "cloud_ssd",
kibanaNodeSpec: "elasticsearch.sn2ne.large",
dataNodeDiskPerformanceLevel: "PL1",
tags: {
Created: "TF",
For: "example",
},
});
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "tf-example"
default = alicloud.elasticsearch.get_zones()
default_network = alicloud.vpc.Network("default",
vpc_name=name,
cidr_block="10.0.0.0/8")
default_switch = alicloud.vpc.Switch("default",
vswitch_name=name,
cidr_block="10.1.0.0/16",
vpc_id=default_network.id,
zone_id=default.zones[0].id)
default_instance = alicloud.elasticsearch.Instance("default",
description=name,
vswitch_id=default_switch.id,
password="Examplw1234",
version="7.10_with_X-Pack",
payment_type="PayAsYouGo",
data_node_amount=2,
data_node_spec="elasticsearch.sn2ne.large",
data_node_disk_size=20,
data_node_disk_type="cloud_ssd",
kibana_node_spec="elasticsearch.sn2ne.large",
data_node_disk_performance_level="PL1",
tags={
"Created": "TF",
"For": "example",
})
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/elasticsearch"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
name := "tf-example"
if param := cfg.Get("name"); param != "" {
name = param
}
_default, err := elasticsearch.GetZones(ctx, &elasticsearch.GetZonesArgs{}, nil)
if err != nil {
return err
}
defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
VpcName: pulumi.String(name),
CidrBlock: pulumi.String("10.0.0.0/8"),
})
if err != nil {
return err
}
defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
VswitchName: pulumi.String(name),
CidrBlock: pulumi.String("10.1.0.0/16"),
VpcId: defaultNetwork.ID(),
ZoneId: pulumi.String(_default.Zones[0].Id),
})
if err != nil {
return err
}
_, err = elasticsearch.NewInstance(ctx, "default", &elasticsearch.InstanceArgs{
Description: pulumi.String(name),
VswitchId: defaultSwitch.ID(),
Password: pulumi.String("Examplw1234"),
Version: pulumi.String("7.10_with_X-Pack"),
PaymentType: pulumi.String("PayAsYouGo"),
DataNodeAmount: pulumi.Int(2),
DataNodeSpec: pulumi.String("elasticsearch.sn2ne.large"),
DataNodeDiskSize: pulumi.Int(20),
DataNodeDiskType: pulumi.String("cloud_ssd"),
KibanaNodeSpec: pulumi.String("elasticsearch.sn2ne.large"),
DataNodeDiskPerformanceLevel: pulumi.String("PL1"),
Tags: pulumi.StringMap{
"Created": pulumi.String("TF"),
"For": pulumi.String("example"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "tf-example";
var @default = AliCloud.ElasticSearch.GetZones.Invoke();
var defaultNetwork = new AliCloud.Vpc.Network("default", new()
{
VpcName = name,
CidrBlock = "10.0.0.0/8",
});
var defaultSwitch = new AliCloud.Vpc.Switch("default", new()
{
VswitchName = name,
CidrBlock = "10.1.0.0/16",
VpcId = defaultNetwork.Id,
ZoneId = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Zones[0]?.Id)),
});
var defaultInstance = new AliCloud.ElasticSearch.Instance("default", new()
{
Description = name,
VswitchId = defaultSwitch.Id,
Password = "Examplw1234",
Version = "7.10_with_X-Pack",
PaymentType = "PayAsYouGo",
DataNodeAmount = 2,
DataNodeSpec = "elasticsearch.sn2ne.large",
DataNodeDiskSize = 20,
DataNodeDiskType = "cloud_ssd",
KibanaNodeSpec = "elasticsearch.sn2ne.large",
DataNodeDiskPerformanceLevel = "PL1",
Tags =
{
{ "Created", "TF" },
{ "For", "example" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.elasticsearch.ElasticsearchFunctions;
import com.pulumi.alicloud.elasticsearch.inputs.GetZonesArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.elasticsearch.Instance;
import com.pulumi.alicloud.elasticsearch.InstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var name = config.get("name").orElse("tf-example");
final var default = ElasticsearchFunctions.getZones(GetZonesArgs.builder()
.build());
var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
.vpcName(name)
.cidrBlock("10.0.0.0/8")
.build());
var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
.vswitchName(name)
.cidrBlock("10.1.0.0/16")
.vpcId(defaultNetwork.id())
.zoneId(default_.zones()[0].id())
.build());
var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
.description(name)
.vswitchId(defaultSwitch.id())
.password("Examplw1234")
.version("7.10_with_X-Pack")
.paymentType("PayAsYouGo")
.dataNodeAmount(2)
.dataNodeSpec("elasticsearch.sn2ne.large")
.dataNodeDiskSize(20)
.dataNodeDiskType("cloud_ssd")
.kibanaNodeSpec("elasticsearch.sn2ne.large")
.dataNodeDiskPerformanceLevel("PL1")
.tags(Map.ofEntries(
Map.entry("Created", "TF"),
Map.entry("For", "example")
))
.build());
}
}
configuration:
name:
type: string
default: tf-example
resources:
defaultNetwork:
type: alicloud:vpc:Network
name: default
properties:
vpcName: ${name}
cidrBlock: 10.0.0.0/8
defaultSwitch:
type: alicloud:vpc:Switch
name: default
properties:
vswitchName: ${name}
cidrBlock: 10.1.0.0/16
vpcId: ${defaultNetwork.id}
zoneId: ${default.zones[0].id}
defaultInstance:
type: alicloud:elasticsearch:Instance
name: default
properties:
description: ${name}
vswitchId: ${defaultSwitch.id}
password: Examplw1234
version: 7.10_with_X-Pack
paymentType: PayAsYouGo
dataNodeAmount: '2'
dataNodeSpec: elasticsearch.sn2ne.large
dataNodeDiskSize: '20'
dataNodeDiskType: cloud_ssd
kibanaNodeSpec: elasticsearch.sn2ne.large
dataNodeDiskPerformanceLevel: PL1
tags:
Created: TF
For: example
variables:
default:
fn::invoke:
function: alicloud:elasticsearch:getZones
arguments: {}
📚 Need more examples? VIEW MORE EXAMPLES
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,
version: Optional[str] = None,
vswitch_id: Optional[str] = None,
auto_renew_duration: Optional[int] = None,
client_node_amount: Optional[int] = None,
client_node_configuration: Optional[InstanceClientNodeConfigurationArgs] = None,
client_node_spec: Optional[str] = None,
data_node_amount: Optional[int] = None,
data_node_configuration: Optional[InstanceDataNodeConfigurationArgs] = 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,
force: Optional[bool] = None,
instance_category: Optional[str] = None,
instance_charge_type: Optional[str] = None,
kibana_configuration: Optional[InstanceKibanaConfigurationArgs] = 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,
master_configuration: Optional[InstanceMasterConfigurationArgs] = None,
master_node_disk_type: Optional[str] = None,
master_node_spec: Optional[str] = None,
order_action_type: Optional[str] = None,
password: Optional[str] = None,
payment_type: 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, str]] = None,
tags: Optional[Mapping[str, str]] = None,
update_strategy: Optional[str] = None,
warm_node_amount: Optional[int] = None,
warm_node_configuration: Optional[InstanceWarmNodeConfigurationArgs] = 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()
{
Version = "string",
VswitchId = "string",
AutoRenewDuration = 0,
ClientNodeConfiguration = new AliCloud.ElasticSearch.Inputs.InstanceClientNodeConfigurationArgs
{
Amount = 0,
Disk = 0,
DiskType = "string",
Spec = "string",
},
DataNodeConfiguration = new AliCloud.ElasticSearch.Inputs.InstanceDataNodeConfigurationArgs
{
Spec = "string",
Amount = 0,
Disk = 0,
DiskEncryption = false,
DiskType = "string",
PerformanceLevel = "string",
},
Description = "string",
EnableKibanaPrivateNetwork = false,
EnableKibanaPublicNetwork = false,
EnablePublic = false,
Force = false,
InstanceCategory = "string",
KibanaConfiguration = new AliCloud.ElasticSearch.Inputs.InstanceKibanaConfigurationArgs
{
Spec = "string",
Amount = 0,
Disk = 0,
},
KibanaPrivateSecurityGroupId = "string",
KibanaPrivateWhitelists = new[]
{
"string",
},
KibanaWhitelists = new[]
{
"string",
},
KmsEncryptedPassword = "string",
KmsEncryptionContext =
{
{ "string", "string" },
},
MasterConfiguration = new AliCloud.ElasticSearch.Inputs.InstanceMasterConfigurationArgs
{
Amount = 0,
Disk = 0,
DiskType = "string",
Spec = "string",
},
OrderActionType = "string",
Password = "string",
PaymentType = "string",
Period = 0,
PrivateWhitelists = new[]
{
"string",
},
Protocol = "string",
PublicWhitelists = new[]
{
"string",
},
RenewStatus = "string",
RenewalDurationUnit = "string",
ResourceGroupId = "string",
SettingConfig =
{
{ "string", "string" },
},
Tags =
{
{ "string", "string" },
},
UpdateStrategy = "string",
WarmNodeConfiguration = new AliCloud.ElasticSearch.Inputs.InstanceWarmNodeConfigurationArgs
{
Amount = 0,
Disk = 0,
DiskEncryption = false,
DiskType = "string",
Spec = "string",
},
ZoneCount = 0,
});
example, err := elasticsearch.NewInstance(ctx, "exampleinstanceResourceResourceFromElasticsearchinstance", &elasticsearch.InstanceArgs{
Version: pulumi.String("string"),
VswitchId: pulumi.String("string"),
AutoRenewDuration: pulumi.Int(0),
ClientNodeConfiguration: &elasticsearch.InstanceClientNodeConfigurationArgs{
Amount: pulumi.Int(0),
Disk: pulumi.Int(0),
DiskType: pulumi.String("string"),
Spec: pulumi.String("string"),
},
DataNodeConfiguration: &elasticsearch.InstanceDataNodeConfigurationArgs{
Spec: pulumi.String("string"),
Amount: pulumi.Int(0),
Disk: pulumi.Int(0),
DiskEncryption: pulumi.Bool(false),
DiskType: pulumi.String("string"),
PerformanceLevel: pulumi.String("string"),
},
Description: pulumi.String("string"),
EnableKibanaPrivateNetwork: pulumi.Bool(false),
EnableKibanaPublicNetwork: pulumi.Bool(false),
EnablePublic: pulumi.Bool(false),
Force: pulumi.Bool(false),
InstanceCategory: pulumi.String("string"),
KibanaConfiguration: &elasticsearch.InstanceKibanaConfigurationArgs{
Spec: pulumi.String("string"),
Amount: pulumi.Int(0),
Disk: pulumi.Int(0),
},
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"),
},
MasterConfiguration: &elasticsearch.InstanceMasterConfigurationArgs{
Amount: pulumi.Int(0),
Disk: pulumi.Int(0),
DiskType: pulumi.String("string"),
Spec: pulumi.String("string"),
},
OrderActionType: pulumi.String("string"),
Password: pulumi.String("string"),
PaymentType: pulumi.String("string"),
Period: pulumi.Int(0),
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"),
},
UpdateStrategy: pulumi.String("string"),
WarmNodeConfiguration: &elasticsearch.InstanceWarmNodeConfigurationArgs{
Amount: pulumi.Int(0),
Disk: pulumi.Int(0),
DiskEncryption: pulumi.Bool(false),
DiskType: pulumi.String("string"),
Spec: pulumi.String("string"),
},
ZoneCount: pulumi.Int(0),
})
var exampleinstanceResourceResourceFromElasticsearchinstance = new com.pulumi.alicloud.elasticsearch.Instance("exampleinstanceResourceResourceFromElasticsearchinstance", com.pulumi.alicloud.elasticsearch.InstanceArgs.builder()
.version("string")
.vswitchId("string")
.autoRenewDuration(0)
.clientNodeConfiguration(InstanceClientNodeConfigurationArgs.builder()
.amount(0)
.disk(0)
.diskType("string")
.spec("string")
.build())
.dataNodeConfiguration(InstanceDataNodeConfigurationArgs.builder()
.spec("string")
.amount(0)
.disk(0)
.diskEncryption(false)
.diskType("string")
.performanceLevel("string")
.build())
.description("string")
.enableKibanaPrivateNetwork(false)
.enableKibanaPublicNetwork(false)
.enablePublic(false)
.force(false)
.instanceCategory("string")
.kibanaConfiguration(InstanceKibanaConfigurationArgs.builder()
.spec("string")
.amount(0)
.disk(0)
.build())
.kibanaPrivateSecurityGroupId("string")
.kibanaPrivateWhitelists("string")
.kibanaWhitelists("string")
.kmsEncryptedPassword("string")
.kmsEncryptionContext(Map.of("string", "string"))
.masterConfiguration(InstanceMasterConfigurationArgs.builder()
.amount(0)
.disk(0)
.diskType("string")
.spec("string")
.build())
.orderActionType("string")
.password("string")
.paymentType("string")
.period(0)
.privateWhitelists("string")
.protocol("string")
.publicWhitelists("string")
.renewStatus("string")
.renewalDurationUnit("string")
.resourceGroupId("string")
.settingConfig(Map.of("string", "string"))
.tags(Map.of("string", "string"))
.updateStrategy("string")
.warmNodeConfiguration(InstanceWarmNodeConfigurationArgs.builder()
.amount(0)
.disk(0)
.diskEncryption(false)
.diskType("string")
.spec("string")
.build())
.zoneCount(0)
.build());
exampleinstance_resource_resource_from_elasticsearchinstance = alicloud.elasticsearch.Instance("exampleinstanceResourceResourceFromElasticsearchinstance",
version="string",
vswitch_id="string",
auto_renew_duration=0,
client_node_configuration={
"amount": 0,
"disk": 0,
"disk_type": "string",
"spec": "string",
},
data_node_configuration={
"spec": "string",
"amount": 0,
"disk": 0,
"disk_encryption": False,
"disk_type": "string",
"performance_level": "string",
},
description="string",
enable_kibana_private_network=False,
enable_kibana_public_network=False,
enable_public=False,
force=False,
instance_category="string",
kibana_configuration={
"spec": "string",
"amount": 0,
"disk": 0,
},
kibana_private_security_group_id="string",
kibana_private_whitelists=["string"],
kibana_whitelists=["string"],
kms_encrypted_password="string",
kms_encryption_context={
"string": "string",
},
master_configuration={
"amount": 0,
"disk": 0,
"disk_type": "string",
"spec": "string",
},
order_action_type="string",
password="string",
payment_type="string",
period=0,
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",
},
update_strategy="string",
warm_node_configuration={
"amount": 0,
"disk": 0,
"disk_encryption": False,
"disk_type": "string",
"spec": "string",
},
zone_count=0)
const exampleinstanceResourceResourceFromElasticsearchinstance = new alicloud.elasticsearch.Instance("exampleinstanceResourceResourceFromElasticsearchinstance", {
version: "string",
vswitchId: "string",
autoRenewDuration: 0,
clientNodeConfiguration: {
amount: 0,
disk: 0,
diskType: "string",
spec: "string",
},
dataNodeConfiguration: {
spec: "string",
amount: 0,
disk: 0,
diskEncryption: false,
diskType: "string",
performanceLevel: "string",
},
description: "string",
enableKibanaPrivateNetwork: false,
enableKibanaPublicNetwork: false,
enablePublic: false,
force: false,
instanceCategory: "string",
kibanaConfiguration: {
spec: "string",
amount: 0,
disk: 0,
},
kibanaPrivateSecurityGroupId: "string",
kibanaPrivateWhitelists: ["string"],
kibanaWhitelists: ["string"],
kmsEncryptedPassword: "string",
kmsEncryptionContext: {
string: "string",
},
masterConfiguration: {
amount: 0,
disk: 0,
diskType: "string",
spec: "string",
},
orderActionType: "string",
password: "string",
paymentType: "string",
period: 0,
privateWhitelists: ["string"],
protocol: "string",
publicWhitelists: ["string"],
renewStatus: "string",
renewalDurationUnit: "string",
resourceGroupId: "string",
settingConfig: {
string: "string",
},
tags: {
string: "string",
},
updateStrategy: "string",
warmNodeConfiguration: {
amount: 0,
disk: 0,
diskEncryption: false,
diskType: "string",
spec: "string",
},
zoneCount: 0,
});
type: alicloud:elasticsearch:Instance
properties:
autoRenewDuration: 0
clientNodeConfiguration:
amount: 0
disk: 0
diskType: string
spec: string
dataNodeConfiguration:
amount: 0
disk: 0
diskEncryption: false
diskType: string
performanceLevel: string
spec: string
description: string
enableKibanaPrivateNetwork: false
enableKibanaPublicNetwork: false
enablePublic: false
force: false
instanceCategory: string
kibanaConfiguration:
amount: 0
disk: 0
spec: string
kibanaPrivateSecurityGroupId: string
kibanaPrivateWhitelists:
- string
kibanaWhitelists:
- string
kmsEncryptedPassword: string
kmsEncryptionContext:
string: string
masterConfiguration:
amount: 0
disk: 0
diskType: string
spec: string
orderActionType: string
password: string
paymentType: string
period: 0
privateWhitelists:
- string
protocol: string
publicWhitelists:
- string
renewStatus: string
renewalDurationUnit: string
resourceGroupId: string
settingConfig:
string: string
tags:
string: string
updateStrategy: string
version: string
vswitchId: string
warmNodeConfiguration:
amount: 0
disk: 0
diskEncryption: false
diskType: string
spec: 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Instance resource accepts the following input properties:
- Version string
The instance version. Valid values:
- 8.5.1_with_X-Pack
- 7.10_with_X-Pack
- 6.7_with_X-Pack
- 7.7_with_X-Pack
- 6.8_with_X-Pack
- 6.3_with_X-Pack
- 5.6_with_X-Pack
- 5.5.3_with_X-Pack
NOTE: The versions listed above might not include all versions supported by Elasticsearch instances. You can call the GetRegionConfiguration operation to view the actual supported versions.
- Vswitch
Id string - The ID of VSwitch.
- Auto
Renew intDuration - Number of auto-renewal periods.
- Client
Node intAmount - The Elasticsearch cluster's client node quantity, between 2 and 25.
- Client
Node Pulumi.Configuration Ali Cloud. Elastic Search. Inputs. Instance Client Node Configuration - Configuration of dedicated coordinating nodes in the Elasticsearch cluster. See
client_node_configurationbelow. - 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 Pulumi.Configuration Ali Cloud. Elastic Search. Inputs. Instance Data Node Configuration - Elasticsearch data node information. See
data_node_configurationbelow. - 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_typemuse 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
- Instance name, which supports fuzzy search. For example, searching for all instances containing
abcmay return instances namedabc,abcde,xyabc, orxabcy. - Enable
Kibana boolPrivate Network - Indicates whether private network access to Kibana is enabled. Valid values:
- true: Enabled
- false: Disabled
- Enable
Kibana boolPublic Network - Specifies whether to enable public access to Kibana. Valid values:
- true: Enables public access.
- false: Disables public access.
- Enable
Public bool - Specifies whether to enable a public endpoint for the instance. Valid values:
- true: Enables the public endpoint.
- false: Disables the public endpoint.
- Force bool
Whether to force a restart:
- true: Yes
- false (default): No.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- Instance
Category string - Edition type:
- x-pack: Creates a commercial edition instance, or a kernel-enhanced edition instance without Indexing Service or OpenStore enabled.
- IS: Creates a kernel-enhanced edition instance with Indexing Service or OpenStore enabled.
- 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 fromPostPaidtoPrePaid, the following attributes are required:period. Usepayment_typeinstead with valuesPayAsYouGoorSubscription. - Kibana
Configuration Pulumi.Ali Cloud. Elastic Search. Inputs. Instance Kibana Configuration - The configuration of Elasticsearch Kibana nodes. See
kibana_configurationbelow. - Kibana
Node stringSpec - The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small. - Kibana
Private stringSecurity Group Id - List of security groups.
- Kibana
Private List<string>Whitelists - List of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- Kibana
Whitelists List<string> - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- Kms
Encrypted stringPassword - An KMS encrypts password used to an instance. If the
passwordis filled in, this field will be ignored, but you have to specify one ofpasswordandkms_encrypted_passwordfields. - Kms
Encryption Dictionary<string, string>Context - An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set. - Master
Configuration Pulumi.Ali Cloud. Elastic Search. Inputs. Instance Master Configuration - Configuration information for Elasticsearch dedicated master nodes. See
master_configurationbelow. - 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.
- Order
Action stringType Configuration change type. Valid values:
- upgrade (default): Upgrade configuration
- downgrade: Downgrade configuration.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- Password string
- The access password for the instance. It must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@#$%^&*()_+-=).
- Payment
Type string - The billing method of the instance. Supported values:
PayAsYouGo: Pay-as-you-goSubscription: Subscription
- Period int
- The duration that you will buy Elasticsearch instance (in month). It is valid when PaymentType is
Subscription. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaidinstance. - Private
Whitelists List<string> - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- Protocol string
- The access protocol. Supported protocols: HTTP and HTTPS.
- Public
Whitelists List<string> - The IP address whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- Renew
Status string - The renewal status. Valid values:
- AutoRenewal: Auto-renewal.
- ManualRenewal: Manual renewal.
- NotRenewal: No renewal.
- Renewal
Duration stringUnit The unit of the auto-renewal period. Valid values:
- M: Month.
- Y: Year.
NOTE: This parameter is required when RenewalStatus is set to AutoRenewal.
- Resource
Group stringId - The ID of the resource group to which the instance belongs.
- Setting
Config Dictionary<string, string> - YML configuration file settings for the instance.
- Dictionary<string, string>
- Instance tag group.
- Update
Strategy string Elasticsearch update strategy (for example, index updates, cluster upgrades, or service deployments). Valid values:
- blue_green: Blue-green deployment, which enables seamless switching by running two identical environments (blue and green) in parallel.
- normal: In-place update, which applies changes directly in the current environment (for example, upgrades or scaling) without requiring additional resources.
- intelligent: Intelligent update, where the system automatically analyzes the update type and environment status to dynamically select the optimal strategy (either blue-green or in-place).
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- Warm
Node intAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- Warm
Node Pulumi.Configuration Ali Cloud. Elastic Search. Inputs. Instance Warm Node Configuration - Cold data node configuration for the Elasticsearch cluster. See
warm_node_configurationbelow. - 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 number of zones for the instance. Valid values: 1, 2, and 3. Default value: 1.
The following arguments will be discarded. Please use new fields as soon as possible:
- Version string
The instance version. Valid values:
- 8.5.1_with_X-Pack
- 7.10_with_X-Pack
- 6.7_with_X-Pack
- 7.7_with_X-Pack
- 6.8_with_X-Pack
- 6.3_with_X-Pack
- 5.6_with_X-Pack
- 5.5.3_with_X-Pack
NOTE: The versions listed above might not include all versions supported by Elasticsearch instances. You can call the GetRegionConfiguration operation to view the actual supported versions.
- Vswitch
Id string - The ID of VSwitch.
- Auto
Renew intDuration - Number of auto-renewal periods.
- Client
Node intAmount - The Elasticsearch cluster's client node quantity, between 2 and 25.
- Client
Node InstanceConfiguration Client Node Configuration Args - Configuration of dedicated coordinating nodes in the Elasticsearch cluster. See
client_node_configurationbelow. - 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 InstanceConfiguration Data Node Configuration Args - Elasticsearch data node information. See
data_node_configurationbelow. - 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_typemuse 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
- Instance name, which supports fuzzy search. For example, searching for all instances containing
abcmay return instances namedabc,abcde,xyabc, orxabcy. - Enable
Kibana boolPrivate Network - Indicates whether private network access to Kibana is enabled. Valid values:
- true: Enabled
- false: Disabled
- Enable
Kibana boolPublic Network - Specifies whether to enable public access to Kibana. Valid values:
- true: Enables public access.
- false: Disables public access.
- Enable
Public bool - Specifies whether to enable a public endpoint for the instance. Valid values:
- true: Enables the public endpoint.
- false: Disables the public endpoint.
- Force bool
Whether to force a restart:
- true: Yes
- false (default): No.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- Instance
Category string - Edition type:
- x-pack: Creates a commercial edition instance, or a kernel-enhanced edition instance without Indexing Service or OpenStore enabled.
- IS: Creates a kernel-enhanced edition instance with Indexing Service or OpenStore enabled.
- 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 fromPostPaidtoPrePaid, the following attributes are required:period. Usepayment_typeinstead with valuesPayAsYouGoorSubscription. - Kibana
Configuration InstanceKibana Configuration Args - The configuration of Elasticsearch Kibana nodes. See
kibana_configurationbelow. - Kibana
Node stringSpec - The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small. - Kibana
Private stringSecurity Group Id - List of security groups.
- Kibana
Private []stringWhitelists - List of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- Kibana
Whitelists []string - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- Kms
Encrypted stringPassword - An KMS encrypts password used to an instance. If the
passwordis filled in, this field will be ignored, but you have to specify one ofpasswordandkms_encrypted_passwordfields. - Kms
Encryption map[string]stringContext - An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set. - Master
Configuration InstanceMaster Configuration Args - Configuration information for Elasticsearch dedicated master nodes. See
master_configurationbelow. - 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.
- Order
Action stringType Configuration change type. Valid values:
- upgrade (default): Upgrade configuration
- downgrade: Downgrade configuration.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- Password string
- The access password for the instance. It must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@#$%^&*()_+-=).
- Payment
Type string - The billing method of the instance. Supported values:
PayAsYouGo: Pay-as-you-goSubscription: Subscription
- Period int
- The duration that you will buy Elasticsearch instance (in month). It is valid when PaymentType is
Subscription. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaidinstance. - Private
Whitelists []string - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- Protocol string
- The access protocol. Supported protocols: HTTP and HTTPS.
- Public
Whitelists []string - The IP address whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- Renew
Status string - The renewal status. Valid values:
- AutoRenewal: Auto-renewal.
- ManualRenewal: Manual renewal.
- NotRenewal: No renewal.
- Renewal
Duration stringUnit The unit of the auto-renewal period. Valid values:
- M: Month.
- Y: Year.
NOTE: This parameter is required when RenewalStatus is set to AutoRenewal.
- Resource
Group stringId - The ID of the resource group to which the instance belongs.
- Setting
Config map[string]string - YML configuration file settings for the instance.
- map[string]string
- Instance tag group.
- Update
Strategy string Elasticsearch update strategy (for example, index updates, cluster upgrades, or service deployments). Valid values:
- blue_green: Blue-green deployment, which enables seamless switching by running two identical environments (blue and green) in parallel.
- normal: In-place update, which applies changes directly in the current environment (for example, upgrades or scaling) without requiring additional resources.
- intelligent: Intelligent update, where the system automatically analyzes the update type and environment status to dynamically select the optimal strategy (either blue-green or in-place).
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- Warm
Node intAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- Warm
Node InstanceConfiguration Warm Node Configuration Args - Cold data node configuration for the Elasticsearch cluster. See
warm_node_configurationbelow. - 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 number of zones for the instance. Valid values: 1, 2, and 3. Default value: 1.
The following arguments will be discarded. Please use new fields as soon as possible:
- version String
The instance version. Valid values:
- 8.5.1_with_X-Pack
- 7.10_with_X-Pack
- 6.7_with_X-Pack
- 7.7_with_X-Pack
- 6.8_with_X-Pack
- 6.3_with_X-Pack
- 5.6_with_X-Pack
- 5.5.3_with_X-Pack
NOTE: The versions listed above might not include all versions supported by Elasticsearch instances. You can call the GetRegionConfiguration operation to view the actual supported versions.
- vswitch
Id String - The ID of VSwitch.
- auto
Renew IntegerDuration - Number of auto-renewal periods.
- client
Node IntegerAmount - The Elasticsearch cluster's client node quantity, between 2 and 25.
- client
Node InstanceConfiguration Client Node Configuration - Configuration of dedicated coordinating nodes in the Elasticsearch cluster. See
client_node_configurationbelow. - 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 InstanceConfiguration Data Node Configuration - Elasticsearch data node information. See
data_node_configurationbelow. - 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_typemuse 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
- Instance name, which supports fuzzy search. For example, searching for all instances containing
abcmay return instances namedabc,abcde,xyabc, orxabcy. - enable
Kibana BooleanPrivate Network - Indicates whether private network access to Kibana is enabled. Valid values:
- true: Enabled
- false: Disabled
- enable
Kibana BooleanPublic Network - Specifies whether to enable public access to Kibana. Valid values:
- true: Enables public access.
- false: Disables public access.
- enable
Public Boolean - Specifies whether to enable a public endpoint for the instance. Valid values:
- true: Enables the public endpoint.
- false: Disables the public endpoint.
- force Boolean
Whether to force a restart:
- true: Yes
- false (default): No.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- instance
Category String - Edition type:
- x-pack: Creates a commercial edition instance, or a kernel-enhanced edition instance without Indexing Service or OpenStore enabled.
- IS: Creates a kernel-enhanced edition instance with Indexing Service or OpenStore enabled.
- 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 fromPostPaidtoPrePaid, the following attributes are required:period. Usepayment_typeinstead with valuesPayAsYouGoorSubscription. - kibana
Configuration InstanceKibana Configuration - The configuration of Elasticsearch Kibana nodes. See
kibana_configurationbelow. - kibana
Node StringSpec - The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small. - kibana
Private StringSecurity Group Id - List of security groups.
- kibana
Private List<String>Whitelists - List of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- kibana
Whitelists List<String> - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- kms
Encrypted StringPassword - An KMS encrypts password used to an instance. If the
passwordis filled in, this field will be ignored, but you have to specify one ofpasswordandkms_encrypted_passwordfields. - kms
Encryption Map<String,String>Context - An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set. - master
Configuration InstanceMaster Configuration - Configuration information for Elasticsearch dedicated master nodes. See
master_configurationbelow. - 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.
- order
Action StringType Configuration change type. Valid values:
- upgrade (default): Upgrade configuration
- downgrade: Downgrade configuration.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- password String
- The access password for the instance. It must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@#$%^&*()_+-=).
- payment
Type String - The billing method of the instance. Supported values:
PayAsYouGo: Pay-as-you-goSubscription: Subscription
- period Integer
- The duration that you will buy Elasticsearch instance (in month). It is valid when PaymentType is
Subscription. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaidinstance. - private
Whitelists List<String> - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- protocol String
- The access protocol. Supported protocols: HTTP and HTTPS.
- public
Whitelists List<String> - The IP address whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- renew
Status String - The renewal status. Valid values:
- AutoRenewal: Auto-renewal.
- ManualRenewal: Manual renewal.
- NotRenewal: No renewal.
- renewal
Duration StringUnit The unit of the auto-renewal period. Valid values:
- M: Month.
- Y: Year.
NOTE: This parameter is required when RenewalStatus is set to AutoRenewal.
- resource
Group StringId - The ID of the resource group to which the instance belongs.
- setting
Config Map<String,String> - YML configuration file settings for the instance.
- Map<String,String>
- Instance tag group.
- update
Strategy String Elasticsearch update strategy (for example, index updates, cluster upgrades, or service deployments). Valid values:
- blue_green: Blue-green deployment, which enables seamless switching by running two identical environments (blue and green) in parallel.
- normal: In-place update, which applies changes directly in the current environment (for example, upgrades or scaling) without requiring additional resources.
- intelligent: Intelligent update, where the system automatically analyzes the update type and environment status to dynamically select the optimal strategy (either blue-green or in-place).
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- warm
Node IntegerAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm
Node InstanceConfiguration Warm Node Configuration - Cold data node configuration for the Elasticsearch cluster. See
warm_node_configurationbelow. - 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 number of zones for the instance. Valid values: 1, 2, and 3. Default value: 1.
The following arguments will be discarded. Please use new fields as soon as possible:
- version string
The instance version. Valid values:
- 8.5.1_with_X-Pack
- 7.10_with_X-Pack
- 6.7_with_X-Pack
- 7.7_with_X-Pack
- 6.8_with_X-Pack
- 6.3_with_X-Pack
- 5.6_with_X-Pack
- 5.5.3_with_X-Pack
NOTE: The versions listed above might not include all versions supported by Elasticsearch instances. You can call the GetRegionConfiguration operation to view the actual supported versions.
- vswitch
Id string - The ID of VSwitch.
- auto
Renew numberDuration - Number of auto-renewal periods.
- client
Node numberAmount - The Elasticsearch cluster's client node quantity, between 2 and 25.
- client
Node InstanceConfiguration Client Node Configuration - Configuration of dedicated coordinating nodes in the Elasticsearch cluster. See
client_node_configurationbelow. - 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 InstanceConfiguration Data Node Configuration - Elasticsearch data node information. See
data_node_configurationbelow. - 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_typemuse 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
- Instance name, which supports fuzzy search. For example, searching for all instances containing
abcmay return instances namedabc,abcde,xyabc, orxabcy. - enable
Kibana booleanPrivate Network - Indicates whether private network access to Kibana is enabled. Valid values:
- true: Enabled
- false: Disabled
- enable
Kibana booleanPublic Network - Specifies whether to enable public access to Kibana. Valid values:
- true: Enables public access.
- false: Disables public access.
- enable
Public boolean - Specifies whether to enable a public endpoint for the instance. Valid values:
- true: Enables the public endpoint.
- false: Disables the public endpoint.
- force boolean
Whether to force a restart:
- true: Yes
- false (default): No.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- instance
Category string - Edition type:
- x-pack: Creates a commercial edition instance, or a kernel-enhanced edition instance without Indexing Service or OpenStore enabled.
- IS: Creates a kernel-enhanced edition instance with Indexing Service or OpenStore enabled.
- 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 fromPostPaidtoPrePaid, the following attributes are required:period. Usepayment_typeinstead with valuesPayAsYouGoorSubscription. - kibana
Configuration InstanceKibana Configuration - The configuration of Elasticsearch Kibana nodes. See
kibana_configurationbelow. - kibana
Node stringSpec - The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small. - kibana
Private stringSecurity Group Id - List of security groups.
- kibana
Private string[]Whitelists - List of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- kibana
Whitelists string[] - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- kms
Encrypted stringPassword - An KMS encrypts password used to an instance. If the
passwordis filled in, this field will be ignored, but you have to specify one ofpasswordandkms_encrypted_passwordfields. - kms
Encryption {[key: string]: string}Context - An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set. - master
Configuration InstanceMaster Configuration - Configuration information for Elasticsearch dedicated master nodes. See
master_configurationbelow. - 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.
- order
Action stringType Configuration change type. Valid values:
- upgrade (default): Upgrade configuration
- downgrade: Downgrade configuration.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- password string
- The access password for the instance. It must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@#$%^&*()_+-=).
- payment
Type string - The billing method of the instance. Supported values:
PayAsYouGo: Pay-as-you-goSubscription: Subscription
- period number
- The duration that you will buy Elasticsearch instance (in month). It is valid when PaymentType is
Subscription. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaidinstance. - private
Whitelists string[] - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- protocol string
- The access protocol. Supported protocols: HTTP and HTTPS.
- public
Whitelists string[] - The IP address whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- renew
Status string - The renewal status. Valid values:
- AutoRenewal: Auto-renewal.
- ManualRenewal: Manual renewal.
- NotRenewal: No renewal.
- renewal
Duration stringUnit The unit of the auto-renewal period. Valid values:
- M: Month.
- Y: Year.
NOTE: This parameter is required when RenewalStatus is set to AutoRenewal.
- resource
Group stringId - The ID of the resource group to which the instance belongs.
- setting
Config {[key: string]: string} - YML configuration file settings for the instance.
- {[key: string]: string}
- Instance tag group.
- update
Strategy string Elasticsearch update strategy (for example, index updates, cluster upgrades, or service deployments). Valid values:
- blue_green: Blue-green deployment, which enables seamless switching by running two identical environments (blue and green) in parallel.
- normal: In-place update, which applies changes directly in the current environment (for example, upgrades or scaling) without requiring additional resources.
- intelligent: Intelligent update, where the system automatically analyzes the update type and environment status to dynamically select the optimal strategy (either blue-green or in-place).
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- warm
Node numberAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm
Node InstanceConfiguration Warm Node Configuration - Cold data node configuration for the Elasticsearch cluster. See
warm_node_configurationbelow. - 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 number of zones for the instance. Valid values: 1, 2, and 3. Default value: 1.
The following arguments will be discarded. Please use new fields as soon as possible:
- version str
The instance version. Valid values:
- 8.5.1_with_X-Pack
- 7.10_with_X-Pack
- 6.7_with_X-Pack
- 7.7_with_X-Pack
- 6.8_with_X-Pack
- 6.3_with_X-Pack
- 5.6_with_X-Pack
- 5.5.3_with_X-Pack
NOTE: The versions listed above might not include all versions supported by Elasticsearch instances. You can call the GetRegionConfiguration operation to view the actual supported versions.
- vswitch_
id str - The ID of VSwitch.
- auto_
renew_ intduration - Number of auto-renewal periods.
- client_
node_ intamount - The Elasticsearch cluster's client node quantity, between 2 and 25.
- client_
node_ Instanceconfiguration Client Node Configuration Args - Configuration of dedicated coordinating nodes in the Elasticsearch cluster. See
client_node_configurationbelow. - 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_ Instanceconfiguration Data Node Configuration Args - Elasticsearch data node information. See
data_node_configurationbelow. - 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_typemuse 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
- Instance name, which supports fuzzy search. For example, searching for all instances containing
abcmay return instances namedabc,abcde,xyabc, orxabcy. - enable_
kibana_ boolprivate_ network - Indicates whether private network access to Kibana is enabled. Valid values:
- true: Enabled
- false: Disabled
- enable_
kibana_ boolpublic_ network - Specifies whether to enable public access to Kibana. Valid values:
- true: Enables public access.
- false: Disables public access.
- enable_
public bool - Specifies whether to enable a public endpoint for the instance. Valid values:
- true: Enables the public endpoint.
- false: Disables the public endpoint.
- force bool
Whether to force a restart:
- true: Yes
- false (default): No.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- instance_
category str - Edition type:
- x-pack: Creates a commercial edition instance, or a kernel-enhanced edition instance without Indexing Service or OpenStore enabled.
- IS: Creates a kernel-enhanced edition instance with Indexing Service or OpenStore enabled.
- 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 fromPostPaidtoPrePaid, the following attributes are required:period. Usepayment_typeinstead with valuesPayAsYouGoorSubscription. - kibana_
configuration InstanceKibana Configuration Args - The configuration of Elasticsearch Kibana nodes. See
kibana_configurationbelow. - kibana_
node_ strspec - The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small. - kibana_
private_ strsecurity_ group_ id - List of security groups.
- kibana_
private_ Sequence[str]whitelists - List of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- kibana_
whitelists Sequence[str] - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- kms_
encrypted_ strpassword - An KMS encrypts password used to an instance. If the
passwordis filled in, this field will be ignored, but you have to specify one ofpasswordandkms_encrypted_passwordfields. - kms_
encryption_ Mapping[str, str]context - An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set. - master_
configuration InstanceMaster Configuration Args - Configuration information for Elasticsearch dedicated master nodes. See
master_configurationbelow. - 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.
- order_
action_ strtype Configuration change type. Valid values:
- upgrade (default): Upgrade configuration
- downgrade: Downgrade configuration.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- password str
- The access password for the instance. It must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@#$%^&*()_+-=).
- payment_
type str - The billing method of the instance. Supported values:
PayAsYouGo: Pay-as-you-goSubscription: Subscription
- period int
- The duration that you will buy Elasticsearch instance (in month). It is valid when PaymentType is
Subscription. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaidinstance. - private_
whitelists Sequence[str] - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- protocol str
- The access protocol. Supported protocols: HTTP and HTTPS.
- public_
whitelists Sequence[str] - The IP address whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- renew_
status str - The renewal status. Valid values:
- AutoRenewal: Auto-renewal.
- ManualRenewal: Manual renewal.
- NotRenewal: No renewal.
- renewal_
duration_ strunit The unit of the auto-renewal period. Valid values:
- M: Month.
- Y: Year.
NOTE: This parameter is required when RenewalStatus is set to AutoRenewal.
- resource_
group_ strid - The ID of the resource group to which the instance belongs.
- setting_
config Mapping[str, str] - YML configuration file settings for the instance.
- Mapping[str, str]
- Instance tag group.
- update_
strategy str Elasticsearch update strategy (for example, index updates, cluster upgrades, or service deployments). Valid values:
- blue_green: Blue-green deployment, which enables seamless switching by running two identical environments (blue and green) in parallel.
- normal: In-place update, which applies changes directly in the current environment (for example, upgrades or scaling) without requiring additional resources.
- intelligent: Intelligent update, where the system automatically analyzes the update type and environment status to dynamically select the optimal strategy (either blue-green or in-place).
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- warm_
node_ intamount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm_
node_ Instanceconfiguration Warm Node Configuration Args - Cold data node configuration for the Elasticsearch cluster. See
warm_node_configurationbelow. - 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 number of zones for the instance. Valid values: 1, 2, and 3. Default value: 1.
The following arguments will be discarded. Please use new fields as soon as possible:
- version String
The instance version. Valid values:
- 8.5.1_with_X-Pack
- 7.10_with_X-Pack
- 6.7_with_X-Pack
- 7.7_with_X-Pack
- 6.8_with_X-Pack
- 6.3_with_X-Pack
- 5.6_with_X-Pack
- 5.5.3_with_X-Pack
NOTE: The versions listed above might not include all versions supported by Elasticsearch instances. You can call the GetRegionConfiguration operation to view the actual supported versions.
- vswitch
Id String - The ID of VSwitch.
- auto
Renew NumberDuration - Number of auto-renewal periods.
- client
Node NumberAmount - The Elasticsearch cluster's client node quantity, between 2 and 25.
- client
Node Property MapConfiguration - Configuration of dedicated coordinating nodes in the Elasticsearch cluster. See
client_node_configurationbelow. - 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 Property MapConfiguration - Elasticsearch data node information. See
data_node_configurationbelow. - 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_typemuse 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
- Instance name, which supports fuzzy search. For example, searching for all instances containing
abcmay return instances namedabc,abcde,xyabc, orxabcy. - enable
Kibana BooleanPrivate Network - Indicates whether private network access to Kibana is enabled. Valid values:
- true: Enabled
- false: Disabled
- enable
Kibana BooleanPublic Network - Specifies whether to enable public access to Kibana. Valid values:
- true: Enables public access.
- false: Disables public access.
- enable
Public Boolean - Specifies whether to enable a public endpoint for the instance. Valid values:
- true: Enables the public endpoint.
- false: Disables the public endpoint.
- force Boolean
Whether to force a restart:
- true: Yes
- false (default): No.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- instance
Category String - Edition type:
- x-pack: Creates a commercial edition instance, or a kernel-enhanced edition instance without Indexing Service or OpenStore enabled.
- IS: Creates a kernel-enhanced edition instance with Indexing Service or OpenStore enabled.
- 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 fromPostPaidtoPrePaid, the following attributes are required:period. Usepayment_typeinstead with valuesPayAsYouGoorSubscription. - kibana
Configuration Property Map - The configuration of Elasticsearch Kibana nodes. See
kibana_configurationbelow. - kibana
Node StringSpec - The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small. - kibana
Private StringSecurity Group Id - List of security groups.
- kibana
Private List<String>Whitelists - List of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- kibana
Whitelists List<String> - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- kms
Encrypted StringPassword - An KMS encrypts password used to an instance. If the
passwordis filled in, this field will be ignored, but you have to specify one ofpasswordandkms_encrypted_passwordfields. - kms
Encryption Map<String>Context - An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set. - master
Configuration Property Map - Configuration information for Elasticsearch dedicated master nodes. See
master_configurationbelow. - 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.
- order
Action StringType Configuration change type. Valid values:
- upgrade (default): Upgrade configuration
- downgrade: Downgrade configuration.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- password String
- The access password for the instance. It must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@#$%^&*()_+-=).
- payment
Type String - The billing method of the instance. Supported values:
PayAsYouGo: Pay-as-you-goSubscription: Subscription
- period Number
- The duration that you will buy Elasticsearch instance (in month). It is valid when PaymentType is
Subscription. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaidinstance. - private
Whitelists List<String> - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- protocol String
- The access protocol. Supported protocols: HTTP and HTTPS.
- public
Whitelists List<String> - The IP address whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- renew
Status String - The renewal status. Valid values:
- AutoRenewal: Auto-renewal.
- ManualRenewal: Manual renewal.
- NotRenewal: No renewal.
- renewal
Duration StringUnit The unit of the auto-renewal period. Valid values:
- M: Month.
- Y: Year.
NOTE: This parameter is required when RenewalStatus is set to AutoRenewal.
- resource
Group StringId - The ID of the resource group to which the instance belongs.
- setting
Config Map<String> - YML configuration file settings for the instance.
- Map<String>
- Instance tag group.
- update
Strategy String Elasticsearch update strategy (for example, index updates, cluster upgrades, or service deployments). Valid values:
- blue_green: Blue-green deployment, which enables seamless switching by running two identical environments (blue and green) in parallel.
- normal: In-place update, which applies changes directly in the current environment (for example, upgrades or scaling) without requiring additional resources.
- intelligent: Intelligent update, where the system automatically analyzes the update type and environment status to dynamically select the optimal strategy (either blue-green or in-place).
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- warm
Node NumberAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm
Node Property MapConfiguration - Cold data node configuration for the Elasticsearch cluster. See
warm_node_configurationbelow. - 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 number of zones for the instance. Valid values: 1, 2, and 3. Default value: 1.
The following arguments will be discarded. Please use new fields as soon as possible:
Outputs
All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:
- Arch
Type string - The deployment mode or architecture type:.
- Create
Time string - The time when the instance was created.
- Domain string
- The internal network address of the instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kibana
Domain string - Kibana endpoint.
- Kibana
Port int - The access port for Kibana.
- Kibana
Private stringDomain - The private endpoint of Kibana.
- Port int
- Instance connection port.
- Public
Domain string - The public endpoint of the instance.
- Public
Port int - The public access port of the instance.
- Status string
- The status of the instance.
- Arch
Type string - The deployment mode or architecture type:.
- Create
Time string - The time when the instance was created.
- Domain string
- The internal network address of the instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kibana
Domain string - Kibana endpoint.
- Kibana
Port int - The access port for Kibana.
- Kibana
Private stringDomain - The private endpoint of Kibana.
- Port int
- Instance connection port.
- Public
Domain string - The public endpoint of the instance.
- Public
Port int - The public access port of the instance.
- Status string
- The status of the instance.
- arch
Type String - The deployment mode or architecture type:.
- create
Time String - The time when the instance was created.
- domain String
- The internal network address of the instance.
- id String
- The provider-assigned unique ID for this managed resource.
- kibana
Domain String - Kibana endpoint.
- kibana
Port Integer - The access port for Kibana.
- kibana
Private StringDomain - The private endpoint of Kibana.
- port Integer
- Instance connection port.
- public
Domain String - The public endpoint of the instance.
- public
Port Integer - The public access port of the instance.
- status String
- The status of the instance.
- arch
Type string - The deployment mode or architecture type:.
- create
Time string - The time when the instance was created.
- domain string
- The internal network address of the instance.
- id string
- The provider-assigned unique ID for this managed resource.
- kibana
Domain string - Kibana endpoint.
- kibana
Port number - The access port for Kibana.
- kibana
Private stringDomain - The private endpoint of Kibana.
- port number
- Instance connection port.
- public
Domain string - The public endpoint of the instance.
- public
Port number - The public access port of the instance.
- status string
- The status of the instance.
- arch_
type str - The deployment mode or architecture type:.
- create_
time str - The time when the instance was created.
- domain str
- The internal network address of the instance.
- id str
- The provider-assigned unique ID for this managed resource.
- kibana_
domain str - Kibana endpoint.
- kibana_
port int - The access port for Kibana.
- kibana_
private_ strdomain - The private endpoint of Kibana.
- port int
- Instance connection port.
- public_
domain str - The public endpoint of the instance.
- public_
port int - The public access port of the instance.
- status str
- The status of the instance.
- arch
Type String - The deployment mode or architecture type:.
- create
Time String - The time when the instance was created.
- domain String
- The internal network address of the instance.
- id String
- The provider-assigned unique ID for this managed resource.
- kibana
Domain String - Kibana endpoint.
- kibana
Port Number - The access port for Kibana.
- kibana
Private StringDomain - The private endpoint of Kibana.
- port Number
- Instance connection port.
- public
Domain String - The public endpoint of the instance.
- public
Port Number - The public access port of the instance.
- status String
- The status of the instance.
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,
arch_type: Optional[str] = None,
auto_renew_duration: Optional[int] = None,
client_node_amount: Optional[int] = None,
client_node_configuration: Optional[InstanceClientNodeConfigurationArgs] = None,
client_node_spec: Optional[str] = None,
create_time: Optional[str] = None,
data_node_amount: Optional[int] = None,
data_node_configuration: Optional[InstanceDataNodeConfigurationArgs] = 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,
force: Optional[bool] = None,
instance_category: Optional[str] = None,
instance_charge_type: Optional[str] = None,
kibana_configuration: Optional[InstanceKibanaConfigurationArgs] = None,
kibana_domain: Optional[str] = None,
kibana_node_spec: Optional[str] = None,
kibana_port: Optional[int] = None,
kibana_private_domain: 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,
master_configuration: Optional[InstanceMasterConfigurationArgs] = None,
master_node_disk_type: Optional[str] = None,
master_node_spec: Optional[str] = None,
order_action_type: Optional[str] = None,
password: Optional[str] = None,
payment_type: 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,
update_strategy: Optional[str] = None,
version: Optional[str] = None,
vswitch_id: Optional[str] = None,
warm_node_amount: Optional[int] = None,
warm_node_configuration: Optional[InstanceWarmNodeConfigurationArgs] = 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) -> Instancefunc 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)resources: _: type: alicloud:elasticsearch:Instance get: id: ${id}- 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.
- Arch
Type string - The deployment mode or architecture type:.
- Auto
Renew intDuration - Number of auto-renewal periods.
- Client
Node intAmount - The Elasticsearch cluster's client node quantity, between 2 and 25.
- Client
Node Pulumi.Configuration Ali Cloud. Elastic Search. Inputs. Instance Client Node Configuration - Configuration of dedicated coordinating nodes in the Elasticsearch cluster. See
client_node_configurationbelow. - Client
Node stringSpec - The client node spec. If specified, client node will be created.
- Create
Time string - The time when the instance was created.
- Data
Node intAmount - The Elasticsearch cluster's data node quantity, between 2 and 50.
- Data
Node Pulumi.Configuration Ali Cloud. Elastic Search. Inputs. Instance Data Node Configuration - Elasticsearch data node information. See
data_node_configurationbelow. - 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_typemuse 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
- Instance name, which supports fuzzy search. For example, searching for all instances containing
abcmay return instances namedabc,abcde,xyabc, orxabcy. - Domain string
- The internal network address of the instance.
- Enable
Kibana boolPrivate Network - Indicates whether private network access to Kibana is enabled. Valid values:
- true: Enabled
- false: Disabled
- Enable
Kibana boolPublic Network - Specifies whether to enable public access to Kibana. Valid values:
- true: Enables public access.
- false: Disables public access.
- Enable
Public bool - Specifies whether to enable a public endpoint for the instance. Valid values:
- true: Enables the public endpoint.
- false: Disables the public endpoint.
- Force bool
Whether to force a restart:
- true: Yes
- false (default): No.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- Instance
Category string - Edition type:
- x-pack: Creates a commercial edition instance, or a kernel-enhanced edition instance without Indexing Service or OpenStore enabled.
- IS: Creates a kernel-enhanced edition instance with Indexing Service or OpenStore enabled.
- 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 fromPostPaidtoPrePaid, the following attributes are required:period. Usepayment_typeinstead with valuesPayAsYouGoorSubscription. - Kibana
Configuration Pulumi.Ali Cloud. Elastic Search. Inputs. Instance Kibana Configuration - The configuration of Elasticsearch Kibana nodes. See
kibana_configurationbelow. - Kibana
Domain string - Kibana endpoint.
- Kibana
Node stringSpec - The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small. - Kibana
Port int - The access port for Kibana.
- Kibana
Private stringDomain - The private endpoint of Kibana.
- Kibana
Private stringSecurity Group Id - List of security groups.
- Kibana
Private List<string>Whitelists - List of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- Kibana
Whitelists List<string> - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- Kms
Encrypted stringPassword - An KMS encrypts password used to an instance. If the
passwordis filled in, this field will be ignored, but you have to specify one ofpasswordandkms_encrypted_passwordfields. - Kms
Encryption Dictionary<string, string>Context - An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set. - Master
Configuration Pulumi.Ali Cloud. Elastic Search. Inputs. Instance Master Configuration - Configuration information for Elasticsearch dedicated master nodes. See
master_configurationbelow. - 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.
- Order
Action stringType Configuration change type. Valid values:
- upgrade (default): Upgrade configuration
- downgrade: Downgrade configuration.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- Password string
- The access password for the instance. It must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@#$%^&*()_+-=).
- Payment
Type string - The billing method of the instance. Supported values:
PayAsYouGo: Pay-as-you-goSubscription: Subscription
- Period int
- The duration that you will buy Elasticsearch instance (in month). It is valid when PaymentType is
Subscription. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaidinstance. - Port int
- Instance connection port.
- Private
Whitelists List<string> - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- Protocol string
- The access protocol. Supported protocols: HTTP and HTTPS.
- Public
Domain string - The public endpoint of the instance.
- Public
Port int - The public access port of the instance.
- Public
Whitelists List<string> - The IP address whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- Renew
Status string - The renewal status. Valid values:
- AutoRenewal: Auto-renewal.
- ManualRenewal: Manual renewal.
- NotRenewal: No renewal.
- Renewal
Duration stringUnit The unit of the auto-renewal period. Valid values:
- M: Month.
- Y: Year.
NOTE: This parameter is required when RenewalStatus is set to AutoRenewal.
- Resource
Group stringId - The ID of the resource group to which the instance belongs.
- Setting
Config Dictionary<string, string> - YML configuration file settings for the instance.
- Status string
- The status of the instance.
- Dictionary<string, string>
- Instance tag group.
- Update
Strategy string Elasticsearch update strategy (for example, index updates, cluster upgrades, or service deployments). Valid values:
- blue_green: Blue-green deployment, which enables seamless switching by running two identical environments (blue and green) in parallel.
- normal: In-place update, which applies changes directly in the current environment (for example, upgrades or scaling) without requiring additional resources.
- intelligent: Intelligent update, where the system automatically analyzes the update type and environment status to dynamically select the optimal strategy (either blue-green or in-place).
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- Version string
The instance version. Valid values:
- 8.5.1_with_X-Pack
- 7.10_with_X-Pack
- 6.7_with_X-Pack
- 7.7_with_X-Pack
- 6.8_with_X-Pack
- 6.3_with_X-Pack
- 5.6_with_X-Pack
- 5.5.3_with_X-Pack
NOTE: The versions listed above might not include all versions supported by Elasticsearch instances. You can call the GetRegionConfiguration operation to view the actual supported versions.
- Vswitch
Id string - The ID of VSwitch.
- Warm
Node intAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- Warm
Node Pulumi.Configuration Ali Cloud. Elastic Search. Inputs. Instance Warm Node Configuration - Cold data node configuration for the Elasticsearch cluster. See
warm_node_configurationbelow. - 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 number of zones for the instance. Valid values: 1, 2, and 3. Default value: 1.
The following arguments will be discarded. Please use new fields as soon as possible:
- Arch
Type string - The deployment mode or architecture type:.
- Auto
Renew intDuration - Number of auto-renewal periods.
- Client
Node intAmount - The Elasticsearch cluster's client node quantity, between 2 and 25.
- Client
Node InstanceConfiguration Client Node Configuration Args - Configuration of dedicated coordinating nodes in the Elasticsearch cluster. See
client_node_configurationbelow. - Client
Node stringSpec - The client node spec. If specified, client node will be created.
- Create
Time string - The time when the instance was created.
- Data
Node intAmount - The Elasticsearch cluster's data node quantity, between 2 and 50.
- Data
Node InstanceConfiguration Data Node Configuration Args - Elasticsearch data node information. See
data_node_configurationbelow. - 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_typemuse 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
- Instance name, which supports fuzzy search. For example, searching for all instances containing
abcmay return instances namedabc,abcde,xyabc, orxabcy. - Domain string
- The internal network address of the instance.
- Enable
Kibana boolPrivate Network - Indicates whether private network access to Kibana is enabled. Valid values:
- true: Enabled
- false: Disabled
- Enable
Kibana boolPublic Network - Specifies whether to enable public access to Kibana. Valid values:
- true: Enables public access.
- false: Disables public access.
- Enable
Public bool - Specifies whether to enable a public endpoint for the instance. Valid values:
- true: Enables the public endpoint.
- false: Disables the public endpoint.
- Force bool
Whether to force a restart:
- true: Yes
- false (default): No.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- Instance
Category string - Edition type:
- x-pack: Creates a commercial edition instance, or a kernel-enhanced edition instance without Indexing Service or OpenStore enabled.
- IS: Creates a kernel-enhanced edition instance with Indexing Service or OpenStore enabled.
- 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 fromPostPaidtoPrePaid, the following attributes are required:period. Usepayment_typeinstead with valuesPayAsYouGoorSubscription. - Kibana
Configuration InstanceKibana Configuration Args - The configuration of Elasticsearch Kibana nodes. See
kibana_configurationbelow. - Kibana
Domain string - Kibana endpoint.
- Kibana
Node stringSpec - The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small. - Kibana
Port int - The access port for Kibana.
- Kibana
Private stringDomain - The private endpoint of Kibana.
- Kibana
Private stringSecurity Group Id - List of security groups.
- Kibana
Private []stringWhitelists - List of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- Kibana
Whitelists []string - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- Kms
Encrypted stringPassword - An KMS encrypts password used to an instance. If the
passwordis filled in, this field will be ignored, but you have to specify one ofpasswordandkms_encrypted_passwordfields. - Kms
Encryption map[string]stringContext - An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set. - Master
Configuration InstanceMaster Configuration Args - Configuration information for Elasticsearch dedicated master nodes. See
master_configurationbelow. - 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.
- Order
Action stringType Configuration change type. Valid values:
- upgrade (default): Upgrade configuration
- downgrade: Downgrade configuration.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- Password string
- The access password for the instance. It must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@#$%^&*()_+-=).
- Payment
Type string - The billing method of the instance. Supported values:
PayAsYouGo: Pay-as-you-goSubscription: Subscription
- Period int
- The duration that you will buy Elasticsearch instance (in month). It is valid when PaymentType is
Subscription. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaidinstance. - Port int
- Instance connection port.
- Private
Whitelists []string - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- Protocol string
- The access protocol. Supported protocols: HTTP and HTTPS.
- Public
Domain string - The public endpoint of the instance.
- Public
Port int - The public access port of the instance.
- Public
Whitelists []string - The IP address whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- Renew
Status string - The renewal status. Valid values:
- AutoRenewal: Auto-renewal.
- ManualRenewal: Manual renewal.
- NotRenewal: No renewal.
- Renewal
Duration stringUnit The unit of the auto-renewal period. Valid values:
- M: Month.
- Y: Year.
NOTE: This parameter is required when RenewalStatus is set to AutoRenewal.
- Resource
Group stringId - The ID of the resource group to which the instance belongs.
- Setting
Config map[string]string - YML configuration file settings for the instance.
- Status string
- The status of the instance.
- map[string]string
- Instance tag group.
- Update
Strategy string Elasticsearch update strategy (for example, index updates, cluster upgrades, or service deployments). Valid values:
- blue_green: Blue-green deployment, which enables seamless switching by running two identical environments (blue and green) in parallel.
- normal: In-place update, which applies changes directly in the current environment (for example, upgrades or scaling) without requiring additional resources.
- intelligent: Intelligent update, where the system automatically analyzes the update type and environment status to dynamically select the optimal strategy (either blue-green or in-place).
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- Version string
The instance version. Valid values:
- 8.5.1_with_X-Pack
- 7.10_with_X-Pack
- 6.7_with_X-Pack
- 7.7_with_X-Pack
- 6.8_with_X-Pack
- 6.3_with_X-Pack
- 5.6_with_X-Pack
- 5.5.3_with_X-Pack
NOTE: The versions listed above might not include all versions supported by Elasticsearch instances. You can call the GetRegionConfiguration operation to view the actual supported versions.
- Vswitch
Id string - The ID of VSwitch.
- Warm
Node intAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- Warm
Node InstanceConfiguration Warm Node Configuration Args - Cold data node configuration for the Elasticsearch cluster. See
warm_node_configurationbelow. - 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 number of zones for the instance. Valid values: 1, 2, and 3. Default value: 1.
The following arguments will be discarded. Please use new fields as soon as possible:
- arch
Type String - The deployment mode or architecture type:.
- auto
Renew IntegerDuration - Number of auto-renewal periods.
- client
Node IntegerAmount - The Elasticsearch cluster's client node quantity, between 2 and 25.
- client
Node InstanceConfiguration Client Node Configuration - Configuration of dedicated coordinating nodes in the Elasticsearch cluster. See
client_node_configurationbelow. - client
Node StringSpec - The client node spec. If specified, client node will be created.
- create
Time String - The time when the instance was created.
- data
Node IntegerAmount - The Elasticsearch cluster's data node quantity, between 2 and 50.
- data
Node InstanceConfiguration Data Node Configuration - Elasticsearch data node information. See
data_node_configurationbelow. - 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_typemuse 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
- Instance name, which supports fuzzy search. For example, searching for all instances containing
abcmay return instances namedabc,abcde,xyabc, orxabcy. - domain String
- The internal network address of the instance.
- enable
Kibana BooleanPrivate Network - Indicates whether private network access to Kibana is enabled. Valid values:
- true: Enabled
- false: Disabled
- enable
Kibana BooleanPublic Network - Specifies whether to enable public access to Kibana. Valid values:
- true: Enables public access.
- false: Disables public access.
- enable
Public Boolean - Specifies whether to enable a public endpoint for the instance. Valid values:
- true: Enables the public endpoint.
- false: Disables the public endpoint.
- force Boolean
Whether to force a restart:
- true: Yes
- false (default): No.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- instance
Category String - Edition type:
- x-pack: Creates a commercial edition instance, or a kernel-enhanced edition instance without Indexing Service or OpenStore enabled.
- IS: Creates a kernel-enhanced edition instance with Indexing Service or OpenStore enabled.
- 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 fromPostPaidtoPrePaid, the following attributes are required:period. Usepayment_typeinstead with valuesPayAsYouGoorSubscription. - kibana
Configuration InstanceKibana Configuration - The configuration of Elasticsearch Kibana nodes. See
kibana_configurationbelow. - kibana
Domain String - Kibana endpoint.
- kibana
Node StringSpec - The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small. - kibana
Port Integer - The access port for Kibana.
- kibana
Private StringDomain - The private endpoint of Kibana.
- kibana
Private StringSecurity Group Id - List of security groups.
- kibana
Private List<String>Whitelists - List of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- kibana
Whitelists List<String> - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- kms
Encrypted StringPassword - An KMS encrypts password used to an instance. If the
passwordis filled in, this field will be ignored, but you have to specify one ofpasswordandkms_encrypted_passwordfields. - kms
Encryption Map<String,String>Context - An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set. - master
Configuration InstanceMaster Configuration - Configuration information for Elasticsearch dedicated master nodes. See
master_configurationbelow. - 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.
- order
Action StringType Configuration change type. Valid values:
- upgrade (default): Upgrade configuration
- downgrade: Downgrade configuration.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- password String
- The access password for the instance. It must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@#$%^&*()_+-=).
- payment
Type String - The billing method of the instance. Supported values:
PayAsYouGo: Pay-as-you-goSubscription: Subscription
- period Integer
- The duration that you will buy Elasticsearch instance (in month). It is valid when PaymentType is
Subscription. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaidinstance. - port Integer
- Instance connection port.
- private
Whitelists List<String> - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- protocol String
- The access protocol. Supported protocols: HTTP and HTTPS.
- public
Domain String - The public endpoint of the instance.
- public
Port Integer - The public access port of the instance.
- public
Whitelists List<String> - The IP address whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- renew
Status String - The renewal status. Valid values:
- AutoRenewal: Auto-renewal.
- ManualRenewal: Manual renewal.
- NotRenewal: No renewal.
- renewal
Duration StringUnit The unit of the auto-renewal period. Valid values:
- M: Month.
- Y: Year.
NOTE: This parameter is required when RenewalStatus is set to AutoRenewal.
- resource
Group StringId - The ID of the resource group to which the instance belongs.
- setting
Config Map<String,String> - YML configuration file settings for the instance.
- status String
- The status of the instance.
- Map<String,String>
- Instance tag group.
- update
Strategy String Elasticsearch update strategy (for example, index updates, cluster upgrades, or service deployments). Valid values:
- blue_green: Blue-green deployment, which enables seamless switching by running two identical environments (blue and green) in parallel.
- normal: In-place update, which applies changes directly in the current environment (for example, upgrades or scaling) without requiring additional resources.
- intelligent: Intelligent update, where the system automatically analyzes the update type and environment status to dynamically select the optimal strategy (either blue-green or in-place).
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- version String
The instance version. Valid values:
- 8.5.1_with_X-Pack
- 7.10_with_X-Pack
- 6.7_with_X-Pack
- 7.7_with_X-Pack
- 6.8_with_X-Pack
- 6.3_with_X-Pack
- 5.6_with_X-Pack
- 5.5.3_with_X-Pack
NOTE: The versions listed above might not include all versions supported by Elasticsearch instances. You can call the GetRegionConfiguration operation to view the actual supported versions.
- vswitch
Id String - The ID of VSwitch.
- warm
Node IntegerAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm
Node InstanceConfiguration Warm Node Configuration - Cold data node configuration for the Elasticsearch cluster. See
warm_node_configurationbelow. - 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 number of zones for the instance. Valid values: 1, 2, and 3. Default value: 1.
The following arguments will be discarded. Please use new fields as soon as possible:
- arch
Type string - The deployment mode or architecture type:.
- auto
Renew numberDuration - Number of auto-renewal periods.
- client
Node numberAmount - The Elasticsearch cluster's client node quantity, between 2 and 25.
- client
Node InstanceConfiguration Client Node Configuration - Configuration of dedicated coordinating nodes in the Elasticsearch cluster. See
client_node_configurationbelow. - client
Node stringSpec - The client node spec. If specified, client node will be created.
- create
Time string - The time when the instance was created.
- data
Node numberAmount - The Elasticsearch cluster's data node quantity, between 2 and 50.
- data
Node InstanceConfiguration Data Node Configuration - Elasticsearch data node information. See
data_node_configurationbelow. - 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_typemuse 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
- Instance name, which supports fuzzy search. For example, searching for all instances containing
abcmay return instances namedabc,abcde,xyabc, orxabcy. - domain string
- The internal network address of the instance.
- enable
Kibana booleanPrivate Network - Indicates whether private network access to Kibana is enabled. Valid values:
- true: Enabled
- false: Disabled
- enable
Kibana booleanPublic Network - Specifies whether to enable public access to Kibana. Valid values:
- true: Enables public access.
- false: Disables public access.
- enable
Public boolean - Specifies whether to enable a public endpoint for the instance. Valid values:
- true: Enables the public endpoint.
- false: Disables the public endpoint.
- force boolean
Whether to force a restart:
- true: Yes
- false (default): No.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- instance
Category string - Edition type:
- x-pack: Creates a commercial edition instance, or a kernel-enhanced edition instance without Indexing Service or OpenStore enabled.
- IS: Creates a kernel-enhanced edition instance with Indexing Service or OpenStore enabled.
- 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 fromPostPaidtoPrePaid, the following attributes are required:period. Usepayment_typeinstead with valuesPayAsYouGoorSubscription. - kibana
Configuration InstanceKibana Configuration - The configuration of Elasticsearch Kibana nodes. See
kibana_configurationbelow. - kibana
Domain string - Kibana endpoint.
- kibana
Node stringSpec - The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small. - kibana
Port number - The access port for Kibana.
- kibana
Private stringDomain - The private endpoint of Kibana.
- kibana
Private stringSecurity Group Id - List of security groups.
- kibana
Private string[]Whitelists - List of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- kibana
Whitelists string[] - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- kms
Encrypted stringPassword - An KMS encrypts password used to an instance. If the
passwordis filled in, this field will be ignored, but you have to specify one ofpasswordandkms_encrypted_passwordfields. - kms
Encryption {[key: string]: string}Context - An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set. - master
Configuration InstanceMaster Configuration - Configuration information for Elasticsearch dedicated master nodes. See
master_configurationbelow. - 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.
- order
Action stringType Configuration change type. Valid values:
- upgrade (default): Upgrade configuration
- downgrade: Downgrade configuration.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- password string
- The access password for the instance. It must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@#$%^&*()_+-=).
- payment
Type string - The billing method of the instance. Supported values:
PayAsYouGo: Pay-as-you-goSubscription: Subscription
- period number
- The duration that you will buy Elasticsearch instance (in month). It is valid when PaymentType is
Subscription. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaidinstance. - port number
- Instance connection port.
- private
Whitelists string[] - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- protocol string
- The access protocol. Supported protocols: HTTP and HTTPS.
- public
Domain string - The public endpoint of the instance.
- public
Port number - The public access port of the instance.
- public
Whitelists string[] - The IP address whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- renew
Status string - The renewal status. Valid values:
- AutoRenewal: Auto-renewal.
- ManualRenewal: Manual renewal.
- NotRenewal: No renewal.
- renewal
Duration stringUnit The unit of the auto-renewal period. Valid values:
- M: Month.
- Y: Year.
NOTE: This parameter is required when RenewalStatus is set to AutoRenewal.
- resource
Group stringId - The ID of the resource group to which the instance belongs.
- setting
Config {[key: string]: string} - YML configuration file settings for the instance.
- status string
- The status of the instance.
- {[key: string]: string}
- Instance tag group.
- update
Strategy string Elasticsearch update strategy (for example, index updates, cluster upgrades, or service deployments). Valid values:
- blue_green: Blue-green deployment, which enables seamless switching by running two identical environments (blue and green) in parallel.
- normal: In-place update, which applies changes directly in the current environment (for example, upgrades or scaling) without requiring additional resources.
- intelligent: Intelligent update, where the system automatically analyzes the update type and environment status to dynamically select the optimal strategy (either blue-green or in-place).
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- version string
The instance version. Valid values:
- 8.5.1_with_X-Pack
- 7.10_with_X-Pack
- 6.7_with_X-Pack
- 7.7_with_X-Pack
- 6.8_with_X-Pack
- 6.3_with_X-Pack
- 5.6_with_X-Pack
- 5.5.3_with_X-Pack
NOTE: The versions listed above might not include all versions supported by Elasticsearch instances. You can call the GetRegionConfiguration operation to view the actual supported versions.
- vswitch
Id string - The ID of VSwitch.
- warm
Node numberAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm
Node InstanceConfiguration Warm Node Configuration - Cold data node configuration for the Elasticsearch cluster. See
warm_node_configurationbelow. - 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 number of zones for the instance. Valid values: 1, 2, and 3. Default value: 1.
The following arguments will be discarded. Please use new fields as soon as possible:
- arch_
type str - The deployment mode or architecture type:.
- auto_
renew_ intduration - Number of auto-renewal periods.
- client_
node_ intamount - The Elasticsearch cluster's client node quantity, between 2 and 25.
- client_
node_ Instanceconfiguration Client Node Configuration Args - Configuration of dedicated coordinating nodes in the Elasticsearch cluster. See
client_node_configurationbelow. - client_
node_ strspec - The client node spec. If specified, client node will be created.
- create_
time str - The time when the instance was created.
- data_
node_ intamount - The Elasticsearch cluster's data node quantity, between 2 and 50.
- data_
node_ Instanceconfiguration Data Node Configuration Args - Elasticsearch data node information. See
data_node_configurationbelow. - 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_typemuse 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
- Instance name, which supports fuzzy search. For example, searching for all instances containing
abcmay return instances namedabc,abcde,xyabc, orxabcy. - domain str
- The internal network address of the instance.
- enable_
kibana_ boolprivate_ network - Indicates whether private network access to Kibana is enabled. Valid values:
- true: Enabled
- false: Disabled
- enable_
kibana_ boolpublic_ network - Specifies whether to enable public access to Kibana. Valid values:
- true: Enables public access.
- false: Disables public access.
- enable_
public bool - Specifies whether to enable a public endpoint for the instance. Valid values:
- true: Enables the public endpoint.
- false: Disables the public endpoint.
- force bool
Whether to force a restart:
- true: Yes
- false (default): No.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- instance_
category str - Edition type:
- x-pack: Creates a commercial edition instance, or a kernel-enhanced edition instance without Indexing Service or OpenStore enabled.
- IS: Creates a kernel-enhanced edition instance with Indexing Service or OpenStore enabled.
- 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 fromPostPaidtoPrePaid, the following attributes are required:period. Usepayment_typeinstead with valuesPayAsYouGoorSubscription. - kibana_
configuration InstanceKibana Configuration Args - The configuration of Elasticsearch Kibana nodes. See
kibana_configurationbelow. - kibana_
domain str - Kibana endpoint.
- kibana_
node_ strspec - The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small. - kibana_
port int - The access port for Kibana.
- kibana_
private_ strdomain - The private endpoint of Kibana.
- kibana_
private_ strsecurity_ group_ id - List of security groups.
- kibana_
private_ Sequence[str]whitelists - List of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- kibana_
whitelists Sequence[str] - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- kms_
encrypted_ strpassword - An KMS encrypts password used to an instance. If the
passwordis filled in, this field will be ignored, but you have to specify one ofpasswordandkms_encrypted_passwordfields. - kms_
encryption_ Mapping[str, str]context - An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set. - master_
configuration InstanceMaster Configuration Args - Configuration information for Elasticsearch dedicated master nodes. See
master_configurationbelow. - 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.
- order_
action_ strtype Configuration change type. Valid values:
- upgrade (default): Upgrade configuration
- downgrade: Downgrade configuration.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- password str
- The access password for the instance. It must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@#$%^&*()_+-=).
- payment_
type str - The billing method of the instance. Supported values:
PayAsYouGo: Pay-as-you-goSubscription: Subscription
- period int
- The duration that you will buy Elasticsearch instance (in month). It is valid when PaymentType is
Subscription. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaidinstance. - port int
- Instance connection port.
- private_
whitelists Sequence[str] - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- protocol str
- The access protocol. Supported protocols: HTTP and HTTPS.
- public_
domain str - The public endpoint of the instance.
- public_
port int - The public access port of the instance.
- public_
whitelists Sequence[str] - The IP address whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- renew_
status str - The renewal status. Valid values:
- AutoRenewal: Auto-renewal.
- ManualRenewal: Manual renewal.
- NotRenewal: No renewal.
- renewal_
duration_ strunit The unit of the auto-renewal period. Valid values:
- M: Month.
- Y: Year.
NOTE: This parameter is required when RenewalStatus is set to AutoRenewal.
- resource_
group_ strid - The ID of the resource group to which the instance belongs.
- setting_
config Mapping[str, str] - YML configuration file settings for the instance.
- status str
- The status of the instance.
- Mapping[str, str]
- Instance tag group.
- update_
strategy str Elasticsearch update strategy (for example, index updates, cluster upgrades, or service deployments). Valid values:
- blue_green: Blue-green deployment, which enables seamless switching by running two identical environments (blue and green) in parallel.
- normal: In-place update, which applies changes directly in the current environment (for example, upgrades or scaling) without requiring additional resources.
- intelligent: Intelligent update, where the system automatically analyzes the update type and environment status to dynamically select the optimal strategy (either blue-green or in-place).
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- version str
The instance version. Valid values:
- 8.5.1_with_X-Pack
- 7.10_with_X-Pack
- 6.7_with_X-Pack
- 7.7_with_X-Pack
- 6.8_with_X-Pack
- 6.3_with_X-Pack
- 5.6_with_X-Pack
- 5.5.3_with_X-Pack
NOTE: The versions listed above might not include all versions supported by Elasticsearch instances. You can call the GetRegionConfiguration operation to view the actual supported versions.
- vswitch_
id str - The ID of VSwitch.
- warm_
node_ intamount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm_
node_ Instanceconfiguration Warm Node Configuration Args - Cold data node configuration for the Elasticsearch cluster. See
warm_node_configurationbelow. - 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 number of zones for the instance. Valid values: 1, 2, and 3. Default value: 1.
The following arguments will be discarded. Please use new fields as soon as possible:
- arch
Type String - The deployment mode or architecture type:.
- auto
Renew NumberDuration - Number of auto-renewal periods.
- client
Node NumberAmount - The Elasticsearch cluster's client node quantity, between 2 and 25.
- client
Node Property MapConfiguration - Configuration of dedicated coordinating nodes in the Elasticsearch cluster. See
client_node_configurationbelow. - client
Node StringSpec - The client node spec. If specified, client node will be created.
- create
Time String - The time when the instance was created.
- data
Node NumberAmount - The Elasticsearch cluster's data node quantity, between 2 and 50.
- data
Node Property MapConfiguration - Elasticsearch data node information. See
data_node_configurationbelow. - 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_typemuse 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
- Instance name, which supports fuzzy search. For example, searching for all instances containing
abcmay return instances namedabc,abcde,xyabc, orxabcy. - domain String
- The internal network address of the instance.
- enable
Kibana BooleanPrivate Network - Indicates whether private network access to Kibana is enabled. Valid values:
- true: Enabled
- false: Disabled
- enable
Kibana BooleanPublic Network - Specifies whether to enable public access to Kibana. Valid values:
- true: Enables public access.
- false: Disables public access.
- enable
Public Boolean - Specifies whether to enable a public endpoint for the instance. Valid values:
- true: Enables the public endpoint.
- false: Disables the public endpoint.
- force Boolean
Whether to force a restart:
- true: Yes
- false (default): No.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- instance
Category String - Edition type:
- x-pack: Creates a commercial edition instance, or a kernel-enhanced edition instance without Indexing Service or OpenStore enabled.
- IS: Creates a kernel-enhanced edition instance with Indexing Service or OpenStore enabled.
- 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 fromPostPaidtoPrePaid, the following attributes are required:period. Usepayment_typeinstead with valuesPayAsYouGoorSubscription. - kibana
Configuration Property Map - The configuration of Elasticsearch Kibana nodes. See
kibana_configurationbelow. - kibana
Domain String - Kibana endpoint.
- kibana
Node StringSpec - The kibana node specifications of the Elasticsearch instance. Default is
elasticsearch.n4.small. - kibana
Port Number - The access port for Kibana.
- kibana
Private StringDomain - The private endpoint of Kibana.
- kibana
Private StringSecurity Group Id - List of security groups.
- kibana
Private List<String>Whitelists - List of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- kibana
Whitelists List<String> - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- kms
Encrypted StringPassword - An KMS encrypts password used to an instance. If the
passwordis filled in, this field will be ignored, but you have to specify one ofpasswordandkms_encrypted_passwordfields. - kms
Encryption Map<String>Context - An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set. - master
Configuration Property Map - Configuration information for Elasticsearch dedicated master nodes. See
master_configurationbelow. - 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.
- order
Action StringType Configuration change type. Valid values:
- upgrade (default): Upgrade configuration
- downgrade: Downgrade configuration.
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- password String
- The access password for the instance. It must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@#$%^&*()_+-=).
- payment
Type String - The billing method of the instance. Supported values:
PayAsYouGo: Pay-as-you-goSubscription: Subscription
- period Number
- The duration that you will buy Elasticsearch instance (in month). It is valid when PaymentType is
Subscription. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaidinstance. - port Number
- Instance connection port.
- private
Whitelists List<String> - The list of IP addresses in the whitelist. This parameter is available when whiteIpGroup is empty and modifies the default group's whitelist.
- protocol String
- The access protocol. Supported protocols: HTTP and HTTPS.
- public
Domain String - The public endpoint of the instance.
- public
Port Number - The public access port of the instance.
- public
Whitelists List<String> - The IP address whitelist. This parameter is available when whiteIpGroup is empty and is used to modify the default group's whitelist.
- renew
Status String - The renewal status. Valid values:
- AutoRenewal: Auto-renewal.
- ManualRenewal: Manual renewal.
- NotRenewal: No renewal.
- renewal
Duration StringUnit The unit of the auto-renewal period. Valid values:
- M: Month.
- Y: Year.
NOTE: This parameter is required when RenewalStatus is set to AutoRenewal.
- resource
Group StringId - The ID of the resource group to which the instance belongs.
- setting
Config Map<String> - YML configuration file settings for the instance.
- status String
- The status of the instance.
- Map<String>
- Instance tag group.
- update
Strategy String Elasticsearch update strategy (for example, index updates, cluster upgrades, or service deployments). Valid values:
- blue_green: Blue-green deployment, which enables seamless switching by running two identical environments (blue and green) in parallel.
- normal: In-place update, which applies changes directly in the current environment (for example, upgrades or scaling) without requiring additional resources.
- intelligent: Intelligent update, where the system automatically analyzes the update type and environment status to dynamically select the optimal strategy (either blue-green or in-place).
NOTE: This parameter only takes effect when other resource properties are also modified. Changing this parameter alone will not trigger a resource update.
- version String
The instance version. Valid values:
- 8.5.1_with_X-Pack
- 7.10_with_X-Pack
- 6.7_with_X-Pack
- 7.7_with_X-Pack
- 6.8_with_X-Pack
- 6.3_with_X-Pack
- 5.6_with_X-Pack
- 5.5.3_with_X-Pack
NOTE: The versions listed above might not include all versions supported by Elasticsearch instances. You can call the GetRegionConfiguration operation to view the actual supported versions.
- vswitch
Id String - The ID of VSwitch.
- warm
Node NumberAmount - The Elasticsearch cluster's warm node quantity, between 3 and 50.
- warm
Node Property MapConfiguration - Cold data node configuration for the Elasticsearch cluster. See
warm_node_configurationbelow. - 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 number of zones for the instance. Valid values: 1, 2, and 3. Default value: 1.
The following arguments will be discarded. Please use new fields as soon as possible:
Supporting Types
InstanceClientNodeConfiguration, InstanceClientNodeConfigurationArgs
- Amount int
- Number of nodes.
- Disk int
- Node storage capacity, in GB.
- Disk
Type string - Storage type of the node. Only ultra disk (cloud_efficiency) is supported.
- Spec string
- Node specification. You can view specification details in Product Specifications.
- Amount int
- Number of nodes.
- Disk int
- Node storage capacity, in GB.
- Disk
Type string - Storage type of the node. Only ultra disk (cloud_efficiency) is supported.
- Spec string
- Node specification. You can view specification details in Product Specifications.
- amount Integer
- Number of nodes.
- disk Integer
- Node storage capacity, in GB.
- disk
Type String - Storage type of the node. Only ultra disk (cloud_efficiency) is supported.
- spec String
- Node specification. You can view specification details in Product Specifications.
- amount number
- Number of nodes.
- disk number
- Node storage capacity, in GB.
- disk
Type string - Storage type of the node. Only ultra disk (cloud_efficiency) is supported.
- spec string
- Node specification. You can view specification details in Product Specifications.
- amount int
- Number of nodes.
- disk int
- Node storage capacity, in GB.
- disk_
type str - Storage type of the node. Only ultra disk (cloud_efficiency) is supported.
- spec str
- Node specification. You can view specification details in Product Specifications.
- amount Number
- Number of nodes.
- disk Number
- Node storage capacity, in GB.
- disk
Type String - Storage type of the node. Only ultra disk (cloud_efficiency) is supported.
- spec String
- Node specification. You can view specification details in Product Specifications.
InstanceDataNodeConfiguration, InstanceDataNodeConfigurationArgs
- Spec string
- Node specification. For more information about specifications, see Product Specifications.
- Amount int
- Number of data nodes. Valid values: 2 to 50.
- Disk int
- Storage capacity per node, in GB.
- Disk
Encryption bool - Whether to enable cloud disk encryption:
- true: Enabled
- false: Disabled.
- Disk
Type string - Node disk type. Supported types:
- cloud_ssd: SSD cloud disk
- cloud_efficiency: Ultra cloud disk.
- Performance
Level string - Performance level of ESSD cloud disks. This parameter is required when diskType is set to cloud_essd. Supported values: PL1, PL2, PL3.
- Spec string
- Node specification. For more information about specifications, see Product Specifications.
- Amount int
- Number of data nodes. Valid values: 2 to 50.
- Disk int
- Storage capacity per node, in GB.
- Disk
Encryption bool - Whether to enable cloud disk encryption:
- true: Enabled
- false: Disabled.
- Disk
Type string - Node disk type. Supported types:
- cloud_ssd: SSD cloud disk
- cloud_efficiency: Ultra cloud disk.
- Performance
Level string - Performance level of ESSD cloud disks. This parameter is required when diskType is set to cloud_essd. Supported values: PL1, PL2, PL3.
- spec String
- Node specification. For more information about specifications, see Product Specifications.
- amount Integer
- Number of data nodes. Valid values: 2 to 50.
- disk Integer
- Storage capacity per node, in GB.
- disk
Encryption Boolean - Whether to enable cloud disk encryption:
- true: Enabled
- false: Disabled.
- disk
Type String - Node disk type. Supported types:
- cloud_ssd: SSD cloud disk
- cloud_efficiency: Ultra cloud disk.
- performance
Level String - Performance level of ESSD cloud disks. This parameter is required when diskType is set to cloud_essd. Supported values: PL1, PL2, PL3.
- spec string
- Node specification. For more information about specifications, see Product Specifications.
- amount number
- Number of data nodes. Valid values: 2 to 50.
- disk number
- Storage capacity per node, in GB.
- disk
Encryption boolean - Whether to enable cloud disk encryption:
- true: Enabled
- false: Disabled.
- disk
Type string - Node disk type. Supported types:
- cloud_ssd: SSD cloud disk
- cloud_efficiency: Ultra cloud disk.
- performance
Level string - Performance level of ESSD cloud disks. This parameter is required when diskType is set to cloud_essd. Supported values: PL1, PL2, PL3.
- spec str
- Node specification. For more information about specifications, see Product Specifications.
- amount int
- Number of data nodes. Valid values: 2 to 50.
- disk int
- Storage capacity per node, in GB.
- disk_
encryption bool - Whether to enable cloud disk encryption:
- true: Enabled
- false: Disabled.
- disk_
type str - Node disk type. Supported types:
- cloud_ssd: SSD cloud disk
- cloud_efficiency: Ultra cloud disk.
- performance_
level str - Performance level of ESSD cloud disks. This parameter is required when diskType is set to cloud_essd. Supported values: PL1, PL2, PL3.
- spec String
- Node specification. For more information about specifications, see Product Specifications.
- amount Number
- Number of data nodes. Valid values: 2 to 50.
- disk Number
- Storage capacity per node, in GB.
- disk
Encryption Boolean - Whether to enable cloud disk encryption:
- true: Enabled
- false: Disabled.
- disk
Type String - Node disk type. Supported types:
- cloud_ssd: SSD cloud disk
- cloud_efficiency: Ultra cloud disk.
- performance
Level String - Performance level of ESSD cloud disks. This parameter is required when diskType is set to cloud_essd. Supported values: PL1, PL2, PL3.
InstanceKibanaConfiguration, InstanceKibanaConfigurationArgs
- Spec string
- Node specification. For specification details, see Product Specifications.
- Amount int
- The number of nodes.
- Disk int
- Storage capacity per node, in GB.
- Spec string
- Node specification. For specification details, see Product Specifications.
- Amount int
- The number of nodes.
- Disk int
- Storage capacity per node, in GB.
- spec String
- Node specification. For specification details, see Product Specifications.
- amount Integer
- The number of nodes.
- disk Integer
- Storage capacity per node, in GB.
- spec string
- Node specification. For specification details, see Product Specifications.
- amount number
- The number of nodes.
- disk number
- Storage capacity per node, in GB.
- spec str
- Node specification. For specification details, see Product Specifications.
- amount int
- The number of nodes.
- disk int
- Storage capacity per node, in GB.
- spec String
- Node specification. For specification details, see Product Specifications.
- amount Number
- The number of nodes.
- disk Number
- Storage capacity per node, in GB.
InstanceMasterConfiguration, InstanceMasterConfigurationArgs
- Amount int
- Number of nodes.
- Disk int
- Node storage capacity, in GB.
- Disk
Type string - Node storage type. Only cloud_ssd (SSD cloud disk) is supported.
- Spec string
- Node specification. For specifications, see Product Specifications.
- Amount int
- Number of nodes.
- Disk int
- Node storage capacity, in GB.
- Disk
Type string - Node storage type. Only cloud_ssd (SSD cloud disk) is supported.
- Spec string
- Node specification. For specifications, see Product Specifications.
- amount Integer
- Number of nodes.
- disk Integer
- Node storage capacity, in GB.
- disk
Type String - Node storage type. Only cloud_ssd (SSD cloud disk) is supported.
- spec String
- Node specification. For specifications, see Product Specifications.
- amount number
- Number of nodes.
- disk number
- Node storage capacity, in GB.
- disk
Type string - Node storage type. Only cloud_ssd (SSD cloud disk) is supported.
- spec string
- Node specification. For specifications, see Product Specifications.
- amount int
- Number of nodes.
- disk int
- Node storage capacity, in GB.
- disk_
type str - Node storage type. Only cloud_ssd (SSD cloud disk) is supported.
- spec str
- Node specification. For specifications, see Product Specifications.
- amount Number
- Number of nodes.
- disk Number
- Node storage capacity, in GB.
- disk
Type String - Node storage type. Only cloud_ssd (SSD cloud disk) is supported.
- spec String
- Node specification. For specifications, see Product Specifications.
InstanceWarmNodeConfiguration, InstanceWarmNodeConfigurationArgs
- Amount int
- Number of nodes.
- Disk int
- Storage capacity per node, in GB.
- Disk
Encryption bool - Whether to enable disk encryption. The values are as follows:
- true: Enabled.
- false: Disabled.
- Disk
Type string - Storage type for the node. Only
cloud_efficiency(ultra disk) is supported. - Spec string
- Node specification. For specifications, see Product Specifications.
- Amount int
- Number of nodes.
- Disk int
- Storage capacity per node, in GB.
- Disk
Encryption bool - Whether to enable disk encryption. The values are as follows:
- true: Enabled.
- false: Disabled.
- Disk
Type string - Storage type for the node. Only
cloud_efficiency(ultra disk) is supported. - Spec string
- Node specification. For specifications, see Product Specifications.
- amount Integer
- Number of nodes.
- disk Integer
- Storage capacity per node, in GB.
- disk
Encryption Boolean - Whether to enable disk encryption. The values are as follows:
- true: Enabled.
- false: Disabled.
- disk
Type String - Storage type for the node. Only
cloud_efficiency(ultra disk) is supported. - spec String
- Node specification. For specifications, see Product Specifications.
- amount number
- Number of nodes.
- disk number
- Storage capacity per node, in GB.
- disk
Encryption boolean - Whether to enable disk encryption. The values are as follows:
- true: Enabled.
- false: Disabled.
- disk
Type string - Storage type for the node. Only
cloud_efficiency(ultra disk) is supported. - spec string
- Node specification. For specifications, see Product Specifications.
- amount int
- Number of nodes.
- disk int
- Storage capacity per node, in GB.
- disk_
encryption bool - Whether to enable disk encryption. The values are as follows:
- true: Enabled.
- false: Disabled.
- disk_
type str - Storage type for the node. Only
cloud_efficiency(ultra disk) is supported. - spec str
- Node specification. For specifications, see Product Specifications.
- amount Number
- Number of nodes.
- disk Number
- Storage capacity per node, in GB.
- disk
Encryption Boolean - Whether to enable disk encryption. The values are as follows:
- true: Enabled.
- false: Disabled.
- disk
Type String - Storage type for the node. Only
cloud_efficiency(ultra disk) is supported. - spec String
- Node specification. For specifications, see Product Specifications.
Import
Elasticsearch Instance can be imported using the id, e.g.
$ pulumi import alicloud:elasticsearch/instance:Instance example <instance_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloudTerraform Provider.
published on Saturday, Mar 14, 2026 by Pulumi
