Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::ElasticSearch::Instance.

Initializers

import com.aliyun.ros.cdk.elasticsearch.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dataNode(DataNodeProperty)
    .dataNode(IResolvable)
    .password(java.lang.String)
    .password(IResolvable)
    .version(java.lang.String)
    .version(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
//  .deleteType(java.lang.String)
//  .deleteType(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .enableKibanaPrivate(java.lang.Boolean)
//  .enableKibanaPrivate(IResolvable)
//  .enableKibanaPublic(java.lang.Boolean)
//  .enableKibanaPublic(IResolvable)
//  .enablePublic(java.lang.Boolean)
//  .enablePublic(IResolvable)
//  .instanceCategory(java.lang.String)
//  .instanceCategory(IResolvable)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .kibanaNode(IResolvable)
//  .kibanaNode(KibanaNodeProperty)
//  .kibanaWhitelist(java.util.List<java.lang.Object>)
//  .kibanaWhitelist(IResolvable)
//  .masterNode(IResolvable)
//  .masterNode(MasterNodeProperty)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .privateWhitelist(java.util.List<java.lang.Object>)
//  .privateWhitelist(IResolvable)
//  .publicWhitelist(java.util.List<java.lang.Object>)
//  .publicWhitelist(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .ymlConfig(IResolvable)
//  .ymlConfig(YMLConfigProperty)
//  .zoneCount(java.lang.Number)
//  .zoneCount(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

dataNode^Required

• Type: DataNodeProperty OR com.aliyun.ros.cdk.core.IResolvable

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

password^Required

• Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.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.

vSwitchId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The ID of VSwitch.

deleteType^Optional

• Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.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.

enableKibanaPrivate^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property enableKibanaPrivate: Enables or disables intranet access to Kibana.

enableKibanaPublic^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property enableKibanaPublic: Enables or disables Internet access to Kibana.

enablePublic^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property enablePublic: Whether enable public access.

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

instanceCategory^Optional

• Type: java.lang.String OR com.aliyun.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

instanceChargeType^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

kibanaNode^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR KibanaNodeProperty

Property kibanaNode: The dedicated kibana node setting.

kibanaWhitelist^Optional

• Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

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

masterNode^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR MasterNodeProperty

Property masterNode: The dedicated master node setting.

If specified, dedicated master node will be created.

period^Optional

• Type: java.lang.Number OR com.aliyun.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.

periodUnit^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Default value is Month.

privateWhitelist^Optional

• Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

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

publicWhitelist^Optional

• Type: java.util.List OR com.aliyun.ros.cdk.core.IResolvable

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

The AllocatePublicAddress should be true.

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

tags^Optional

• Type: java.util.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.

ymlConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR 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.

zoneCount^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property zoneCount: undefined.

zoneId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: The zone id of elasticsearch.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.elasticsearch.Instance;
Instance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrArn^Required

public java.lang.Object getAttrArn();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrDomain^Required

public java.lang.Object getAttrDomain();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrInstanceChargeType^Required

public java.lang.Object getAttrInstanceChargeType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceChargeType: Instance charge type.

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The ID of the Elasticsearch instance.

attrKibanaDomain^Required

public java.lang.Object getAttrKibanaDomain();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrKibanaPort^Required

public java.lang.Object getAttrKibanaPort();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute KibanaPort: Kibana console port.

attrPort^Required

public java.lang.Object getAttrPort();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Port: Instance connection port.

attrPublicDomain^Required

public java.lang.Object getAttrPublicDomain();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PublicDomain: Instance public connection domain.

attrStatus^Required

public java.lang.Object getAttrStatus();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Status: The Elasticsearch instance status.

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

attrVersion^Required

public java.lang.Object getAttrVersion();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Version: Elasticsearch version.

attrVSwitchId^Required

public java.lang.Object getAttrVSwitchId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VSwitchId: The ID of VSwitch.

props^Required

public InstanceProps getProps();

• Type: InstanceProps