elasticsearch¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.elasticsearch.AwaitableGetInstancesResult(description_regex=None, descriptions=None, id=None, ids=None, instances=None, output_file=None, tags=None, version=None)¶

class pulumi_alicloud.elasticsearch.AwaitableGetZonesResult(id=None, ids=None, multi=None, output_file=None, zones=None)¶

class pulumi_alicloud.elasticsearch.GetInstancesResult(description_regex=None, descriptions=None, id=None, ids=None, instances=None, output_file=None, tags=None, version=None)¶

A collection of values returned by getInstances.

id = None¶

The provider-assigned unique ID for this managed resource.

class pulumi_alicloud.elasticsearch.GetZonesResult(id=None, ids=None, multi=None, output_file=None, zones=None)¶

A collection of values returned by getZones.

id = None¶

The provider-assigned unique ID for this managed resource.

ids = None¶

A list of zone IDs.

zones = None¶

A list of availability zones. Each element contains the following attributes:

class pulumi_alicloud.elasticsearch.Instance(resource_name, opts=None, data_node_amount=None, data_node_disk_encrypted=None, data_node_disk_size=None, data_node_disk_type=None, data_node_spec=None, description=None, enable_kibana_private_network=None, enable_kibana_public_network=None, enable_public=None, instance_charge_type=None, kibana_private_whitelists=None, kibana_whitelists=None, kms_encrypted_password=None, kms_encryption_context=None, master_node_spec=None, password=None, period=None, private_whitelists=None, public_whitelists=None, resource_group_id=None, tags=None, version=None, vswitch_id=None, zone_count=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Elasticsearch instance resource. It contains data nodes, dedicated master node(optional) and etc. It can be associated with private IP whitelists and kibana IP whitelist.

NOTE: Only one operation is supported in a request. So if data_node_spec and data_node_disk_size are both changed, system will respond error.

NOTE: At present, version can not be modified once instance has been created.

import pulumi
import pulumi_alicloud as alicloud

instance = alicloud.elasticsearch.Instance("instance",
    instance_charge_type="PostPaid",
    data_node_amount="2",
    data_node_spec="elasticsearch.sn2ne.large",
    data_node_disk_size="20",
    data_node_disk_type="cloud_ssd",
    vswitch_id="some vswitch id",
    password="Your password",
    version="5.5.3_with_X-Pack",
    description="description",
    zone_count="2",
    tags={
        "key1": "value1",
        "key2": "value2",
    })

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• data_node_amount (pulumi.Input[float]) – The Elasticsearch cluster’s data node quantity, between 2 and 50.

• data_node_disk_encrypted (pulumi.Input[bool]) – If encrypt the data node disk. Valid values are true, false. Default to false.

• data_node_disk_size (pulumi.Input[float]) – The single data node storage space.

- `cloud_ssd`: An SSD disk, supports a maximum of 2048 GiB (2 TB).
- `cloud_efficiency` An ultra disk, supports a maximum of 5120 GiB (5 TB). If the data to be stored is larger than 2048 GiB, an ultra disk can only support the following data sizes (GiB): [`2560`, `3072`, `3584`, `4096`, `4608`, `5120`].

Parameters

• data_node_disk_type (pulumi.Input[str]) – The data node disk type. Supported values: cloud_ssd, cloud_efficiency.

• data_node_spec (pulumi.Input[str]) – The data node specifications of the Elasticsearch instance.

• description (pulumi.Input[str]) – The description of instance. It a string of 0 to 30 characters.

• enable_kibana_private_network (pulumi.Input[bool]) – Bool, default to false. When it set to true, the instance can close kibana private network access。

• enable_kibana_public_network (pulumi.Input[bool]) – Bool, default to true. When it set to false, the instance can enable kibana public network access。

• enable_public (pulumi.Input[bool]) – Bool, default to false. When it set to true, the instance can enable public network access。

• instance_charge_type (pulumi.Input[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_private_whitelists (pulumi.Input[list]) – Set the Kibana’s IP whitelist in private network.

• kibana_whitelists (pulumi.Input[list]) – Set the Kibana’s IP whitelist in internet network.

• kms_encrypted_password (pulumi.Input[str]) – An KMS encrypts password used to a 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 (pulumi.Input[dict]) – 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*spec (pulumi.Input[str]) –

  The dedicated master node spec. If specified, dedicated master node will be created.

• password (pulumi.Input[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 (pulumi.Input[float]) – The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is``PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaid` instance.

• private_whitelists (pulumi.Input[list]) – Set the instance’s IP whitelist in VPC network.

• public_whitelists (pulumi.Input[list]) – Set the instance’s IP whitelist in internet network.

• resource_group_id (pulumi.Input[str]) – The Id of resource group which the Elasticsearch instance belongs.

• tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

- key: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:". It cannot contain "http://" and "https://". It cannot be a null string.
- value: It can be up to 128 characters in length. It cannot contain "http://" and "https://". It can be a null string.

Parameters

• version (pulumi.Input[str]) – Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack and 6.7_with_X-Pack.

• vswitch_id (pulumi.Input[str]) – The ID of VSwitch.

• zone_count (pulumi.Input[float]) – 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: pulumi.Output[float] = None¶

The Elasticsearch cluster’s data node quantity, between 2 and 50.

data_node_disk_encrypted: pulumi.Output[bool] = None¶

If encrypt the data node disk. Valid values are true, false. Default to false.

data_node_disk_size: pulumi.Output[float] = None¶

The single data node storage space.

• cloud_ssd: An SSD disk, supports a maximum of 2048 GiB (2 TB).

• cloud_efficiency An ultra disk, supports a maximum of 5120 GiB (5 TB). If the data to be stored is larger than 2048 GiB, an ultra disk can only support the following data sizes (GiB): [2560, 3072, 3584, 4096, 4608, 5120].

data_node_disk_type: pulumi.Output[str] = None¶

The data node disk type. Supported values: cloud_ssd, cloud_efficiency.

data_node_spec: pulumi.Output[str] = None¶

The data node specifications of the Elasticsearch instance.

description: pulumi.Output[str] = None¶

The description of instance. It a string of 0 to 30 characters.

domain: pulumi.Output[str] = None¶

Instance connection domain (only VPC network access supported).

enable_kibana_private_network: pulumi.Output[bool] = None¶

Bool, default to false. When it set to true, the instance can close kibana private network access。

enable_kibana_public_network: pulumi.Output[bool] = None¶

Bool, default to true. When it set to false, the instance can enable kibana public network access。

enable_public: pulumi.Output[bool] = None¶

Bool, default to false. When it set to true, the instance can enable public network access。

instance_charge_type: pulumi.Output[str] = None¶

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: pulumi.Output[str] = None¶

Kibana console domain (Internet access supported).

kibana_port: pulumi.Output[float] = None¶

Kibana console port.

kibana_private_whitelists: pulumi.Output[list] = None¶

Set the Kibana’s IP whitelist in private network.

kibana_whitelists: pulumi.Output[list] = None¶

Set the Kibana’s IP whitelist in internet network.

kms_encrypted_password: pulumi.Output[str] = None¶

An KMS encrypts password used to a 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: pulumi.Output[dict] = None¶

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_spec: pulumi.Output[str] = None¶

The dedicated master node spec. If specified, dedicated master node will be created.

password: pulumi.Output[str] = None¶

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: pulumi.Output[float] = None¶

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: pulumi.Output[float] = None¶

Instance connection port.

private_whitelists: pulumi.Output[list] = None¶

Set the instance’s IP whitelist in VPC network.

public_whitelists: pulumi.Output[list] = None¶

Set the instance’s IP whitelist in internet network.

resource_group_id: pulumi.Output[str] = None¶

The Id of resource group which the Elasticsearch instance belongs.

status: pulumi.Output[str] = None¶

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

tags: pulumi.Output[dict] = None¶

A mapping of tags to assign to the resource.

• key: It can be up to 128 characters in length. It cannot begin with “aliyun”, “acs:”. It cannot contain “http://” and “https://”. It cannot be a null string.

• value: It can be up to 128 characters in length. It cannot contain “http://” and “https://”. It can be a null string.

version: pulumi.Output[str] = None¶

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

vswitch_id: pulumi.Output[str] = None¶

The ID of VSwitch.

zone_count: pulumi.Output[float] = None¶

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.

static get(resource_name, id, opts=None, data_node_amount=None, data_node_disk_encrypted=None, data_node_disk_size=None, data_node_disk_type=None, data_node_spec=None, description=None, domain=None, enable_kibana_private_network=None, enable_kibana_public_network=None, enable_public=None, instance_charge_type=None, kibana_domain=None, kibana_port=None, kibana_private_whitelists=None, kibana_whitelists=None, kms_encrypted_password=None, kms_encryption_context=None, master_node_spec=None, password=None, period=None, port=None, private_whitelists=None, public_whitelists=None, resource_group_id=None, status=None, tags=None, version=None, vswitch_id=None, zone_count=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• data_node_amount (pulumi.Input[float]) – The Elasticsearch cluster’s data node quantity, between 2 and 50.

• data_node_disk_encrypted (pulumi.Input[bool]) – If encrypt the data node disk. Valid values are true, false. Default to false.

• data_node_disk_size (pulumi.Input[float]) – The single data node storage space.

- `cloud_ssd`: An SSD disk, supports a maximum of 2048 GiB (2 TB).
- `cloud_efficiency` An ultra disk, supports a maximum of 5120 GiB (5 TB). If the data to be stored is larger than 2048 GiB, an ultra disk can only support the following data sizes (GiB): [`2560`, `3072`, `3584`, `4096`, `4608`, `5120`].

Parameters

• data_node_disk_type (pulumi.Input[str]) – The data node disk type. Supported values: cloud_ssd, cloud_efficiency.

• data_node_spec (pulumi.Input[str]) – The data node specifications of the Elasticsearch instance.

• description (pulumi.Input[str]) – The description of instance. It a string of 0 to 30 characters.

• domain (pulumi.Input[str]) – Instance connection domain (only VPC network access supported).

• enable_kibana_private_network (pulumi.Input[bool]) – Bool, default to false. When it set to true, the instance can close kibana private network access。

• enable_kibana_public_network (pulumi.Input[bool]) – Bool, default to true. When it set to false, the instance can enable kibana public network access。

• enable_public (pulumi.Input[bool]) – Bool, default to false. When it set to true, the instance can enable public network access。

• instance_charge_type (pulumi.Input[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 (pulumi.Input[str]) – Kibana console domain (Internet access supported).

• kibana_port (pulumi.Input[float]) – Kibana console port.

• kibana_private_whitelists (pulumi.Input[list]) – Set the Kibana’s IP whitelist in private network.

• kibana_whitelists (pulumi.Input[list]) – Set the Kibana’s IP whitelist in internet network.

• kms_encrypted_password (pulumi.Input[str]) – An KMS encrypts password used to a 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 (pulumi.Input[dict]) –

  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*spec (pulumi.Input[str]) –

  The dedicated master node spec. If specified, dedicated master node will be created.

• password (pulumi.Input[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 (pulumi.Input[float]) – The duration that you will buy Elasticsearch instance (in month). It is valid when instance_charge_type is``PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1. From version 1.69.2, when to modify this value, the resource can renewal aPrePaid``instance.

• port (pulumi.Input[float]) – Instance connection port.

• private_whitelists (pulumi.Input[list]) – Set the instance’s IP whitelist in VPC network.

• public_whitelists (pulumi.Input[list]) – Set the instance’s IP whitelist in internet network.

• resource_group_id (pulumi.Input[str]) – The Id of resource group which the Elasticsearch instance belongs.

• status (pulumi.Input[str]) – The Elasticsearch instance status. Includes``active,activating,inactive. Some operations are denied when status is notactive`.

• tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

- key: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:". It cannot contain "http://" and "https://". It cannot be a null string.
- value: It can be up to 128 characters in length. It cannot contain "http://" and "https://". It can be a null string.

Parameters

• version (pulumi.Input[str]) – Elasticsearch version. Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack and 6.7_with_X-Pack.

• vswitch_id (pulumi.Input[str]) – The ID of VSwitch.

• zone_count (pulumi.Input[float]) – 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.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_alicloud.elasticsearch.get_instances(description_regex=None, ids=None, output_file=None, tags=None, version=None, opts=None)¶

Use this data source to access information about an existing resource.

pulumi_alicloud.elasticsearch.get_zones(multi=None, output_file=None, opts=None)¶

This data source provides availability zones for Elasticsearch that can be accessed by an Alibaba Cloud account within the region configured in the provider.

NOTE: Available in v1.73.0+.

import pulumi
import pulumi_alicloud as alicloud

zones_ids = alicloud.elasticsearch.get_zones()

Parameters

multi (bool) – Indicate whether the zones can be used in a multi AZ configuration. Default to false. Multi AZ is usually used to launch Elasticsearch instances.