Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. elasticsearch
  5. Instance
Alibaba Cloud v3.43.1 published on Monday, Sep 11, 2023 by Pulumi
pulumi/pulumi-alicloud

alicloud.elasticsearch.Instance

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.43.1 published on Monday, Sep 11, 2023 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

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

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

    Instance Resource Properties

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

    Inputs

    The Instance resource accepts the following input properties:

    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 and 7.7_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.

    KibanaPrivateWhitelists List<string>

    Set the Kibana's IP whitelist in private network.

    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, object>

    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, object>

    The YML configuration of the instance.Detailed introduction.

    Tags Dictionary<string, object>

    A mapping of tags to assign to the resource.

    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 and 7.7_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.

    KibanaPrivateWhitelists []string

    Set the Kibana's IP whitelist in private network.

    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]interface{}

    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]interface{}

    The YML configuration of the instance.Detailed introduction.

    Tags map[string]interface{}

    A mapping of tags to assign to the resource.

    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 and 7.7_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.

    kibanaPrivateWhitelists List<String>

    Set the Kibana's IP whitelist in private network.

    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,Object>

    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,Object>

    The YML configuration of the instance.Detailed introduction.

    tags Map<String,Object>

    A mapping of tags to assign to the resource.

    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 and 7.7_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.

    kibanaPrivateWhitelists string[]

    Set the Kibana's IP whitelist in private network.

    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]: any}

    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]: any}

    The YML configuration of the instance.Detailed introduction.

    tags {[key: string]: any}

    A mapping of tags to assign to the resource.

    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 and 7.7_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_whitelists Sequence[str]

    Set the Kibana's IP whitelist in private network.

    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, Any]

    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, Any]

    The YML configuration of the instance.Detailed introduction.

    tags Mapping[str, Any]

    A mapping of tags to assign to the resource.

    zone_count int

    The Multi-AZ supported for Elasticsearch, between 1 and 3. The data_node_amount value must be an integral multiple of 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 and 7.7_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.

    kibanaPrivateWhitelists List<String>

    Set the Kibana's IP whitelist in private network.

    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<Any>

    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<Any>

    The YML configuration of the instance.Detailed introduction.

    tags Map<Any>

    A mapping of tags to assign to the resource.

    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_whitelists: Optional[Sequence[str]] = None,
        kibana_whitelists: Optional[Sequence[str]] = None,
        kms_encrypted_password: Optional[str] = None,
        kms_encryption_context: Optional[Mapping[str, Any]] = None,
        master_node_disk_type: Optional[str] = None,
        master_node_spec: Optional[str] = None,
        password: Optional[str] = None,
        period: Optional[int] = None,
        port: Optional[int] = None,
        private_whitelists: Optional[Sequence[str]] = None,
        protocol: Optional[str] = None,
        public_domain: Optional[str] = None,
        public_port: Optional[int] = None,
        public_whitelists: Optional[Sequence[str]] = None,
        renew_status: Optional[str] = None,
        renewal_duration_unit: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        setting_config: Optional[Mapping[str, Any]] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, Any]] = None,
        version: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        zone_count: Optional[int] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    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.

    KibanaPrivateWhitelists List<string>

    Set the Kibana's IP whitelist in private network.

    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, object>

    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, object>

    The YML configuration of the instance.Detailed introduction.

    Status string

    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.

    Tags Dictionary<string, object>

    A mapping of tags to assign to the resource.

    Version string

    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack and 7.7_with_X-Pack.

    VswitchId string

    The ID of VSwitch.

    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.

    KibanaPrivateWhitelists []string

    Set the Kibana's IP whitelist in private network.

    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]interface{}

    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]interface{}

    The YML configuration of the instance.Detailed introduction.

    Status string

    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.

    Tags map[string]interface{}

    A mapping of tags to assign to the resource.

    Version string

    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack and 7.7_with_X-Pack.

    VswitchId string

    The ID of VSwitch.

    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.

    kibanaPrivateWhitelists List<String>

    Set the Kibana's IP whitelist in private network.

    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,Object>

    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,Object>

    The YML configuration of the instance.Detailed introduction.

    status String

    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.

    tags Map<String,Object>

    A mapping of tags to assign to the resource.

    version String

    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack and 7.7_with_X-Pack.

    vswitchId String

    The ID of VSwitch.

    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.

    kibanaPrivateWhitelists string[]

    Set the Kibana's IP whitelist in private network.

    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]: any}

    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]: any}

    The YML configuration of the instance.Detailed introduction.

    status string

    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.

    tags {[key: string]: any}

    A mapping of tags to assign to the resource.

    version string

    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack and 7.7_with_X-Pack.

    vswitchId string

    The ID of VSwitch.

    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_whitelists Sequence[str]

    Set the Kibana's IP whitelist in private network.

    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, Any]

    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, Any]

    The YML configuration of the instance.Detailed introduction.

    status str

    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.

    tags Mapping[str, Any]

    A mapping of tags to assign to the resource.

    version str

    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack and 7.7_with_X-Pack.

    vswitch_id str

    The ID of VSwitch.

    zone_count int

    The Multi-AZ supported for Elasticsearch, between 1 and 3. The data_node_amount value must be an integral multiple of 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.

    kibanaPrivateWhitelists List<String>

    Set the Kibana's IP whitelist in private network.

    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<Any>

    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<Any>

    The YML configuration of the instance.Detailed introduction.

    status String

    The Elasticsearch instance status. Includes active, activating, inactive. Some operations are denied when status is not active.

    tags Map<Any>

    A mapping of tags to assign to the resource.

    version String

    Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 6.8_with_X-Pack, 7.4_with_X-Pack and 7.7_with_X-Pack.

    vswitchId String

    The ID of VSwitch.

    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.43.1 published on Monday, Sep 11, 2023 by Pulumi
    pulumi/pulumi-alicloud