Instance

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

Initializers

import { Instance } from '@alicloud/ros-cdk-elasticsearch'
new Instance(scope: Construct, id: string, props: InstanceProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	InstanceProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: InstanceProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

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

---

isConstruct

import { Instance } from '@alicloud/ros-cdk-elasticsearch'
Instance.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

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

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrDomain^Required

public readonly attrDomain: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrInstanceChargeType^Required

public readonly attrInstanceChargeType: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceChargeType: Instance charge type.

---

attrInstanceId^Required

public readonly attrInstanceId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceId: The ID of the Elasticsearch instance.

---

attrKibanaDomain^Required

public readonly attrKibanaDomain: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrKibanaPort^Required

public readonly attrKibanaPort: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute KibanaPort: Kibana console port.

---

attrPort^Required

public readonly attrPort: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Port: Instance connection port.

---

attrPublicDomain^Required

public readonly attrPublicDomain: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute PublicDomain: Instance public connection domain.

---

attrStatus^Required

public readonly attrStatus: IResolvable;

• Type: @alicloud/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 readonly attrVersion: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Version: Elasticsearch version.

---

attrVSwitchId^Required

public readonly attrVSwitchId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute VSwitchId: The ID of VSwitch.

---