Skip to content

HiTSDBInstance

This class encapsulates and extends the ROS resource type ALIYUN::TSDB::HiTSDBInstance, which is used to create a Time Series Database (TSDB) instance.

Initializers 

import ros_cdk_tsdb
ros_cdk_tsdb.HiTSDBInstance(
  scope: Construct,
  id: str,
  instance_class: typing.Union[str, IResolvable],
  instance_storage: typing.Union[typing.Union[int, float], IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  disk_category: typing.Union[str, IResolvable] = None,
  duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  instance_alias: typing.Union[str, IResolvable] = None,
  pay_type: typing.Union[str, IResolvable] = None,
  pricing_cycle: typing.Union[str, IResolvable] = None,
  security_ip_list: typing.Union[IResolvable, typing.List[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.
instance_class typing.Union[str, ros_cdk_core.IResolvable] Property instanceClass: The type of the instance.
instance_storage typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property instanceStorage: The storage capacity of the instance.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the virtual private cloud (VPC) that is connected to the instance.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The ID of the VSwitch in the specified VPC.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The zone ID of the instance.
disk_category typing.Union[str, ros_cdk_core.IResolvable] Property diskCategory: The category of disk.
duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property duration: The validity period of the instance.
instance_alias typing.Union[str, ros_cdk_core.IResolvable] Property instanceAlias: The alias of the instance.
pay_type typing.Union[str, ros_cdk_core.IResolvable] Property payType: The billing method.
pricing_cycle typing.Union[str, ros_cdk_core.IResolvable] Property pricingCycle: The unit of the validity period.
security_ip_list typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property securityIpList: List of the IP patterns.For example, ["127.0.0.1", "192.168.0.1\/24"].
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

instance_classRequired

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

Property instanceClass: The type of the instance.

instance_storageRequired

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

Property instanceStorage: The storage capacity of the instance.

Unit: GB. For example, the value 50 indicates 50 GB.

vpc_idRequired

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

Property vpcId: The ID of the virtual private cloud (VPC) that is connected to the instance.

v_switch_idRequired

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

Property vSwitchId: The ID of the VSwitch in the specified VPC.

zone_idRequired

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

Property zoneId: The zone ID of the instance.

disk_categoryOptional

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

Property diskCategory: The category of disk.

durationOptional

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

Property duration: The validity period of the instance.

This parameter is valid only when the PayType parameter is set to PREPAY. Default value: 1.

instance_aliasOptional

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

Property instanceAlias: The alias of the instance.

pay_typeOptional

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

Property payType: The billing method.

Valid values:

  • prepay: The prepay value indicates the subscription method.

pricing_cycleOptional

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

Property pricingCycle: The unit of the validity period.

This parameter is valid only when the PayType parameter is set to PREPAY. Default value: Month.

security_ip_listOptional

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

Property securityIpList: List of the IP patterns.For example, ["127.0.0.1", "192.168.0.1\/24"].

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_tsdb
ros_cdk_tsdb.HiTSDBInstance.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_connection_string ros_cdk_core.IResolvable Attribute ConnectionString: Connection string of the instance.
attr_engine_type ros_cdk_core.IResolvable Attribute EngineType: Engine type of the instance.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The ID of the instance.
attr_order_id ros_cdk_core.IResolvable Attribute OrderId: Order id of created instance.
attr_public_connection_string ros_cdk_core.IResolvable Attribute PublicConnectionString: Public connection string of the instance.
attr_reverse_vpc_ip ros_cdk_core.IResolvable Attribute ReverseVpcIp: Reverse vpc ip of the instance.
attr_reverse_vpc_port ros_cdk_core.IResolvable Attribute ReverseVpcPort: Reverse vpc port of the 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_connection_stringRequired 

attr_connection_string: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ConnectionString: Connection string of the instance.

attr_engine_typeRequired 

attr_engine_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EngineType: Engine type of the instance.

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of the instance.

attr_order_idRequired 

attr_order_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OrderId: Order id of created instance.

attr_public_connection_stringRequired 

attr_public_connection_string: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PublicConnectionString: Public connection string of the instance.

attr_reverse_vpc_ipRequired 

attr_reverse_vpc_ip: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ReverseVpcIp: Reverse vpc ip of the instance.

attr_reverse_vpc_portRequired 

attr_reverse_vpc_port: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ReverseVpcPort: Reverse vpc port of the instance.