Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. elasticsearch
  5. Instance
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.elasticsearch.Instance

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

    Import

    Elasticsearch can be imported using the id, e.g.

    $ pulumi import alicloud:elasticsearch/instance:Instance example es-cn-abcde123456

    Create Instance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             data_node_disk_size: Optional[int] = None,
             vswitch_id: Optional[str] = None,
             version: Optional[str] = None,
             data_node_amount: Optional[int] = None,
             data_node_spec: Optional[str] = None,
             data_node_disk_type: Optional[str] = None,
             master_node_disk_type: Optional[str] = None,
             period: Optional[int] = None,
             data_node_disk_encrypted: Optional[bool] = None,
             description: Optional[str] = None,
             enable_kibana_private_network: Optional[bool] = None,
             enable_kibana_public_network: Optional[bool] = None,
             enable_public: Optional[bool] = None,
             instance_charge_type: Optional[str] = None,
             kibana_node_spec: Optional[str] = None,
             kibana_private_security_group_id: Optional[str] = None,
             kibana_private_whitelists: Optional[Sequence[str]] = None,
             kibana_whitelists: Optional[Sequence[str]] = None,
             kms_encrypted_password: Optional[str] = None,
             kms_encryption_context: Optional[Mapping[str, str]] = None,
             auto_renew_duration: Optional[int] = None,
             master_node_spec: Optional[str] = None,
             password: Optional[str] = None,
             data_node_disk_performance_level: Optional[str] = None,
             private_whitelists: Optional[Sequence[str]] = None,
             protocol: Optional[str] = None,
             public_whitelists: Optional[Sequence[str]] = None,
             renew_status: Optional[str] = None,
             renewal_duration_unit: Optional[str] = None,
             resource_group_id: Optional[str] = None,
             setting_config: Optional[Mapping[str, str]] = None,
             tags: Optional[Mapping[str, str]] = None,
             client_node_spec: Optional[str] = None,
             client_node_amount: Optional[int] = None,
             warm_node_amount: Optional[int] = None,
             warm_node_disk_encrypted: Optional[bool] = None,
             warm_node_disk_size: Optional[int] = None,
             warm_node_disk_type: Optional[str] = None,
             warm_node_spec: Optional[str] = None,
             zone_count: Optional[int] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

    type: alicloud:elasticsearch:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleinstanceResourceResourceFromElasticsearchinstance = new AliCloud.ElasticSearch.Instance("exampleinstanceResourceResourceFromElasticsearchinstance", new()
{
    DataNodeDiskSize = 0,
    VswitchId = "string",
    Version = "string",
    DataNodeAmount = 0,
    DataNodeSpec = "string",
    DataNodeDiskType = "string",
    MasterNodeDiskType = "string",
    Period = 0,
    DataNodeDiskEncrypted = false,
    Description = "string",
    EnableKibanaPrivateNetwork = false,
    EnableKibanaPublicNetwork = false,
    EnablePublic = false,
    InstanceChargeType = "string",
    KibanaNodeSpec = "string",
    KibanaPrivateSecurityGroupId = "string",
    KibanaPrivateWhitelists = new[]
    {
        "string",
    },
    KibanaWhitelists = new[]
    {
        "string",
    },
    KmsEncryptedPassword = "string",
    KmsEncryptionContext = 
    {
        { "string", "string" },
    },
    AutoRenewDuration = 0,
    MasterNodeSpec = "string",
    Password = "string",
    DataNodeDiskPerformanceLevel = "string",
    PrivateWhitelists = new[]
    {
        "string",
    },
    Protocol = "string",
    PublicWhitelists = new[]
    {
        "string",
    },
    RenewStatus = "string",
    RenewalDurationUnit = "string",
    ResourceGroupId = "string",
    SettingConfig = 
    {
        { "string", "string" },
    },
    Tags = 
    {
        { "string", "string" },
    },
    ClientNodeSpec = "string",
    ClientNodeAmount = 0,
    WarmNodeAmount = 0,
    WarmNodeDiskEncrypted = false,
    WarmNodeDiskSize = 0,
    WarmNodeDiskType = "string",
    WarmNodeSpec = "string",
    ZoneCount = 0,
});

    example, err := elasticsearch.NewInstance(ctx, "exampleinstanceResourceResourceFromElasticsearchinstance", &elasticsearch.InstanceArgs{
	DataNodeDiskSize:             pulumi.Int(0),
	VswitchId:                    pulumi.String("string"),
	Version:                      pulumi.String("string"),
	DataNodeAmount:               pulumi.Int(0),
	DataNodeSpec:                 pulumi.String("string"),
	DataNodeDiskType:             pulumi.String("string"),
	MasterNodeDiskType:           pulumi.String("string"),
	Period:                       pulumi.Int(0),
	DataNodeDiskEncrypted:        pulumi.Bool(false),
	Description:                  pulumi.String("string"),
	EnableKibanaPrivateNetwork:   pulumi.Bool(false),
	EnableKibanaPublicNetwork:    pulumi.Bool(false),
	EnablePublic:                 pulumi.Bool(false),
	InstanceChargeType:           pulumi.String("string"),
	KibanaNodeSpec:               pulumi.String("string"),
	KibanaPrivateSecurityGroupId: pulumi.String("string"),
	KibanaPrivateWhitelists: pulumi.StringArray{
		pulumi.String("string"),
	},
	KibanaWhitelists: pulumi.StringArray{
		pulumi.String("string"),
	},
	KmsEncryptedPassword: pulumi.String("string"),
	KmsEncryptionContext: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AutoRenewDuration:            pulumi.Int(0),
	MasterNodeSpec:               pulumi.String("string"),
	Password:                     pulumi.String("string"),
	DataNodeDiskPerformanceLevel: pulumi.String("string"),
	PrivateWhitelists: pulumi.StringArray{
		pulumi.String("string"),
	},
	Protocol: pulumi.String("string"),
	PublicWhitelists: pulumi.StringArray{
		pulumi.String("string"),
	},
	RenewStatus:         pulumi.String("string"),
	RenewalDurationUnit: pulumi.String("string"),
	ResourceGroupId:     pulumi.String("string"),
	SettingConfig: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ClientNodeSpec:        pulumi.String("string"),
	ClientNodeAmount:      pulumi.Int(0),
	WarmNodeAmount:        pulumi.Int(0),
	WarmNodeDiskEncrypted: pulumi.Bool(false),
	WarmNodeDiskSize:      pulumi.Int(0),
	WarmNodeDiskType:      pulumi.String("string"),
	WarmNodeSpec:          pulumi.String("string"),
	ZoneCount:             pulumi.Int(0),
})

    var exampleinstanceResourceResourceFromElasticsearchinstance = new Instance("exampleinstanceResourceResourceFromElasticsearchinstance", InstanceArgs.builder()
    .dataNodeDiskSize(0)
    .vswitchId("string")
    .version("string")
    .dataNodeAmount(0)
    .dataNodeSpec("string")
    .dataNodeDiskType("string")
    .masterNodeDiskType("string")
    .period(0)
    .dataNodeDiskEncrypted(false)
    .description("string")
    .enableKibanaPrivateNetwork(false)
    .enableKibanaPublicNetwork(false)
    .enablePublic(false)
    .instanceChargeType("string")
    .kibanaNodeSpec("string")
    .kibanaPrivateSecurityGroupId("string")
    .kibanaPrivateWhitelists("string")
    .kibanaWhitelists("string")
    .kmsEncryptedPassword("string")
    .kmsEncryptionContext(Map.of("string", "string"))
    .autoRenewDuration(0)
    .masterNodeSpec("string")
    .password("string")
    .dataNodeDiskPerformanceLevel("string")
    .privateWhitelists("string")
    .protocol("string")
    .publicWhitelists("string")
    .renewStatus("string")
    .renewalDurationUnit("string")
    .resourceGroupId("string")
    .settingConfig(Map.of("string", "string"))
    .tags(Map.of("string", "string"))
    .clientNodeSpec("string")
    .clientNodeAmount(0)
    .warmNodeAmount(0)
    .warmNodeDiskEncrypted(false)
    .warmNodeDiskSize(0)
    .warmNodeDiskType("string")
    .warmNodeSpec("string")
    .zoneCount(0)
    .build());

    exampleinstance_resource_resource_from_elasticsearchinstance = alicloud.elasticsearch.Instance("exampleinstanceResourceResourceFromElasticsearchinstance",
    data_node_disk_size=0,
    vswitch_id="string",
    version="string",
    data_node_amount=0,
    data_node_spec="string",
    data_node_disk_type="string",
    master_node_disk_type="string",
    period=0,
    data_node_disk_encrypted=False,
    description="string",
    enable_kibana_private_network=False,
    enable_kibana_public_network=False,
    enable_public=False,
    instance_charge_type="string",
    kibana_node_spec="string",
    kibana_private_security_group_id="string",
    kibana_private_whitelists=["string"],
    kibana_whitelists=["string"],
    kms_encrypted_password="string",
    kms_encryption_context={
        "string": "string",
    },
    auto_renew_duration=0,
    master_node_spec="string",
    password="string",
    data_node_disk_performance_level="string",
    private_whitelists=["string"],
    protocol="string",
    public_whitelists=["string"],
    renew_status="string",
    renewal_duration_unit="string",
    resource_group_id="string",
    setting_config={
        "string": "string",
    },
    tags={
        "string": "string",
    },
    client_node_spec="string",
    client_node_amount=0,
    warm_node_amount=0,
    warm_node_disk_encrypted=False,
    warm_node_disk_size=0,
    warm_node_disk_type="string",
    warm_node_spec="string",
    zone_count=0)

    const exampleinstanceResourceResourceFromElasticsearchinstance = new alicloud.elasticsearch.Instance("exampleinstanceResourceResourceFromElasticsearchinstance", {
    dataNodeDiskSize: 0,
    vswitchId: "string",
    version: "string",
    dataNodeAmount: 0,
    dataNodeSpec: "string",
    dataNodeDiskType: "string",
    masterNodeDiskType: "string",
    period: 0,
    dataNodeDiskEncrypted: false,
    description: "string",
    enableKibanaPrivateNetwork: false,
    enableKibanaPublicNetwork: false,
    enablePublic: false,
    instanceChargeType: "string",
    kibanaNodeSpec: "string",
    kibanaPrivateSecurityGroupId: "string",
    kibanaPrivateWhitelists: ["string"],
    kibanaWhitelists: ["string"],
    kmsEncryptedPassword: "string",
    kmsEncryptionContext: {
        string: "string",
    },
    autoRenewDuration: 0,
    masterNodeSpec: "string",
    password: "string",
    dataNodeDiskPerformanceLevel: "string",
    privateWhitelists: ["string"],
    protocol: "string",
    publicWhitelists: ["string"],
    renewStatus: "string",
    renewalDurationUnit: "string",
    resourceGroupId: "string",
    settingConfig: {
        string: "string",
    },
    tags: {
        string: "string",
    },
    clientNodeSpec: "string",
    clientNodeAmount: 0,
    warmNodeAmount: 0,
    warmNodeDiskEncrypted: false,
    warmNodeDiskSize: 0,
    warmNodeDiskType: "string",
    warmNodeSpec: "string",
    zoneCount: 0,
});

    type: alicloud:elasticsearch:Instance
