Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::ElasticSearch::InstanceThe , which resource is used to create an Elasticsearch instance.

Initializers

import ros_cdk_elasticsearch
ros_cdk_elasticsearch.Instance(
  scope: Construct,
  id: str,
  data_node: typing.Union[DataNodeProperty, IResolvable],
  password: typing.Union[str, IResolvable],
  version: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  delete_type: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  enable_kibana_private: typing.Union[bool, IResolvable] = None,
  enable_kibana_public: typing.Union[bool, IResolvable] = None,
  enable_public: typing.Union[bool, IResolvable] = None,
  instance_category: typing.Union[str, IResolvable] = None,
  instance_charge_type: typing.Union[str, IResolvable] = None,
  kibana_node: typing.Union[IResolvable, KibanaNodeProperty] = None,
  kibana_whitelist: typing.Union[typing.List[typing.Any], IResolvable] = None,
  master_node: typing.Union[IResolvable, MasterNodeProperty] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  private_whitelist: typing.Union[typing.List[typing.Any], IResolvable] = None,
  public_whitelist: typing.Union[typing.List[typing.Any], IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  yml_config: typing.Union[IResolvable, YMLConfigProperty] = None,
  zone_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

data_node^Required

• Type: typing.Union[DataNodeProperty, ros_cdk_core.IResolvable]

Property dataNode: The Elasticsearch cluster's data node setting.

password^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property password: The password of the instance.

The password can be 8 to 32 characters in length and must contain three of the following conditions: uppercase letters, lowercase letters, numbers, and special characters (!@#$%&*()_+-=).

version^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property version: Elasticsearch version.

Supported values: 5.5.3_with_X-Pack, 6.3_with_X-Pack, 6.7_with_X-Pack, 7.4_with_X-Pack, 6.8, 7.4, 7.7 and so on.

v_switch_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vSwitchId: The ID of VSwitch.

delete_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property deleteType: The release type.

Valid values:

• immediate: The cluster is immediately deleted when it is released. After the cluster is deleted, the data stored in the cluster is deleted, and the system removes the cluster from the Logstash cluster list.
• protective (default): The instance is frozen for 24 hours before data is completely cleared. During this period, the instance is still displayed in the instance list. You can select Restore Instance or Release Now.

description^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of instance.

It a string of 0 to 128 characters. It can contain numbers, letters, underscores, (_) and hyphens (-). It must start with a letter, a number or Chinese character.

enable_kibana_private^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enableKibanaPrivate: Enables or disables intranet access to Kibana.

enable_kibana_public^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enableKibanaPublic: Enables or disables Internet access to Kibana.

enable_public^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enablePublic: Whether enable public access.

If properties is true, will allocate public address.Default: false.

instance_category^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceCategory: Version Type: - x-pack: Create a commercial instance or a kernel-enhanced instance without Indexing Service and OpenStore enabled.

• IS: Creates a kernel-enhanced instance with Indexing Service or OpenStore enabled

instance_charge_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceChargeType: Valid values are PrePaid, PostPaid, Default to PostPaid.

kibana_node^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, KibanaNodeProperty]

Property kibanaNode: The dedicated kibana node setting.

kibana_whitelist^Optional

• Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]

Property kibanaWhitelist: Set the Kibana's IP whitelist in internet network.

master_node^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, MasterNodeProperty]

Property masterNode: The dedicated master node setting.

If specified, dedicated master node will be created.

period^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property period: The duration that you will buy Elasticsearch instance.

It is valid when instance_charge_type is PrePaid. Unit is Month, it could be from 1 to 9 or 12, 24, 36, 48, 60. Unit is Year, it could be from 1 to 3. Default value is 1.

period_unit^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property periodUnit: Unit of prepaid time period, it could be Month\/Year.

Default value is Month.

private_whitelist^Optional

• Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]

Property privateWhitelist: Set the instance's IP whitelist in VPC network.

public_whitelist^Optional

• Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]

Property publicWhitelist: Set the instance's IP whitelist in Internet.

The AllocatePublicAddress should be true.

resource_group_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

yml_config^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, YMLConfigProperty]

Property ymlConfig: In the YML Configuration section of the Cluster Configuration page of your Alibaba Cloud Elasticsearch cluster, you can enable the Auto Indexing, Audit Log Indexing, or Watcher feature.

zone_count^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property zoneCount: undefined.

zone_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property zoneId: The zone id of elasticsearch.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_elasticsearch
ros_cdk_elasticsearch.Instance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_arn^Required

attr_arn: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attr_domain^Required

attr_domain: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Domain: Instance connection domain (only VPC network access supported).

attr_instance_charge_type^Required

attr_instance_charge_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute InstanceChargeType: Instance charge type.

attr_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute InstanceId: The ID of the Elasticsearch instance.

attr_kibana_domain^Required

attr_kibana_domain: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute KibanaDomain: Kibana console domain (Internet access supported).

attr_kibana_port^Required

attr_kibana_port: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute KibanaPort: Kibana console port.

attr_port^Required

attr_port: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Port: Instance connection port.

attr_public_domain^Required

attr_public_domain: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute PublicDomain: Instance public connection domain.

attr_status^Required

attr_status: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Status: The Elasticsearch instance status.

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

attr_version^Required

attr_version: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Version: Elasticsearch version.

attr_v_switch_id^Required

attr_v_switch_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute VSwitchId: The ID of VSwitch.

props^Required

props: InstanceProps

• Type: InstanceProps