Skip to content

Instance

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)
//  .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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
dataNode DataNodeProperty OR com.aliyun.ros.cdk.core.IResolvable Property dataNode: The Elasticsearch cluster's data node setting.
password java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property password: The password of the instance.
version java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property version: Elasticsearch version.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The ID of VSwitch.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of instance.
enableKibanaPrivate java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableKibanaPrivate: Enables or disables intranet access to Kibana.
enableKibanaPublic java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableKibanaPublic: Enables or disables Internet access to Kibana.
enablePublic java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enablePublic: Whether enable public access.
instanceCategory 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.
instanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceChargeType: Valid values are PrePaid, PostPaid, Default to PostPaid.
kibanaNode com.aliyun.ros.cdk.core.IResolvable OR KibanaNodeProperty Property kibanaNode: The dedicated kibana node setting.
kibanaWhitelist java.util.List OR com.aliyun.ros.cdk.core.IResolvable Property kibanaWhitelist: Set the Kibana's IP whitelist in internet network.
masterNode com.aliyun.ros.cdk.core.IResolvable OR MasterNodeProperty Property masterNode: The dedicated master node setting.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The duration that you will buy Elasticsearch instance.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodUnit: Unit of prepaid time period, it could be Month\/Year.
privateWhitelist java.util.List OR com.aliyun.ros.cdk.core.IResolvable Property privateWhitelist: Set the instance's IP whitelist in VPC network.
publicWhitelist java.util.List OR com.aliyun.ros.cdk.core.IResolvable Property publicWhitelist: Set the instance's IP whitelist in Internet.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.
ymlConfig 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 java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property zoneCount: undefined.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The zone id of elasticsearch.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

dataNodeRequired

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

passwordRequired

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

versionRequired

  • 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.

vSwitchIdRequired

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

Property vSwitchId: The ID of VSwitch.

descriptionOptional

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

Property description: The description of instance.

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

enableKibanaPrivateOptional

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

Property enableKibanaPrivate: Enables or disables intranet access to Kibana.

enableKibanaPublicOptional

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

Property enableKibanaPublic: Enables or disables Internet access to Kibana.

enablePublicOptional

  • 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.

instanceCategoryOptional

  • 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

instanceChargeTypeOptional

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

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

kibanaNodeOptional

Property kibanaNode: The dedicated kibana node setting.

kibanaWhitelistOptional

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

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

masterNodeOptional

Property masterNode: The dedicated master node setting.

If specified, dedicated master node will be created.

periodOptional

  • 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.

periodUnitOptional

  • 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.

privateWhitelistOptional

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

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

publicWhitelistOptional

  • 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.

resourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group.

tagsOptional

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.

ymlConfigOptional

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.

zoneCountOptional

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

Property zoneCount: undefined.

zoneIdOptional

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

Property zoneId: The zone id of elasticsearch.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrDomain com.aliyun.ros.cdk.core.IResolvable Attribute Domain: Instance connection domain (only VPC network access supported).
attrInstanceChargeType com.aliyun.ros.cdk.core.IResolvable Attribute InstanceChargeType: Instance charge type.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The ID of the Elasticsearch instance.
attrKibanaDomain com.aliyun.ros.cdk.core.IResolvable Attribute KibanaDomain: Kibana console domain (Internet access supported).
attrKibanaPort com.aliyun.ros.cdk.core.IResolvable Attribute KibanaPort: Kibana console port.
attrPort com.aliyun.ros.cdk.core.IResolvable Attribute Port: Instance connection port.
attrPublicDomain com.aliyun.ros.cdk.core.IResolvable Attribute PublicDomain: Instance public connection domain.
attrStatus com.aliyun.ros.cdk.core.IResolvable Attribute Status: The Elasticsearch instance status.
attrVersion com.aliyun.ros.cdk.core.IResolvable Attribute Version: Elasticsearch version.
attrVSwitchId com.aliyun.ros.cdk.core.IResolvable Attribute VSwitchId: The ID of VSwitch.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrDomainRequired 

public IResolvable getAttrDomain();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrInstanceChargeTypeRequired 

public IResolvable getAttrInstanceChargeType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceChargeType: Instance charge type.

attrInstanceIdRequired 

public IResolvable getAttrInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The ID of the Elasticsearch instance.

attrKibanaDomainRequired 

public IResolvable getAttrKibanaDomain();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrKibanaPortRequired 

public IResolvable getAttrKibanaPort();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute KibanaPort: Kibana console port.

attrPortRequired 

public IResolvable getAttrPort();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Port: Instance connection port.

attrPublicDomainRequired 

public IResolvable getAttrPublicDomain();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PublicDomain: Instance public connection domain.

attrStatusRequired 

public IResolvable getAttrStatus();
  • Type: 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.

attrVersionRequired 

public IResolvable getAttrVersion();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Version: Elasticsearch version.

attrVSwitchIdRequired 

public IResolvable getAttrVSwitchId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VSwitchId: The ID of VSwitch.