Skip to content

Instance

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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
chargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property chargeType: The billing method.
password java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property password: The password of instance.
qrsNum java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property qrsNum: The number of query nodes.
qrsSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property qrsSpec: The specification of query nodes.
searcherDocSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property searcherDocSize: The storage size of single data node.
searcherNum java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property searcherNum: The number of data nodes.
searcherSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property searcherSpec: The specification of data nodes.
userName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property userName: The user name of instance.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The ID of VPC.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The ID of vSwitch.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

chargeTypeRequired

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

Property chargeType: The billing method.

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

passwordRequired

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

qrsNumRequired

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

Property qrsNum: The number of query nodes.

qrsSpecRequired

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

Property qrsSpec: The specification of query nodes.

searcherDocSizeRequired

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

Property searcherDocSize: The storage size of single data node.

searcherNumRequired

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

Property searcherNum: The number of data nodes.

searcherSpecRequired

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

Property searcherSpec: The specification of data nodes.

userNameRequired

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

vpcIdRequired

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

Property vpcId: The ID of VPC.

vSwitchIdRequired

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

Property vSwitchId: The ID of vSwitch.

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.searchengine.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.
attrEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute Endpoint: The endpoint of instance.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The ID of instance.

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

attrEndpointRequired 

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

Attribute Endpoint: The endpoint of instance.

attrInstanceIdRequired 

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

Attribute InstanceId: The ID of instance.