Instance

• Implements: IInstance

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

Initializers

import com.aliyun.ros.cdk.searchengine.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .chargeType(java.lang.String)
    .chargeType(IResolvable)
    .password(java.lang.String)
    .password(IResolvable)
    .qrsNum(java.lang.Number)
    .qrsNum(IResolvable)
    .qrsSpec(java.lang.String)
    .qrsSpec(IResolvable)
    .searcherDocSize(java.lang.Number)
    .searcherDocSize(IResolvable)
    .searcherNum(java.lang.Number)
    .searcherNum(IResolvable)
    .searcherSpec(java.lang.String)
    .searcherSpec(IResolvable)
    .userName(java.lang.String)
    .userName(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

chargeType^Required

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

Property chargeType: The billing method.

Valid values: POSTPAY. POSTPAY: pay-as-you-go.

password^Required

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

Property password: The password of instance.

It consists of lowercase letters and numbers, and the length is 6-8 characters.

qrsNum^Required

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

Property qrsNum: The number of query nodes.

qrsSpec^Required

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

Property qrsSpec: The specification of query nodes.

searcherDocSize^Required

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

Property searcherDocSize: The storage size of single data node.

searcherNum^Required

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

Property searcherNum: The number of data nodes.

searcherSpec^Required

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

Property searcherSpec: The specification of data nodes.

userName^Required

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

Property userName: The user name of instance.

Begin with a letter, support upper and lower case letters, numbers, underscores, length 1-30 characters.

vpcId^Required

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

Property vpcId: The ID of VPC.

vSwitchId^Required

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

Property vSwitchId: The ID of vSwitch.

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

attrEndpoint^Required

public java.lang.Object getAttrEndpoint();

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

Attribute Endpoint: The endpoint of instance.

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

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

Attribute InstanceId: The ID of instance.

props^Required

public InstanceProps getProps();

• Type: InstanceProps