Skip to content

Instance

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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
charge_type typing.Union[str, ros_cdk_core.IResolvable] Property chargeType: The billing method.
password typing.Union[str, ros_cdk_core.IResolvable] Property password: The password of instance.
qrs_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property qrsNum: The number of query nodes.
qrs_spec typing.Union[str, ros_cdk_core.IResolvable] Property qrsSpec: The specification of query nodes.
searcher_doc_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property searcherDocSize: The storage size of single data node.
searcher_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property searcherNum: The number of data nodes.
searcher_spec typing.Union[str, ros_cdk_core.IResolvable] Property searcherSpec: The specification of data nodes.
user_name typing.Union[str, ros_cdk_core.IResolvable] Property userName: The user name of instance.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of VPC.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The ID of vSwitch.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

charge_typeRequired

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

Property chargeType: The billing method.

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

passwordRequired

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

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

Property qrsNum: The number of query nodes.

qrs_specRequired

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

Property qrsSpec: The specification of query nodes.

searcher_doc_sizeRequired

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

Property searcherDocSize: The storage size of single data node.

searcher_numRequired

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

Property searcherNum: The number of data nodes.

searcher_specRequired

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

Property searcherSpec: The specification of data nodes.

user_nameRequired

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

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

Property vpcId: The ID of VPC.

v_switch_idRequired

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

Property vSwitchId: The ID of vSwitch.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_endpoint ros_cdk_core.IResolvable Attribute Endpoint: The endpoint of instance.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The ID of instance.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_endpointRequired 

attr_endpoint: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Endpoint: The endpoint of instance.

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of instance.