Instance

• Implements: IInstance

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

Initializers

import ros_cdk_searchengine
ros_cdk_searchengine.Instance(
  scope: Construct,
  id: str,
  charge_type: typing.Union[str, IResolvable],
  password: typing.Union[str, IResolvable],
  qrs_num: typing.Union[typing.Union[int, float], IResolvable],
  qrs_spec: typing.Union[str, IResolvable],
  searcher_doc_size: typing.Union[typing.Union[int, float], IResolvable],
  searcher_num: typing.Union[typing.Union[int, float], IResolvable],
  searcher_spec: typing.Union[str, IResolvable],
  user_name: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

charge_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property chargeType: The billing method.

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

password^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property password: The password of instance.

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

qrs_num^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property qrsNum: The number of query nodes.

qrs_spec^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property qrsSpec: The specification of query nodes.

searcher_doc_size^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property searcherDocSize: The storage size of single data node.

searcher_num^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property searcherNum: The number of data nodes.

searcher_spec^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property searcherSpec: The specification of data nodes.

user_name^Required

• Type: typing.Union[str, 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.

vpc_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vpcId: The ID of VPC.

v_switch_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vSwitchId: The ID of vSwitch.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_searchengine
ros_cdk_searchengine.Instance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_endpoint^Required

attr_endpoint: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Endpoint: The endpoint of instance.

attr_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute InstanceId: The ID of instance.

props^Required

props: InstanceProps

• Type: InstanceProps