Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::Lindorm::Instance, which is used to create a Lindorm instance.

Initializers 

import ros_cdk_lindorm
ros_cdk_lindorm.Instance(
  scope: Construct,
  id: str,
  disk_category: typing.Union[str, IResolvable],
  instance_name: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  cold_storage: typing.Union[typing.Union[int, float], IResolvable] = None,
  core_spec: typing.Union[str, IResolvable] = None,
  deletion_protection: typing.Union[bool, IResolvable] = None,
  filestore_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  filestore_spec: typing.Union[str, IResolvable] = None,
  instance_charge_type: typing.Union[str, IResolvable] = None,
  instance_storage: typing.Union[typing.Union[int, float], IResolvable] = None,
  lindorm_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  lindorm_spec: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_ip_list: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  solr_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  solr_spec: typing.Union[str, IResolvable] = None,
  stream_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  stream_spec: typing.Union[str, IResolvable] = None,
  tsdb_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  tsdb_spec: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
disk_category typing.Union[str, ros_cdk_core.IResolvable] Property diskCategory: The storage type of the instance.
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: The name of the instance that you want to create.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the VPC in which you want to create the instance.
cold_storage typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property coldStorage: The cold storage capacity of the instance.
core_spec typing.Union[str, ros_cdk_core.IResolvable] Property coreSpec: The specification of the nodes in the instance if you set DiskCategory to local_ssd_pro or local_hdd_pro.
deletion_protection typing.Union[bool, ros_cdk_core.IResolvable] Property deletionProtection: Specifies whether to enable the release protection feature for the instance.
filestore_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property filestoreNum: The number of LindormDFS nodes in the instance.
filestore_spec typing.Union[str, ros_cdk_core.IResolvable] Property filestoreSpec: The specification of LindormDFS nodes in the instance.
instance_charge_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceChargeType: The billing method of the instance you want to create.
instance_storage typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property instanceStorage: The storage capacity of the instance you want to create.
lindorm_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property lindormNum: The number of LindormTable nodes in the instance.
lindorm_spec typing.Union[str, ros_cdk_core.IResolvable] Property lindormSpec: The specification of LindormTable nodes in the instance.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The subscription period of the instance.
period_unit typing.Union[str, ros_cdk_core.IResolvable] Property periodUnit: The period based on which you are charged for the instance.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group to which the Lindorm instance belongs.
security_ip_list typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property securityIpList: The ip white list of instance.
solr_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property solrNum: The number of LindormSearch nodes in the instance.
solr_spec typing.Union[str, ros_cdk_core.IResolvable] Property solrSpec: The specification of the LindormSearch nodes in the instance.
stream_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property streamNum: The number of LindormStream nodes in the instance.
stream_spec typing.Union[str, ros_cdk_core.IResolvable] Property streamSpec: The specification of LindormStream nodes in the instance.
tsdb_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property tsdbNum: The number of the LindormTSDB nodes in the instance.
tsdb_spec typing.Union[str, ros_cdk_core.IResolvable] Property tsdbSpec: The specification of the LindormTSDB nodes in the instance.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The ID of the vSwitch to which you want the instance to connect.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The ID of the zone in which you want to create the instance.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

disk_categoryRequired

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

Property diskCategory: The storage type of the instance.

Valid values: cloud_efficiency: This instance uses the Standard type of storage. cloud_ssd: This instance uses the Performance type of storage. capacity_cloud_storage: This instance uses the Capacity type of storage. local_ssd_pro: This instance uses local SSDs. local_hdd_pro: This instance uses local HDDs.

instance_nameRequired

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

Property instanceName: The name of the instance that you want to create.

vpc_idRequired

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

Property vpcId: The ID of the VPC in which you want to create the instance.

cold_storageOptional

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

Property coldStorage: The cold storage capacity of the instance.

By default, if you leave this parameter unspecified, cold storage is not enabled for the instance. Unit: GB. Valid values: 800 to 1000000.

core_specOptional

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

Property coreSpec: The specification of the nodes in the instance if you set DiskCategory to local_ssd_pro or local_hdd_pro.

When DiskCategory is set to local_ssd_pro, you can set this parameter to the following values: lindorm.i2.xlarge: Each node has 4 dedicated CPU cores and 32 GB of dedicated memory. lindorm.i2.2xlarge: Each node has 8 dedicated CPU cores and 64 GB of dedicated memory. lindorm.i2.4xlarge: Each node has 16 dedicated CPU cores and 128 GB of dedicated memory. lindorm.i2.8xlarge: Each node has 32 dedicated CPU cores and 256 GB of dedicated memory. When DiskCategory is set to local_hdd_pro, you can set this parameter to the following values: lindorm.d1.2xlarge: Each node has 8 dedicated CPU cores and 32 GB of dedicated memory. lindorm.d1.4xlarge: Each node has 16 dedicated CPU cores and 64 GB of dedicated memory. lindorm.d1.6xlarge: Each node has 24 dedicated CPU cores and 96 GB of dedicated memory.

deletion_protectionOptional

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

Property deletionProtection: Specifies whether to enable the release protection feature for the instance.

Default is false.

filestore_numOptional

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

Property filestoreNum: The number of LindormDFS nodes in the instance.

The valid values of this parameter depend on the value of the PayType parameter. If the PayType parameter is set to PREPAY, set this parameter to an integer that ranges from 0 to 60. If the PayType parameter is set to POSTPAY, set this parameter to an integer that ranges from 0 to 8.

filestore_specOptional

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

Property filestoreSpec: The specification of LindormDFS nodes in the instance.

Set the value of this parameter to lindorm.c.xlarge, which indicates that each node has 4 dedicated CPU cores and 8 GB of dedicated memory.

instance_charge_typeOptional

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

Property instanceChargeType: The billing method of the instance you want to create.

Valid values: PREPAY: subscription. POSTPAY: pay-as-you-go. Default value: POSTPAY

instance_storageOptional

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

Property instanceStorage: The storage capacity of the instance you want to create.

Unit: GB.

lindorm_numOptional

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

Property lindormNum: The number of LindormTable nodes in the instance.

The valid values of this parameter depend on the value of the PayType parameter. If the PayType parameter is set to PREPAY, set this parameter to an integer that ranges from 0 to 90. If the PayType parameter is set to POSTPAY, set this parameter to an integer that ranges from 0 to 400. ** This parameter is required if you want to create a multi-zone instance. ** The valid values of this parameter range from 4 to 400 if you want to create a multi-zone instance.

lindorm_specOptional

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

Property lindormSpec: The specification of LindormTable nodes in the instance.

Valid values: lindorm.g.xlarge: Each node has 4 dedicated CPU cores and 16 GB of dedicated memory. lindorm.g.2xlarge: Each node has 8 dedicated CPU cores and 32 GB of dedicated memory. lindorm.g.4xlarge: Each node has 16 dedicated CPU cores and 64 GB of dedicated memory. lindorm.g.8xlarge: Each node has 32 dedicated CPU cores and 128 GB of dedicated memory. lindorm.c.xlarge: Each node has 4 dedicated CPU cores and 8 GB of dedicated memory. lindorm.c.2xlarge: Each node has 8 dedicated CPU cores and 16 GB of dedicated memory. lindorm.c.4xlarge: Each node has 16 dedicated CPU cores and 32 GB of dedicated memory. lindorm.c.8xlarge: Each node has 32 dedicated CPU cores and 64 GB of dedicated memory.

periodOptional

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

Property period: The subscription period of the instance.

The valid values of this parameter depend on the value of the PeriodUnit parameter. If PeriodUnit is set to Month, Valid values are 1,2,3,4,5,6,7,8,9,12,24,36. If PeriodUnit is set to Year, set this parameter to an integer that ranges from 1 to 3. NoteThis parameter is available and required when the PayType parameter is set to PREPAY.

period_unitOptional

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

Property periodUnit: The period based on which you are charged for the instance.

Valid values: Month: You are charged for the instance on a monthly basis. Year: You are charged for the instance on a yearly basis. NoteThis parameter is available and required when the PayType parameter is set to PREPAY.

resource_group_idOptional

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

Property resourceGroupId: The ID of the resource group to which the Lindorm instance belongs.

security_ip_listOptional

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

Property securityIpList: The ip white list of instance.

solr_numOptional

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

Property solrNum: The number of LindormSearch nodes in the instance.

Valid values: integers from 0 to 60.

solr_specOptional

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

Property solrSpec: The specification of the LindormSearch nodes in the instance.

Valid values: lindorm.g.xlarge: Each node has 4 dedicated CPU cores and 16 GB of dedicated memory. lindorm.g.2xlarge: Each node has 8 dedicated CPU cores and 32 GB of dedicated memory. lindorm.g.4xlarge: Each node has 16 dedicated CPU cores and 64 GB of dedicated memory. lindorm.g.8xlarge: Each node has 32 dedicated CPU cores and 128 GB of dedicated memory.

stream_numOptional

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

Property streamNum: The number of LindormStream nodes in the instance.

Valid values: integers from 0 to 90.

stream_specOptional

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

Property streamSpec: The specification of LindormStream nodes in the instance.

Valid values: lindorm.g.xlarge: Each node has 4 dedicated CPU cores and 16 GB of dedicated memory. lindorm.g.2xlarge: Each node has 8 dedicated CPU cores and 32 GB of dedicated memory. lindorm.g.4xlarge: Each node has 16 dedicated CPU cores and 64 GB of dedicated memory. lindorm.g.8xlarge: Each node has 32 dedicated CPU cores and 128 GB of dedicated memory. lindorm.c.xlarge: Each node has 4 dedicated CPU cores and 8 GB of dedicated memory. lindorm.c.2xlarge: Each node has 8 dedicated CPU cores and 16 GB of dedicated memory. lindorm.c.4xlarge: Each node has 16 dedicated CPU cores and 32 GB of dedicated memory. lindorm.c.8xlarge: Each node has 32 dedicated CPU cores and 64 GB of dedicated memory.

tsdb_numOptional

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

Property tsdbNum: The number of the LindormTSDB nodes in the instance.

The valid values of this parameter depend on the value of the PayType parameter. If the PayType parameter is set to PREPAY, set this parameter to an integer that ranges from 0 to 24. If the PayType parameter is set to POSTPAY, set this parameter to an integer that ranges from 0 to 32.

tsdb_specOptional

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

Property tsdbSpec: The specification of the LindormTSDB nodes in the instance.

Valid values: lindorm.g.xlarge: Each node has 4 dedicated CPU cores and 16 GB of dedicated memory. lindorm.g.2xlarge: Each node has 8 dedicated CPU cores and 32 GB of dedicated memory. lindorm.g.4xlarge: Each node has 16 dedicated CPU cores and 64 GB of dedicated memory. lindorm.g.8xlarge: Each node has 32 dedicated CPU cores and 128 GB of dedicated memory.

v_switch_idOptional

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

Property vSwitchId: The ID of the vSwitch to which you want the instance to connect.

zone_idOptional

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

Property zoneId: The ID of the zone in which you want to create the instance.

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_lindorm
ros_cdk_lindorm.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_auth_infos ros_cdk_core.IResolvable Attribute AuthInfos: The list of the Lindorm instance auth infos.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The ID of the Lindorm instance that is created.
attr_jdbc_url_list ros_cdk_core.IResolvable Attribute JdbcUrlList: The list of the jdbc connection address.

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_auth_infosRequired 

attr_auth_infos: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AuthInfos: The list of the Lindorm instance auth infos.

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of the Lindorm instance that is created.

attr_jdbc_url_listRequired 

attr_jdbc_url_list: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute JdbcUrlList: The list of the jdbc connection address.