Class Instance

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.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
public MyStack()
{
    var instance = new AliCloud.ElasticSearch.Instance("instance", new AliCloud.ElasticSearch.InstanceArgs
    {
        InstanceChargeType = "PostPaid",
        DataNodeAmount = "2",
        DataNodeSpec = "elasticsearch.sn2ne.large",
        DataNodeDiskSize = "20",
        DataNodeDiskType = "cloud_ssd",
        VswitchId = "some vswitch id",
        Password = "Your password",
        Version = "5.5.3_with_X-Pack",
        Description = "description",
        ZoneCount = "2",
        Tags = 
        {
            { "key1", "value1" },
            { "key2", "value2" },
        },
    });
}

}
Inheritance
System.Object
Resource
CustomResource
Instance
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.AliCloud.ElasticSearch
Assembly: Pulumi.AliCloud.dll
Syntax
public class Instance : CustomResource

Constructors

View Source

Instance(String, InstanceArgs, CustomResourceOptions)

Create a Instance resource with the given unique name, arguments, and options.

Declaration
public Instance(string name, InstanceArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
InstanceArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

DataNodeAmount

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

Declaration
public Output<int> DataNodeAmount { get; }
Property Value
Type Description
Output<System.Int32>
View Source

DataNodeDiskSize

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].
Declaration
public Output<int> DataNodeDiskSize { get; }
Property Value
Type Description
Output<System.Int32>
View Source

DataNodeDiskType

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

Declaration
public Output<string> DataNodeDiskType { get; }
Property Value
Type Description
Output<System.String>
View Source

DataNodeSpec

The data node specifications of the Elasticsearch instance.

Declaration
public Output<string> DataNodeSpec { get; }
Property Value
Type Description
Output<System.String>
View Source

Description

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

Declaration
public Output<string> Description { get; }
Property Value
Type Description
Output<System.String>
View Source

Domain

Instance connection domain (only VPC network access supported).

Declaration
public Output<string> Domain { get; }
Property Value
Type Description
Output<System.String>
View Source

InstanceChargeType

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.

Declaration
public Output<string> InstanceChargeType { get; }
Property Value
Type Description
Output<System.String>
View Source

KibanaDomain

Kibana console domain (Internet access supported).

Declaration
public Output<string> KibanaDomain { get; }
Property Value
Type Description
Output<System.String>
View Source

KibanaPort

Kibana console port.

Declaration
public Output<int> KibanaPort { get; }
Property Value
Type Description
Output<System.Int32>
View Source

KibanaWhitelists

Set the Kibana's IP whitelist in internet network.

Declaration
public Output<ImmutableArray<string>> KibanaWhitelists { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

KmsEncryptedPassword

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.

Declaration
public Output<string> KmsEncryptedPassword { get; }
Property Value
Type Description
Output<System.String>
View Source

KmsEncryptionContext

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.

Declaration
public Output<ImmutableDictionary<string, object>> KmsEncryptionContext { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

MasterNodeSpec

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

Declaration
public Output<string> MasterNodeSpec { get; }
Property Value
Type Description
Output<System.String>
View Source

Password

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 (!@#$%^&amp;*()_+-=).

Declaration
public Output<string> Password { get; }
Property Value
Type Description
Output<System.String>
View Source

Period

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.

Declaration
public Output<int?> Period { get; }
Property Value
Type Description
Output<System.Nullable<System.Int32>>
View Source

Port

Instance connection port.

Declaration
public Output<int> Port { get; }
Property Value
Type Description
Output<System.Int32>
View Source

PrivateWhitelists

Set the instance's IP whitelist in VPC network.

Declaration
public Output<ImmutableArray<string>> PrivateWhitelists { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

PublicWhitelists

Declaration
public Output<ImmutableArray<string>> PublicWhitelists { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

Status

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

Declaration
public Output<string> Status { get; }
Property Value
Type Description
Output<System.String>
View Source

Tags

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.
Declaration
public Output<ImmutableDictionary<string, object>> Tags { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

Version

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

Declaration
public Output<string> Version { get; }
Property Value
Type Description
Output<System.String>
View Source

VswitchId

The ID of VSwitch.

Declaration
public Output<string> VswitchId { get; }
Property Value
Type Description
Output<System.String>
View Source

ZoneCount

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.

Declaration
public Output<int?> ZoneCount { get; }
Property Value
Type Description
Output<System.Nullable<System.Int32>>

Methods

View Source

Get(String, Input<String>, InstanceState, CustomResourceOptions)

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

Declaration
public static Instance Get(string name, Input<string> id, InstanceState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Input<System.String> id

The unique provider ID of the resource to lookup.
InstanceState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
Instance