properties:
    autoRenewDuration: 0
    clientNodeAmount: 0
    clientNodeSpec: string
    dataNodeAmount: 0
    dataNodeDiskEncrypted: false
    dataNodeDiskPerformanceLevel: string
    dataNodeDiskSize: 0
    dataNodeDiskType: string
    dataNodeSpec: string
    description: string
    enableKibanaPrivateNetwork: false
    enableKibanaPublicNetwork: false
    enablePublic: false
    instanceChargeType: string
    kibanaNodeSpec: string
    kibanaPrivateSecurityGroupId: string
    kibanaPrivateWhitelists:
        - string
    kibanaWhitelists:
        - string
    kmsEncryptedPassword: string
    kmsEncryptionContext:
        string: string
    masterNodeDiskType: string
    masterNodeSpec: string
    password: string
    period: 0
    privateWhitelists:
        - string
    protocol: string
    publicWhitelists:
        - string
    renewStatus: string
    renewalDurationUnit: string
    resourceGroupId: string
    settingConfig:
        string: string
    tags:
        string: string
    version: string
    vswitchId: string
    warmNodeAmount: 0
    warmNodeDiskEncrypted: false
    warmNodeDiskSize: 0
    warmNodeDiskType: string
    warmNodeSpec: string
    zoneCount: 0

    Instance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    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:

    DataNodeAmount int
    The Elasticsearch cluster's data node quantity, between 2 and 50.
    DataNodeDiskSize int
    The single data node storage space.
    DataNodeDiskType string
    The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
    DataNodeSpec string
    The data node specifications of the Elasticsearch instance.
    Version string
    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack , 7.7_with_X-Pack, 7.10_with_X-Pack, 7.16_with_X-Pack, 8.5_with_X-Pack, 8.9_with_X-Pack, 8.13_with_X-Pack.
    VswitchId string
    The ID of VSwitch.
    AutoRenewDuration int
    Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when instance_charge_type is PrePaid and renew_status is AutoRenewal.
    ClientNodeAmount int
    The Elasticsearch cluster's client node quantity, between 2 and 25.
    ClientNodeSpec string
    The client node spec. If specified, client node will be created.
    DataNodeDiskEncrypted bool
    If encrypt the data node disk. Valid values are true, false. Default to false.
    DataNodeDiskPerformanceLevel string
    Cloud disk performance level. Valid values are PL0, PL1, PL2, PL3. The data_node_disk_type muse be cloud_essd.
    Description string
    The description of instance. It a string of 0 to 30 characters.
    EnableKibanaPrivateNetwork bool
    Bool, default to false. When it set to true, the instance can close kibana private network access。
    EnableKibanaPublicNetwork bool
    Bool, default to true. When it set to false, the instance can enable kibana public network access。
    EnablePublic bool
    Bool, default to false. When it set to true, the instance can enable public network access。
    InstanceChargeType string
    Valid values are PrePaid, PostPaid. Default to PostPaid. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype from PostPaid to PrePaid, the following attributes are required: period. But, updating from PostPaid to PrePaid is not supported.
    KibanaNodeSpec string
    The kibana node specifications of the Elasticsearch instance. Default is elasticsearch.n4.small.
    KibanaPrivateSecurityGroupId string
    the security group id associated with Kibana private network, this param is required when enable_kibana_private_network set true, and the security group id should in the same VPC as vswitch_id
    KibanaPrivateWhitelists List<string>
    Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use kibana_private_security_group_id instead
    KibanaWhitelists List<string>
    Set the Kibana's IP whitelist in internet network.
    KmsEncryptedPassword string
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored, but you have to specify one of password and kms_encrypted_password fields.
    KmsEncryptionContext Dictionary<string, string>
    An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
    MasterNodeDiskType string
    The single master node storage space. Valid values are PrePaid, PostPaid.
    MasterNodeSpec string
    The dedicated master node spec. If specified, dedicated master node will be created.
    Password string
    The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (!@#$%^&*()_+-=).
    Period int
    The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal a PrePaid instance.
    PrivateWhitelists List<string>
    Set the instance's IP whitelist in VPC network.
    Protocol string
    Elasticsearch protocol. Supported values: HTTP, HTTPS.default is HTTP.
    PublicWhitelists List<string>
    Set the instance's IP whitelist in internet network.
    RenewStatus string
    The renewal status of the specified instance. Valid values: AutoRenewal, ManualRenewal, NotRenewal.The instance_charge_type must be PrePaid.
    RenewalDurationUnit string
    Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values: M, Y.
    ResourceGroupId string
    The ID of resource group which the Elasticsearch instance belongs.
    SettingConfig Dictionary<string, string>
    The YML configuration of the instance.Detailed introduction.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    WarmNodeAmount int
    The Elasticsearch cluster's warm node quantity, between 3 and 50.
    WarmNodeDiskEncrypted bool
    If encrypt the warm node disk. Valid values are true, false. Default to false.
    WarmNodeDiskSize int
    The single warm node storage space, should between 500 and 20480
    WarmNodeDiskType string
    The warm node disk type. Supported values: cloud_efficiency.
    WarmNodeSpec string
    The warm node specifications of the Elasticsearch instance.
    ZoneCount int
    The Multi-AZ supported for Elasticsearch, between 1 and 3. The data_node_amount value must be an integral multiple of the zone_count value.
    DataNodeAmount int
    The Elasticsearch cluster's data node quantity, between 2 and 50.
    DataNodeDiskSize int
    The single data node storage space.
    DataNodeDiskType string
    The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
    DataNodeSpec string
    The data node specifications of the Elasticsearch instance.
    Version string
    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack , 7.7_with_X-Pack, 7.10_with_X-Pack, 7.16_with_X-Pack, 8.5_with_X-Pack, 8.9_with_X-Pack, 8.13_with_X-Pack.
    VswitchId string
    The ID of VSwitch.
    AutoRenewDuration int
    Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when instance_charge_type is PrePaid and renew_status is AutoRenewal.
    ClientNodeAmount int
    The Elasticsearch cluster's client node quantity, between 2 and 25.
    ClientNodeSpec string
    The client node spec. If specified, client node will be created.
    DataNodeDiskEncrypted bool
    If encrypt the data node disk. Valid values are true, false. Default to false.
    DataNodeDiskPerformanceLevel string
    Cloud disk performance level. Valid values are PL0, PL1, PL2, PL3. The data_node_disk_type muse be cloud_essd.
    Description string
    The description of instance. It a string of 0 to 30 characters.
    EnableKibanaPrivateNetwork bool
    Bool, default to false. When it set to true, the instance can close kibana private network access。
    EnableKibanaPublicNetwork bool
    Bool, default to true. When it set to false, the instance can enable kibana public network access。
    EnablePublic bool
    Bool, default to false. When it set to true, the instance can enable public network access。
    InstanceChargeType string
    Valid values are PrePaid, PostPaid. Default to PostPaid. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype from PostPaid to PrePaid, the following attributes are required: period. But, updating from PostPaid to PrePaid is not supported.
    KibanaNodeSpec string
    The kibana node specifications of the Elasticsearch instance. Default is elasticsearch.n4.small.
    KibanaPrivateSecurityGroupId string
    the security group id associated with Kibana private network, this param is required when enable_kibana_private_network set true, and the security group id should in the same VPC as vswitch_id
    KibanaPrivateWhitelists []string
    Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use kibana_private_security_group_id instead
    KibanaWhitelists []string
    Set the Kibana's IP whitelist in internet network.
    KmsEncryptedPassword string
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored, but you have to specify one of password and kms_encrypted_password fields.
    KmsEncryptionContext map[string]string
    An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
    MasterNodeDiskType string
    The single master node storage space. Valid values are PrePaid, PostPaid.
    MasterNodeSpec string
    The dedicated master node spec. If specified, dedicated master node will be created.
    Password string
    The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (!@#$%^&*()_+-=).
    Period int
    The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal a PrePaid instance.
    PrivateWhitelists []string
    Set the instance's IP whitelist in VPC network.
    Protocol string
    Elasticsearch protocol. Supported values: HTTP, HTTPS.default is HTTP.
    PublicWhitelists []string
    Set the instance's IP whitelist in internet network.
    RenewStatus string
    The renewal status of the specified instance. Valid values: AutoRenewal, ManualRenewal, NotRenewal.The instance_charge_type must be PrePaid.
    RenewalDurationUnit string
    Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values: M, Y.
    ResourceGroupId string
    The ID of resource group which the Elasticsearch instance belongs.
    SettingConfig map[string]string
    The YML configuration of the instance.Detailed introduction.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    WarmNodeAmount int
    The Elasticsearch cluster's warm node quantity, between 3 and 50.
    WarmNodeDiskEncrypted bool
    If encrypt the warm node disk. Valid values are true, false. Default to false.
    WarmNodeDiskSize int
    The single warm node storage space, should between 500 and 20480
    WarmNodeDiskType string
    The warm node disk type. Supported values: cloud_efficiency.
    WarmNodeSpec string
    The warm node specifications of the Elasticsearch instance.
    ZoneCount int
    The Multi-AZ supported for Elasticsearch, between 1 and 3. The data_node_amount value must be an integral multiple of the zone_count value.
    dataNodeAmount Integer
    The Elasticsearch cluster's data node quantity, between 2 and 50.
    dataNodeDiskSize Integer
    The single data node storage space.
    dataNodeDiskType String
    The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
    dataNodeSpec String
    The data node specifications of the Elasticsearch instance.
    version String
    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack , 7.7_with_X-Pack, 7.10_with_X-Pack, 7.16_with_X-Pack, 8.5_with_X-Pack, 8.9_with_X-Pack, 8.13_with_X-Pack.
    vswitchId String
    The ID of VSwitch.
    autoRenewDuration Integer
    Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when instance_charge_type is PrePaid and renew_status is AutoRenewal.
    clientNodeAmount Integer
    The Elasticsearch cluster's client node quantity, between 2 and 25.
    clientNodeSpec String
    The client node spec. If specified, client node will be created.
    dataNodeDiskEncrypted Boolean
    If encrypt the data node disk. Valid values are true, false. Default to false.
    dataNodeDiskPerformanceLevel String
    Cloud disk performance level. Valid values are PL0, PL1, PL2, PL3. The data_node_disk_type muse be cloud_essd.
    description String
    The description of instance. It a string of 0 to 30 characters.
    enableKibanaPrivateNetwork Boolean
    Bool, default to false. When it set to true, the instance can close kibana private network access。
    enableKibanaPublicNetwork Boolean
    Bool, default to true. When it set to false, the instance can enable kibana public network access。
    enablePublic Boolean
    Bool, default to false. When it set to true, the instance can enable public network access。
    instanceChargeType String
    Valid values are PrePaid, PostPaid. Default to PostPaid. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype from PostPaid to PrePaid, the following attributes are required: period. But, updating from PostPaid to PrePaid is not supported.
    kibanaNodeSpec String
    The kibana node specifications of the Elasticsearch instance. Default is elasticsearch.n4.small.
    kibanaPrivateSecurityGroupId String
    the security group id associated with Kibana private network, this param is required when enable_kibana_private_network set true, and the security group id should in the same VPC as vswitch_id
    kibanaPrivateWhitelists List<String>
    Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use kibana_private_security_group_id instead
    kibanaWhitelists List<String>
    Set the Kibana's IP whitelist in internet network.
    kmsEncryptedPassword String
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored, but you have to specify one of password and kms_encrypted_password fields.
    kmsEncryptionContext Map<String,String>
    An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
    masterNodeDiskType String
    The single master node storage space. Valid values are PrePaid, PostPaid.
    masterNodeSpec String
    The dedicated master node spec. If specified, dedicated master node will be created.
    password String
    The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (!@#$%^&*()_+-=).
    period Integer
    The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal a PrePaid instance.
    privateWhitelists List<String>
    Set the instance's IP whitelist in VPC network.
    protocol String
    Elasticsearch protocol. Supported values: HTTP, HTTPS.default is HTTP.
    publicWhitelists List<String>
    Set the instance's IP whitelist in internet network.
    renewStatus String
    The renewal status of the specified instance. Valid values: AutoRenewal, ManualRenewal, NotRenewal.The instance_charge_type must be PrePaid.
    renewalDurationUnit String
    Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values: M, Y.
    resourceGroupId String
    The ID of resource group which the Elasticsearch instance belongs.
    settingConfig Map<String,String>
    The YML configuration of the instance.Detailed introduction.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    warmNodeAmount Integer
    The Elasticsearch cluster's warm node quantity, between 3 and 50.
    warmNodeDiskEncrypted Boolean
    If encrypt the warm node disk. Valid values are true, false. Default to false.
    warmNodeDiskSize Integer
    The single warm node storage space, should between 500 and 20480
    warmNodeDiskType String
    The warm node disk type. Supported values: cloud_efficiency.
    warmNodeSpec String
    The warm node specifications of the Elasticsearch instance.
    zoneCount Integer
    The Multi-AZ supported for Elasticsearch, between 1 and 3. The data_node_amount value must be an integral multiple of the zone_count value.
    dataNodeAmount number
    The Elasticsearch cluster's data node quantity, between 2 and 50.
    dataNodeDiskSize number
    The single data node storage space.
    dataNodeDiskType string
    The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
    dataNodeSpec string
    The data node specifications of the Elasticsearch instance.
    version string
    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack , 7.7_with_X-Pack, 7.10_with_X-Pack, 7.16_with_X-Pack, 8.5_with_X-Pack, 8.9_with_X-Pack, 8.13_with_X-Pack.
    vswitchId string
    The ID of VSwitch.
    autoRenewDuration number
    Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when instance_charge_type is PrePaid and renew_status is AutoRenewal.
    clientNodeAmount number
    The Elasticsearch cluster's client node quantity, between 2 and 25.
    clientNodeSpec string
    The client node spec. If specified, client node will be created.
    dataNodeDiskEncrypted boolean
    If encrypt the data node disk. Valid values are true, false. Default to false.
    dataNodeDiskPerformanceLevel string
    Cloud disk performance level. Valid values are PL0, PL1, PL2, PL3. The data_node_disk_type muse be cloud_essd.
    description string
    The description of instance. It a string of 0 to 30 characters.
    enableKibanaPrivateNetwork boolean
    Bool, default to false. When it set to true, the instance can close kibana private network access。
    enableKibanaPublicNetwork boolean
    Bool, default to true. When it set to false, the instance can enable kibana public network access。
    enablePublic boolean
    Bool, default to false. When it set to true, the instance can enable public network access。
    instanceChargeType string
    Valid values are PrePaid, PostPaid. Default to PostPaid. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype from PostPaid to PrePaid, the following attributes are required: period. But, updating from PostPaid to PrePaid is not supported.
    kibanaNodeSpec string
    The kibana node specifications of the Elasticsearch instance. Default is elasticsearch.n4.small.
    kibanaPrivateSecurityGroupId string
    the security group id associated with Kibana private network, this param is required when enable_kibana_private_network set true, and the security group id should in the same VPC as vswitch_id
    kibanaPrivateWhitelists string[]
    Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use kibana_private_security_group_id instead
    kibanaWhitelists string[]
    Set the Kibana's IP whitelist in internet network.
    kmsEncryptedPassword string
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored, but you have to specify one of password and kms_encrypted_password fields.
    kmsEncryptionContext {[key: string]: string}
    An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
    masterNodeDiskType string
    The single master node storage space. Valid values are PrePaid, PostPaid.
    masterNodeSpec string
    The dedicated master node spec. If specified, dedicated master node will be created.
    password string
    The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (!@#$%^&*()_+-=).
    period number
    The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal a PrePaid instance.
    privateWhitelists string[]
    Set the instance's IP whitelist in VPC network.
    protocol string
    Elasticsearch protocol. Supported values: HTTP, HTTPS.default is HTTP.
    publicWhitelists string[]
    Set the instance's IP whitelist in internet network.
    renewStatus string
    The renewal status of the specified instance. Valid values: AutoRenewal, ManualRenewal, NotRenewal.The instance_charge_type must be PrePaid.
    renewalDurationUnit string
    Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values: M, Y.
    resourceGroupId string
    The ID of resource group which the Elasticsearch instance belongs.
    settingConfig {[key: string]: string}
    The YML configuration of the instance.Detailed introduction.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    warmNodeAmount number
    The Elasticsearch cluster's warm node quantity, between 3 and 50.
    warmNodeDiskEncrypted boolean
    If encrypt the warm node disk. Valid values are true, false. Default to false.
    warmNodeDiskSize number
    The single warm node storage space, should between 500 and 20480
    warmNodeDiskType string
    The warm node disk type. Supported values: cloud_efficiency.
    warmNodeSpec string
    The warm node specifications of the Elasticsearch instance.
    zoneCount number
    The Multi-AZ supported for Elasticsearch, between 1 and 3. The data_node_amount value must be an integral multiple of the zone_count value.
    data_node_amount int
    The Elasticsearch cluster's data node quantity, between 2 and 50.
    data_node_disk_size int
    The single data node storage space.
    data_node_disk_type str
    The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
    data_node_spec str
    The data node specifications of the Elasticsearch instance.
    version str
    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack , 7.7_with_X-Pack, 7.10_with_X-Pack, 7.16_with_X-Pack, 8.5_with_X-Pack, 8.9_with_X-Pack, 8.13_with_X-Pack.
    vswitch_id str
    The ID of VSwitch.
    auto_renew_duration int
    Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when instance_charge_type is PrePaid and renew_status is AutoRenewal.
    client_node_amount int
    The Elasticsearch cluster's client node quantity, between 2 and 25.
    client_node_spec str
    The client node spec. If specified, client node will be created.
    data_node_disk_encrypted bool
    If encrypt the data node disk. Valid values are true, false. Default to false.
    data_node_disk_performance_level str
    Cloud disk performance level. Valid values are PL0, PL1, PL2, PL3. The data_node_disk_type muse be cloud_essd.
    description str
    The description of instance. It a string of 0 to 30 characters.
    enable_kibana_private_network bool
    Bool, default to false. When it set to true, the instance can close kibana private network access。
    enable_kibana_public_network bool
    Bool, default to true. When it set to false, the instance can enable kibana public network access。
    enable_public bool
    Bool, default to false. When it set to true, the instance can enable public network access。
    instance_charge_type str
    Valid values are PrePaid, PostPaid. Default to PostPaid. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype from PostPaid to PrePaid, the following attributes are required: period. But, updating from PostPaid to PrePaid is not supported.
    kibana_node_spec str
    The kibana node specifications of the Elasticsearch instance. Default is elasticsearch.n4.small.
    kibana_private_security_group_id str
    the security group id associated with Kibana private network, this param is required when enable_kibana_private_network set true, and the security group id should in the same VPC as vswitch_id
    kibana_private_whitelists Sequence[str]
    Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use kibana_private_security_group_id instead
    kibana_whitelists Sequence[str]
    Set the Kibana's IP whitelist in internet network.
    kms_encrypted_password str
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored, but you have to specify one of password and kms_encrypted_password fields.
    kms_encryption_context Mapping[str, str]
    An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
    master_node_disk_type str
    The single master node storage space. Valid values are PrePaid, PostPaid.
    master_node_spec str
    The dedicated master node spec. If specified, dedicated master node will be created.
    password str
    The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (!@#$%^&*()_+-=).
    period int
    The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal a PrePaid instance.
    private_whitelists Sequence[str]
    Set the instance's IP whitelist in VPC network.
    protocol str
    Elasticsearch protocol. Supported values: HTTP, HTTPS.default is HTTP.
    public_whitelists Sequence[str]
    Set the instance's IP whitelist in internet network.
    renew_status str
    The renewal status of the specified instance. Valid values: AutoRenewal, ManualRenewal, NotRenewal.The instance_charge_type must be PrePaid.
    renewal_duration_unit str
    Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values: M, Y.
    resource_group_id str
    The ID of resource group which the Elasticsearch instance belongs.
    setting_config Mapping[str, str]
    The YML configuration of the instance.Detailed introduction.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    warm_node_amount int
    The Elasticsearch cluster's warm node quantity, between 3 and 50.
    warm_node_disk_encrypted bool
    If encrypt the warm node disk. Valid values are true, false. Default to false.
    warm_node_disk_size int
    The single warm node storage space, should between 500 and 20480
    warm_node_disk_type str
    The warm node disk type. Supported values: cloud_efficiency.
    warm_node_spec str
    The warm node specifications of the Elasticsearch instance.
    zone_count int
    The Multi-AZ supported for Elasticsearch, between 1 and 3. The data_node_amount value must be an integral multiple of the zone_count value.
    dataNodeAmount Number
    The Elasticsearch cluster's data node quantity, between 2 and 50.
    dataNodeDiskSize Number
    The single data node storage space.
    dataNodeDiskType String
    The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
    dataNodeSpec String
    The data node specifications of the Elasticsearch instance.
    version String
    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack , 7.7_with_X-Pack, 7.10_with_X-Pack, 7.16_with_X-Pack, 8.5_with_X-Pack, 8.9_with_X-Pack, 8.13_with_X-Pack.
    vswitchId String
    The ID of VSwitch.
    autoRenewDuration Number
    Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when instance_charge_type is PrePaid and renew_status is AutoRenewal.
    clientNodeAmount Number
    The Elasticsearch cluster's client node quantity, between 2 and 25.
    clientNodeSpec String
    The client node spec. If specified, client node will be created.
    dataNodeDiskEncrypted Boolean
    If encrypt the data node disk. Valid values are true, false. Default to false.
    dataNodeDiskPerformanceLevel String
    Cloud disk performance level. Valid values are PL0, PL1, PL2, PL3. The data_node_disk_type muse be cloud_essd.
    description String
    The description of instance. It a string of 0 to 30 characters.
    enableKibanaPrivateNetwork Boolean
    Bool, default to false. When it set to true, the instance can close kibana private network access。
    enableKibanaPublicNetwork Boolean
    Bool, default to true. When it set to false, the instance can enable kibana public network access。
    enablePublic Boolean
    Bool, default to false. When it set to true, the instance can enable public network access。
    instanceChargeType String
    Valid values are PrePaid, PostPaid. Default to PostPaid. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype from PostPaid to PrePaid, the following attributes are required: period. But, updating from PostPaid to PrePaid is not supported.
    kibanaNodeSpec String
    The kibana node specifications of the Elasticsearch instance. Default is elasticsearch.n4.small.
    kibanaPrivateSecurityGroupId String
    the security group id associated with Kibana private network, this param is required when enable_kibana_private_network set true, and the security group id should in the same VPC as vswitch_id
    kibanaPrivateWhitelists List<String>
    Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use kibana_private_security_group_id instead
    kibanaWhitelists List<String>
    Set the Kibana's IP whitelist in internet network.
    kmsEncryptedPassword String
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored, but you have to specify one of password and kms_encrypted_password fields.
    kmsEncryptionContext Map<String>
    An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
    masterNodeDiskType String
    The single master node storage space. Valid values are PrePaid, PostPaid.
    masterNodeSpec String
    The dedicated master node spec. If specified, dedicated master node will be created.
    password String
    The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (!@#$%^&*()_+-=).
    period Number
    The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal a PrePaid instance.
    privateWhitelists List<String>
    Set the instance's IP whitelist in VPC network.
    protocol String
    Elasticsearch protocol. Supported values: HTTP, HTTPS.default is HTTP.
    publicWhitelists List<String>
    Set the instance's IP whitelist in internet network.
    renewStatus String
    The renewal status of the specified instance. Valid values: AutoRenewal, ManualRenewal, NotRenewal.The instance_charge_type must be PrePaid.
    renewalDurationUnit String
    Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values: M, Y.
    resourceGroupId String
    The ID of resource group which the Elasticsearch instance belongs.
    settingConfig Map<String>
    The YML configuration of the instance.Detailed introduction.
    tags Map<String>
    A mapping of tags to assign to the resource.
    warmNodeAmount Number
    The Elasticsearch cluster's warm node quantity, between 3 and 50.
    warmNodeDiskEncrypted Boolean
    If encrypt the warm node disk. Valid values are true, false. Default to false.
    warmNodeDiskSize Number
    The single warm node storage space, should between 500 and 20480
    warmNodeDiskType String
    The warm node disk type. Supported values: cloud_efficiency.
    warmNodeSpec String
    The warm node specifications of the Elasticsearch instance.
    zoneCount Number
    The Multi-AZ supported for Elasticsearch, between 1 and 3. The data_node_amount value must be an integral multiple of the zone_count value.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

    Domain string
    Instance connection domain (only VPC network access supported).
    Id string
    The provider-assigned unique ID for this managed resource.
    KibanaDomain string
    Kibana console domain (Internet access supported).
    KibanaPort int
    Kibana console port.
    Port int
    Instance connection port.
    PublicDomain string
    Instance connection public domain.
    PublicPort int
    Instance connection public port.
    Status string
    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.
    Domain string
    Instance connection domain (only VPC network access supported).
    Id string
    The provider-assigned unique ID for this managed resource.
    KibanaDomain string
    Kibana console domain (Internet access supported).
    KibanaPort int
    Kibana console port.
    Port int
    Instance connection port.
    PublicDomain string
    Instance connection public domain.
    PublicPort int
    Instance connection public port.
    Status string
    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.
    domain String
    Instance connection domain (only VPC network access supported).
    id String
    The provider-assigned unique ID for this managed resource.
    kibanaDomain String
    Kibana console domain (Internet access supported).
    kibanaPort Integer
    Kibana console port.
    port Integer
    Instance connection port.
    publicDomain String
    Instance connection public domain.
    publicPort Integer
    Instance connection public port.
    status String
    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.
    domain string
    Instance connection domain (only VPC network access supported).
    id string
    The provider-assigned unique ID for this managed resource.
    kibanaDomain string
    Kibana console domain (Internet access supported).
    kibanaPort number
    Kibana console port.
    port number
    Instance connection port.
    publicDomain string
    Instance connection public domain.
    publicPort number
    Instance connection public port.
    status string
    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.
    domain str
    Instance connection domain (only VPC network access supported).
    id str
    The provider-assigned unique ID for this managed resource.
    kibana_domain str
    Kibana console domain (Internet access supported).
    kibana_port int
    Kibana console port.
    port int
    Instance connection port.
    public_domain str
    Instance connection public domain.
    public_port int
    Instance connection public port.
    status str
    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.
    domain String
    Instance connection domain (only VPC network access supported).
    id String
    The provider-assigned unique ID for this managed resource.
    kibanaDomain String
    Kibana console domain (Internet access supported).
    kibanaPort Number
    Kibana console port.
    port Number
    Instance connection port.
    publicDomain String
    Instance connection public domain.
    publicPort Number
    Instance connection public port.
    status String
    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.

    Look up Existing Instance Resource

    Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_renew_duration: Optional[int] = None,
        client_node_amount: Optional[int] = None,
        client_node_spec: Optional[str] = None,
        data_node_amount: Optional[int] = None,
        data_node_disk_encrypted: Optional[bool] = None,
        data_node_disk_performance_level: Optional[str] = None,
        data_node_disk_size: Optional[int] = None,
        data_node_disk_type: Optional[str] = None,
        data_node_spec: Optional[str] = None,
        description: Optional[str] = None,
        domain: Optional[str] = None,
        enable_kibana_private_network: Optional[bool] = None,
        enable_kibana_public_network: Optional[bool] = None,
        enable_public: Optional[bool] = None,
        instance_charge_type: Optional[str] = None,
        kibana_domain: Optional[str] = None,
        kibana_node_spec: Optional[str] = None,
        kibana_port: Optional[int] = None,
        kibana_private_security_group_id: Optional[str] = None,
        kibana_private_whitelists: Optional[Sequence[str]] = None,
        kibana_whitelists: Optional[Sequence[str]] = None,
        kms_encrypted_password: Optional[str] = None,
        kms_encryption_context: Optional[Mapping[str, str]] = None,
        master_node_disk_type: Optional[str] = None,
        master_node_spec: Optional[str] = None,
        password: Optional[str] = None,
        period: Optional[int] = None,
        port: Optional[int] = None,
        private_whitelists: Optional[Sequence[str]] = None,
        protocol: Optional[str] = None,
        public_domain: Optional[str] = None,
        public_port: Optional[int] = None,
        public_whitelists: Optional[Sequence[str]] = None,
        renew_status: Optional[str] = None,
        renewal_duration_unit: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        setting_config: Optional[Mapping[str, str]] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        version: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        warm_node_amount: Optional[int] = None,
        warm_node_disk_encrypted: Optional[bool] = None,
        warm_node_disk_size: Optional[int] = None,
        warm_node_disk_type: Optional[str] = None,
        warm_node_spec: Optional[str] = None,
        zone_count: Optional[int] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoRenewDuration int
    Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when instance_charge_type is PrePaid and renew_status is AutoRenewal.
    ClientNodeAmount int
    The Elasticsearch cluster's client node quantity, between 2 and 25.
    ClientNodeSpec string
    The client node spec. If specified, client node will be created.
    DataNodeAmount int
    The Elasticsearch cluster's data node quantity, between 2 and 50.
    DataNodeDiskEncrypted bool
    If encrypt the data node disk. Valid values are true, false. Default to false.
    DataNodeDiskPerformanceLevel string
    Cloud disk performance level. Valid values are PL0, PL1, PL2, PL3. The data_node_disk_type muse be cloud_essd.
    DataNodeDiskSize int
    The single data node storage space.
    DataNodeDiskType string
    The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
    DataNodeSpec string
    The data node specifications of the Elasticsearch instance.
    Description string
    The description of instance. It a string of 0 to 30 characters.
    Domain string
    Instance connection domain (only VPC network access supported).
    EnableKibanaPrivateNetwork bool
    Bool, default to false. When it set to true, the instance can close kibana private network access。
    EnableKibanaPublicNetwork bool
    Bool, default to true. When it set to false, the instance can enable kibana public network access。
    EnablePublic bool
    Bool, default to false. When it set to true, the instance can enable public network access。
    InstanceChargeType string
    Valid values are PrePaid, PostPaid. Default to PostPaid. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype from PostPaid to PrePaid, the following attributes are required: period. But, updating from PostPaid to PrePaid is not supported.
    KibanaDomain string
    Kibana console domain (Internet access supported).
    KibanaNodeSpec string
    The kibana node specifications of the Elasticsearch instance. Default is elasticsearch.n4.small.
    KibanaPort int
    Kibana console port.
    KibanaPrivateSecurityGroupId string
    the security group id associated with Kibana private network, this param is required when enable_kibana_private_network set true, and the security group id should in the same VPC as vswitch_id
    KibanaPrivateWhitelists List<string>
    Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use kibana_private_security_group_id instead
    KibanaWhitelists List<string>
    Set the Kibana's IP whitelist in internet network.
    KmsEncryptedPassword string
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored, but you have to specify one of password and kms_encrypted_password fields.
    KmsEncryptionContext Dictionary<string, string>
    An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
    MasterNodeDiskType string
    The single master node storage space. Valid values are PrePaid, PostPaid.
    MasterNodeSpec string
    The dedicated master node spec. If specified, dedicated master node will be created.
    Password string
    The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (!@#$%^&*()_+-=).
    Period int
    The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal a PrePaid instance.
    Port int
    Instance connection port.
    PrivateWhitelists List<string>
    Set the instance's IP whitelist in VPC network.
    Protocol string
    Elasticsearch protocol. Supported values: HTTP, HTTPS.default is HTTP.
    PublicDomain string
    Instance connection public domain.
    PublicPort int
    Instance connection public port.
    PublicWhitelists List<string>
    Set the instance's IP whitelist in internet network.
    RenewStatus string
    The renewal status of the specified instance. Valid values: AutoRenewal, ManualRenewal, NotRenewal.The instance_charge_type must be PrePaid.
    RenewalDurationUnit string
    Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values: M, Y.
    ResourceGroupId string
    The ID of resource group which the Elasticsearch instance belongs.
    SettingConfig Dictionary<string, string>
    The YML configuration of the instance.Detailed introduction.
    Status string
    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Version string
    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack , 7.7_with_X-Pack, 7.10_with_X-Pack, 7.16_with_X-Pack, 8.5_with_X-Pack, 8.9_with_X-Pack, 8.13_with_X-Pack.
    VswitchId string
    The ID of VSwitch.
    WarmNodeAmount int
    The Elasticsearch cluster's warm node quantity, between 3 and 50.
    WarmNodeDiskEncrypted bool
    If encrypt the warm node disk. Valid values are true, false. Default to false.
    WarmNodeDiskSize int
    The single warm node storage space, should between 500 and 20480
    WarmNodeDiskType string
    The warm node disk type. Supported values: cloud_efficiency.
    WarmNodeSpec string
    The warm node specifications of the Elasticsearch instance.
    ZoneCount int
    The Multi-AZ supported for Elasticsearch, between 1 and 3. The data_node_amount value must be an integral multiple of the zone_count value.
    AutoRenewDuration int
    Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when instance_charge_type is PrePaid and renew_status is AutoRenewal.
    ClientNodeAmount int
    The Elasticsearch cluster's client node quantity, between 2 and 25.
    ClientNodeSpec string
    The client node spec. If specified, client node will be created.
    DataNodeAmount int
    The Elasticsearch cluster's data node quantity, between 2 and 50.
    DataNodeDiskEncrypted bool
    If encrypt the data node disk. Valid values are true, false. Default to false.
    DataNodeDiskPerformanceLevel string
    Cloud disk performance level. Valid values are PL0, PL1, PL2, PL3. The data_node_disk_type muse be cloud_essd.
    DataNodeDiskSize int
    The single data node storage space.
    DataNodeDiskType string
    The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
    DataNodeSpec string
    The data node specifications of the Elasticsearch instance.
    Description string
    The description of instance. It a string of 0 to 30 characters.
    Domain string
    Instance connection domain (only VPC network access supported).
    EnableKibanaPrivateNetwork bool
    Bool, default to false. When it set to true, the instance can close kibana private network access。
    EnableKibanaPublicNetwork bool
    Bool, default to true. When it set to false, the instance can enable kibana public network access。
    EnablePublic bool
    Bool, default to false. When it set to true, the instance can enable public network access。
    InstanceChargeType string
    Valid values are PrePaid, PostPaid. Default to PostPaid. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype from PostPaid to PrePaid, the following attributes are required: period. But, updating from PostPaid to PrePaid is not supported.
    KibanaDomain string
    Kibana console domain (Internet access supported).
    KibanaNodeSpec string
    The kibana node specifications of the Elasticsearch instance. Default is elasticsearch.n4.small.
    KibanaPort int
    Kibana console port.
    KibanaPrivateSecurityGroupId string
    the security group id associated with Kibana private network, this param is required when enable_kibana_private_network set true, and the security group id should in the same VPC as vswitch_id
    KibanaPrivateWhitelists []string
    Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use kibana_private_security_group_id instead
    KibanaWhitelists []string
    Set the Kibana's IP whitelist in internet network.
    KmsEncryptedPassword string
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored, but you have to specify one of password and kms_encrypted_password fields.
    KmsEncryptionContext map[string]string
    An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
    MasterNodeDiskType string
    The single master node storage space. Valid values are PrePaid, PostPaid.
    MasterNodeSpec string
    The dedicated master node spec. If specified, dedicated master node will be created.
    Password string
    The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (!@#$%^&*()_+-=).
    Period int
    The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal a PrePaid instance.
    Port int
    Instance connection port.
    PrivateWhitelists []string
    Set the instance's IP whitelist in VPC network.
    Protocol string
    Elasticsearch protocol. Supported values: HTTP, HTTPS.default is HTTP.
    PublicDomain string
    Instance connection public domain.
    PublicPort int
    Instance connection public port.
    PublicWhitelists []string
    Set the instance's IP whitelist in internet network.
    RenewStatus string
    The renewal status of the specified instance. Valid values: AutoRenewal, ManualRenewal, NotRenewal.The instance_charge_type must be PrePaid.
    RenewalDurationUnit string
    Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values: M, Y.
    ResourceGroupId string
    The ID of resource group which the Elasticsearch instance belongs.
    SettingConfig map[string]string
    The YML configuration of the instance.Detailed introduction.
    Status string
    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    Version string
    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack , 7.7_with_X-Pack, 7.10_with_X-Pack, 7.16_with_X-Pack, 8.5_with_X-Pack, 8.9_with_X-Pack, 8.13_with_X-Pack.
    VswitchId string
    The ID of VSwitch.
    WarmNodeAmount int
    The Elasticsearch cluster's warm node quantity, between 3 and 50.
    WarmNodeDiskEncrypted bool
    If encrypt the warm node disk. Valid values are true, false. Default to false.
    WarmNodeDiskSize int
    The single warm node storage space, should between 500 and 20480
    WarmNodeDiskType string
    The warm node disk type. Supported values: cloud_efficiency.
    WarmNodeSpec string
    The warm node specifications of the Elasticsearch instance.
    ZoneCount int
    The Multi-AZ supported for Elasticsearch, between 1 and 3. The data_node_amount value must be an integral multiple of the zone_count value.
    autoRenewDuration Integer
    Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when instance_charge_type is PrePaid and renew_status is AutoRenewal.
    clientNodeAmount Integer
    The Elasticsearch cluster's client node quantity, between 2 and 25.
    clientNodeSpec String
    The client node spec. If specified, client node will be created.
    dataNodeAmount Integer
    The Elasticsearch cluster's data node quantity, between 2 and 50.
    dataNodeDiskEncrypted Boolean
    If encrypt the data node disk. Valid values are true, false. Default to false.
    dataNodeDiskPerformanceLevel String
    Cloud disk performance level. Valid values are PL0, PL1, PL2, PL3. The data_node_disk_type muse be cloud_essd.
    dataNodeDiskSize Integer
    The single data node storage space.
    dataNodeDiskType String
    The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
    dataNodeSpec String
    The data node specifications of the Elasticsearch instance.
    description String
    The description of instance. It a string of 0 to 30 characters.
    domain String
    Instance connection domain (only VPC network access supported).
    enableKibanaPrivateNetwork Boolean
    Bool, default to false. When it set to true, the instance can close kibana private network access。
    enableKibanaPublicNetwork Boolean
    Bool, default to true. When it set to false, the instance can enable kibana public network access。
    enablePublic Boolean
    Bool, default to false. When it set to true, the instance can enable public network access。
    instanceChargeType String
    Valid values are PrePaid, PostPaid. Default to PostPaid. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype from PostPaid to PrePaid, the following attributes are required: period. But, updating from PostPaid to PrePaid is not supported.
    kibanaDomain String
    Kibana console domain (Internet access supported).
    kibanaNodeSpec String
    The kibana node specifications of the Elasticsearch instance. Default is elasticsearch.n4.small.
    kibanaPort Integer
    Kibana console port.
    kibanaPrivateSecurityGroupId String
    the security group id associated with Kibana private network, this param is required when enable_kibana_private_network set true, and the security group id should in the same VPC as vswitch_id
    kibanaPrivateWhitelists List<String>
    Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use kibana_private_security_group_id instead
    kibanaWhitelists List<String>
    Set the Kibana's IP whitelist in internet network.
    kmsEncryptedPassword String
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored, but you have to specify one of password and kms_encrypted_password fields.
    kmsEncryptionContext Map<String,String>
    An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
    masterNodeDiskType String
    The single master node storage space. Valid values are PrePaid, PostPaid.
    masterNodeSpec String
    The dedicated master node spec. If specified, dedicated master node will be created.
    password String
    The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (!@#$%^&*()_+-=).
    period Integer
    The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal a PrePaid instance.
    port Integer
    Instance connection port.
    privateWhitelists List<String>
    Set the instance's IP whitelist in VPC network.
    protocol String
    Elasticsearch protocol. Supported values: HTTP, HTTPS.default is HTTP.
    publicDomain String
    Instance connection public domain.
    publicPort Integer
    Instance connection public port.
    publicWhitelists List<String>
    Set the instance's IP whitelist in internet network.
    renewStatus String
    The renewal status of the specified instance. Valid values: AutoRenewal, ManualRenewal, NotRenewal.The instance_charge_type must be PrePaid.
    renewalDurationUnit String
    Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values: M, Y.
    resourceGroupId String
    The ID of resource group which the Elasticsearch instance belongs.
    settingConfig Map<String,String>
    The YML configuration of the instance.Detailed introduction.
    status String
    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    version String
    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack , 7.7_with_X-Pack, 7.10_with_X-Pack, 7.16_with_X-Pack, 8.5_with_X-Pack, 8.9_with_X-Pack, 8.13_with_X-Pack.
    vswitchId String
    The ID of VSwitch.
    warmNodeAmount Integer
    The Elasticsearch cluster's warm node quantity, between 3 and 50.
    warmNodeDiskEncrypted Boolean
    If encrypt the warm node disk. Valid values are true, false. Default to false.
    warmNodeDiskSize Integer
    The single warm node storage space, should between 500 and 20480
    warmNodeDiskType String
    The warm node disk type. Supported values: cloud_efficiency.
    warmNodeSpec String
    The warm node specifications of the Elasticsearch instance.
    zoneCount Integer
    The Multi-AZ supported for Elasticsearch, between 1 and 3. The data_node_amount value must be an integral multiple of the zone_count value.
    autoRenewDuration number
    Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when instance_charge_type is PrePaid and renew_status is AutoRenewal.
    clientNodeAmount number
    The Elasticsearch cluster's client node quantity, between 2 and 25.
    clientNodeSpec string
    The client node spec. If specified, client node will be created.
    dataNodeAmount number
    The Elasticsearch cluster's data node quantity, between 2 and 50.
    dataNodeDiskEncrypted boolean
    If encrypt the data node disk. Valid values are true, false. Default to false.
    dataNodeDiskPerformanceLevel string
    Cloud disk performance level. Valid values are PL0, PL1, PL2, PL3. The data_node_disk_type muse be cloud_essd.
    dataNodeDiskSize number
    The single data node storage space.
    dataNodeDiskType string
    The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
    dataNodeSpec string
    The data node specifications of the Elasticsearch instance.
    description string
    The description of instance. It a string of 0 to 30 characters.
    domain string
    Instance connection domain (only VPC network access supported).
    enableKibanaPrivateNetwork boolean
    Bool, default to false. When it set to true, the instance can close kibana private network access。
    enableKibanaPublicNetwork boolean
    Bool, default to true. When it set to false, the instance can enable kibana public network access。
    enablePublic boolean
    Bool, default to false. When it set to true, the instance can enable public network access。
    instanceChargeType string
    Valid values are PrePaid, PostPaid. Default to PostPaid. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype from PostPaid to PrePaid, the following attributes are required: period. But, updating from PostPaid to PrePaid is not supported.
    kibanaDomain string
    Kibana console domain (Internet access supported).
    kibanaNodeSpec string
    The kibana node specifications of the Elasticsearch instance. Default is elasticsearch.n4.small.
    kibanaPort number
    Kibana console port.
    kibanaPrivateSecurityGroupId string
    the security group id associated with Kibana private network, this param is required when enable_kibana_private_network set true, and the security group id should in the same VPC as vswitch_id
    kibanaPrivateWhitelists string[]
    Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use kibana_private_security_group_id instead
    kibanaWhitelists string[]
    Set the Kibana's IP whitelist in internet network.
    kmsEncryptedPassword string
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored, but you have to specify one of password and kms_encrypted_password fields.
    kmsEncryptionContext {[key: string]: string}
    An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
    masterNodeDiskType string
    The single master node storage space. Valid values are PrePaid, PostPaid.
    masterNodeSpec string
    The dedicated master node spec. If specified, dedicated master node will be created.
    password string
    The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (!@#$%^&*()_+-=).
    period number
    The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal a PrePaid instance.
    port number
    Instance connection port.
    privateWhitelists string[]
    Set the instance's IP whitelist in VPC network.
    protocol string
    Elasticsearch protocol. Supported values: HTTP, HTTPS.default is HTTP.
    publicDomain string
    Instance connection public domain.
    publicPort number
    Instance connection public port.
    publicWhitelists string[]
    Set the instance's IP whitelist in internet network.
    renewStatus string
    The renewal status of the specified instance. Valid values: AutoRenewal, ManualRenewal, NotRenewal.The instance_charge_type must be PrePaid.
    renewalDurationUnit string
    Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values: M, Y.
    resourceGroupId string
    The ID of resource group which the Elasticsearch instance belongs.
    settingConfig {[key: string]: string}
    The YML configuration of the instance.Detailed introduction.
    status string
    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    version string
    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack , 7.7_with_X-Pack, 7.10_with_X-Pack, 7.16_with_X-Pack, 8.5_with_X-Pack, 8.9_with_X-Pack, 8.13_with_X-Pack.
    vswitchId string
    The ID of VSwitch.
    warmNodeAmount number
    The Elasticsearch cluster's warm node quantity, between 3 and 50.
    warmNodeDiskEncrypted boolean
    If encrypt the warm node disk. Valid values are true, false. Default to false.
    warmNodeDiskSize number
    The single warm node storage space, should between 500 and 20480
    warmNodeDiskType string
    The warm node disk type. Supported values: cloud_efficiency.
    warmNodeSpec string
    The warm node specifications of the Elasticsearch instance.
    zoneCount number
    The Multi-AZ supported for Elasticsearch, between 1 and 3. The data_node_amount value must be an integral multiple of the zone_count value.
    auto_renew_duration int
    Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when instance_charge_type is PrePaid and renew_status is AutoRenewal.
    client_node_amount int
    The Elasticsearch cluster's client node quantity, between 2 and 25.
    client_node_spec str
    The client node spec. If specified, client node will be created.
    data_node_amount int
    The Elasticsearch cluster's data node quantity, between 2 and 50.
    data_node_disk_encrypted bool
    If encrypt the data node disk. Valid values are true, false. Default to false.
    data_node_disk_performance_level str
    Cloud disk performance level. Valid values are PL0, PL1, PL2, PL3. The data_node_disk_type muse be cloud_essd.
    data_node_disk_size int
    The single data node storage space.
    data_node_disk_type str
    The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
    data_node_spec str
    The data node specifications of the Elasticsearch instance.
    description str
    The description of instance. It a string of 0 to 30 characters.
    domain str
    Instance connection domain (only VPC network access supported).
    enable_kibana_private_network bool
    Bool, default to false. When it set to true, the instance can close kibana private network access。
    enable_kibana_public_network bool
    Bool, default to true. When it set to false, the instance can enable kibana public network access。
    enable_public bool
    Bool, default to false. When it set to true, the instance can enable public network access。
    instance_charge_type str
    Valid values are PrePaid, PostPaid. Default to PostPaid. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype from PostPaid to PrePaid, the following attributes are required: period. But, updating from PostPaid to PrePaid is not supported.
    kibana_domain str
    Kibana console domain (Internet access supported).
    kibana_node_spec str
    The kibana node specifications of the Elasticsearch instance. Default is elasticsearch.n4.small.
    kibana_port int
    Kibana console port.
    kibana_private_security_group_id str
    the security group id associated with Kibana private network, this param is required when enable_kibana_private_network set true, and the security group id should in the same VPC as vswitch_id
    kibana_private_whitelists Sequence[str]
    Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use kibana_private_security_group_id instead
    kibana_whitelists Sequence[str]
    Set the Kibana's IP whitelist in internet network.
    kms_encrypted_password str
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored, but you have to specify one of password and kms_encrypted_password fields.
    kms_encryption_context Mapping[str, str]
    An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
    master_node_disk_type str
    The single master node storage space. Valid values are PrePaid, PostPaid.
    master_node_spec str
    The dedicated master node spec. If specified, dedicated master node will be created.
    password str
    The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (!@#$%^&*()_+-=).
    period int
    The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal a PrePaid instance.
    port int
    Instance connection port.
    private_whitelists Sequence[str]
    Set the instance's IP whitelist in VPC network.
    protocol str
    Elasticsearch protocol. Supported values: HTTP, HTTPS.default is HTTP.
    public_domain str
    Instance connection public domain.
    public_port int
    Instance connection public port.
    public_whitelists Sequence[str]
    Set the instance's IP whitelist in internet network.
    renew_status str
    The renewal status of the specified instance. Valid values: AutoRenewal, ManualRenewal, NotRenewal.The instance_charge_type must be PrePaid.
    renewal_duration_unit str
    Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values: M, Y.
    resource_group_id str
    The ID of resource group which the Elasticsearch instance belongs.
    setting_config Mapping[str, str]
    The YML configuration of the instance.Detailed introduction.
    status str
    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    version str
    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack , 7.7_with_X-Pack, 7.10_with_X-Pack, 7.16_with_X-Pack, 8.5_with_X-Pack, 8.9_with_X-Pack, 8.13_with_X-Pack.
    vswitch_id str
    The ID of VSwitch.
    warm_node_amount int
    The Elasticsearch cluster's warm node quantity, between 3 and 50.
    warm_node_disk_encrypted bool
    If encrypt the warm node disk. Valid values are true, false. Default to false.
    warm_node_disk_size int
    The single warm node storage space, should between 500 and 20480
    warm_node_disk_type str
    The warm node disk type. Supported values: cloud_efficiency.
    warm_node_spec str
    The warm node specifications of the Elasticsearch instance.
    zone_count int
    The Multi-AZ supported for Elasticsearch, between 1 and 3. The data_node_amount value must be an integral multiple of the zone_count value.
    autoRenewDuration Number
    Auto-renewal period of an Elasticsearch Instance, in the unit of the month. It is valid when instance_charge_type is PrePaid and renew_status is AutoRenewal.
    clientNodeAmount Number
    The Elasticsearch cluster's client node quantity, between 2 and 25.
    clientNodeSpec String
    The client node spec. If specified, client node will be created.
    dataNodeAmount Number
    The Elasticsearch cluster's data node quantity, between 2 and 50.
    dataNodeDiskEncrypted Boolean
    If encrypt the data node disk. Valid values are true, false. Default to false.
    dataNodeDiskPerformanceLevel String
    Cloud disk performance level. Valid values are PL0, PL1, PL2, PL3. The data_node_disk_type muse be cloud_essd.
    dataNodeDiskSize Number
    The single data node storage space.
    dataNodeDiskType String
    The data node disk type. Supported values: cloud_ssd, cloud_efficiency.
    dataNodeSpec String
    The data node specifications of the Elasticsearch instance.
    description String
    The description of instance. It a string of 0 to 30 characters.
    domain String
    Instance connection domain (only VPC network access supported).
    enableKibanaPrivateNetwork Boolean
    Bool, default to false. When it set to true, the instance can close kibana private network access。
    enableKibanaPublicNetwork Boolean
    Bool, default to true. When it set to false, the instance can enable kibana public network access。
    enablePublic Boolean
    Bool, default to false. When it set to true, the instance can enable public network access。
    instanceChargeType String
    Valid values are PrePaid, PostPaid. Default to PostPaid. From version 1.69.0, the Elasticsearch cluster allows you to update your instance_charge_ype from PostPaid to PrePaid, the following attributes are required: period. But, updating from PostPaid to PrePaid is not supported.
    kibanaDomain String
    Kibana console domain (Internet access supported).
    kibanaNodeSpec String
    The kibana node specifications of the Elasticsearch instance. Default is elasticsearch.n4.small.
    kibanaPort Number
    Kibana console port.
    kibanaPrivateSecurityGroupId String
    the security group id associated with Kibana private network, this param is required when enable_kibana_private_network set true, and the security group id should in the same VPC as vswitch_id
    kibanaPrivateWhitelists List<String>
    Set the Kibana's IP whitelist in private network, This option has been abandoned on newly created instance, please use kibana_private_security_group_id instead
    kibanaWhitelists List<String>
    Set the Kibana's IP whitelist in internet network.
    kmsEncryptedPassword String
    An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored, but you have to specify one of password and kms_encrypted_password fields.
    kmsEncryptionContext Map<String>
    An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
    masterNodeDiskType String
    The single master node storage space. Valid values are PrePaid, PostPaid.
    masterNodeSpec String
    The dedicated master node spec. If specified, dedicated master node will be created.
    password String
    The password of the instance. The password can be 8 to 30 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (!@#$%^&*()_+-=).
    period Number
    The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal a PrePaid instance.
    port Number
    Instance connection port.
    privateWhitelists List<String>
    Set the instance's IP whitelist in VPC network.
    protocol String
    Elasticsearch protocol. Supported values: HTTP, HTTPS.default is HTTP.
    publicDomain String
    Instance connection public domain.
    publicPort Number
    Instance connection public port.
    publicWhitelists List<String>
    Set the instance's IP whitelist in internet network.
    renewStatus String
    The renewal status of the specified instance. Valid values: AutoRenewal, ManualRenewal, NotRenewal.The instance_charge_type must be PrePaid.
    renewalDurationUnit String
    Auto-Renewal Cycle Unit Values Include: Month: Month. Year: Years. Valid values: M, Y.
    resourceGroupId String
    The ID of resource group which the Elasticsearch instance belongs.
    settingConfig Map<String>
    The YML configuration of the instance.Detailed introduction.
    status String
    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.
    tags Map<String>
    A mapping of tags to assign to the resource.
    version String
    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack , 7.7_with_X-Pack, 7.10_with_X-Pack, 7.16_with_X-Pack, 8.5_with_X-Pack, 8.9_with_X-Pack, 8.13_with_X-Pack.
    vswitchId String
    The ID of VSwitch.
    warmNodeAmount Number
    The Elasticsearch cluster's warm node quantity, between 3 and 50.
    warmNodeDiskEncrypted Boolean
    If encrypt the warm node disk. Valid values are true, false. Default to false.
    warmNodeDiskSize Number
    The single warm node storage space, should between 500 and 20480
    warmNodeDiskType String
    The warm node disk type. Supported values: cloud_efficiency.
    warmNodeSpec String
    The warm node specifications of the Elasticsearch instance.
    zoneCount Number
    The Multi-AZ supported for Elasticsearch, between 1 and 3. The data_node_amount value must be an integral multiple of the zone_count value.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-alicloud