DrdsInstance

This class encapsulates and extends the ROS resource type ALIYUN::DRDS::DrdsInstance, which is used to create a PolarDB-X 1.0 instance of specified instance specifications.

Initializers

import ros_cdk_drds
ros_cdk_drds.DrdsInstance(
  scope: Construct,
  id: str,
  description: typing.Union[str, IResolvable],
  instance_series: typing.Union[str, IResolvable],
  pay_type: typing.Union[str, IResolvable],
  specification: typing.Union[str, IResolvable],
  type: typing.Union[str, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  is_auto_renew: typing.Union[bool, IResolvable] = None,
  my_sql_version: typing.Union[str, IResolvable] = None,
  pricing_cycle: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  vswitch_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.
`description`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property description: Description of the DRDS instance, 2-128 characters.
`instance_series`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property instanceSeries: drds.sn1.4c8g Starter Edition; drds.sn1.8c16g Standard Edition; drds.sn1.16c32g Business Edition; drds.sn1.32c64g Ultimate Edition.
`pay_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property payType: For the type of payment, see "Payment Type Parameter Table".
`specification`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property specification: The example specification, for example, drds.sn1.4c8g.8C16G, consists of the DRDS instance series (drds.sn1.4c8g) plus a specific example specification (8C16G). For the DRDS instance specification value range, see: Distributed Relational Database Service Specifications and Pricing.
`type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property type: Instance type, instance type 0 - shared instance 1 - exclusive instance, in addition, this parameter can also pass PRIVATE and PUBLIC to represent exclusive instance and shared instance respectively.
`zone_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property zoneId: Availability zone, an available zone belongs to a certain zone, such as Hangzhou Availability Zone A (cn-hangzhou-a) belongs to the region Hangzhou (cn-hangzhou).
`duration`	`typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]`	Property duration: The number of cycles ordered.
`is_auto_renew`	`typing.Union[bool, ros_cdk_core.IResolvable]`	Property isAutoRenew: Whether to renew the fee automatically, if it is purchased on a monthly basis, it will automatically renew for one month, and if it is purchased on an annual basis, it will automatically renew for one year.
`my_sql_version`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property mySqlVersion: The MySQL protocol version supported by DRDS.
`pricing_cycle`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property pricingCycle: The unit of the order period, year: year, month: month.
`resource_group_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property resourceGroupId: Resource group id.
`tags`	`typing.List[TagsProperty]`	Property tags: Tags to attach to instance.
`vpc_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property vpcId: Virtual private network ID, must be specified when creating a DRDS for VPC network type.
`vswitch_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property vswitchId: Virtual switch ID, must be specified when creating a DRDS for VPC network type.
`enable_resource_property_constraint`	`bool`	No description.

`scope`^Required

Type: ros_cdk_core.Construct

`id`^Required

Type: str

`description`^Required

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

Property description: Description of the DRDS instance, 2-128 characters.

`instance_series`^Required

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

Property instanceSeries: drds.sn1.4c8g Starter Edition; drds.sn1.8c16g Standard Edition; drds.sn1.16c32g Business Edition; drds.sn1.32c64g Ultimate Edition.

`pay_type`^Required

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

Property payType: For the type of payment, see "Payment Type Parameter Table".

`specification`^Required

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

Property specification: The example specification, for example, drds.sn1.4c8g.8C16G, consists of the DRDS instance series (drds.sn1.4c8g) plus a specific example specification (8C16G). For the DRDS instance specification value range, see: Distributed Relational Database Service Specifications and Pricing.

`type`^Required

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

Property type: Instance type, instance type 0 - shared instance 1 - exclusive instance, in addition, this parameter can also pass PRIVATE and PUBLIC to represent exclusive instance and shared instance respectively.

`zone_id`^Required

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

Property zoneId: Availability zone, an available zone belongs to a certain zone, such as Hangzhou Availability Zone A (cn-hangzhou-a) belongs to the region Hangzhou (cn-hangzhou).

`duration`^Optional

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

Property duration: The number of cycles ordered.

When PricingCycle=year, the value is 1-3; when PricingCycle=month, the value is 1-9. The parameter takes effect when the payment type is drdsPre.

`is_auto_renew`^Optional

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

Property isAutoRenew: Whether to renew the fee automatically, if it is purchased on a monthly basis, it will automatically renew for one month, and if it is purchased on an annual basis, it will automatically renew for one year.

The parameter takes effect when the payment type is drdsPre.

`my_sql_version`^Optional

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

Property mySqlVersion: The MySQL protocol version supported by DRDS.

Valid values: 5 and 8. Default value: 5. This parameter is valid only when the primary instance is created. The read-only instance is the same as the primary instance by default.

`pricing_cycle`^Optional

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

Property pricingCycle: The unit of the order period, year: year, month: month.

The parameter takes effect when the payment type is drdsPre.

`resource_group_id`^Optional

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

Property resourceGroupId: Resource group id.

`tags`^Optional

Type: typing.List[TagsProperty]

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

`vpc_id`^Optional

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

Property vpcId: Virtual private network ID, must be specified when creating a DRDS for VPC network type.

`vswitch_id`^Optional

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

Property vswitchId: Virtual switch ID, must be specified when creating a DRDS for VPC network type.

`enable_resource_property_constraint`^Optional

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.

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

`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

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

`is_construct`

import ros_cdk_drds
ros_cdk_drds.DrdsInstance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

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_drds_instance_id`	`ros_cdk_core.IResolvable`	Attribute DrdsInstanceId: instance id.
`attr_internet_endpoint`	`ros_cdk_core.IResolvable`	Attribute InternetEndpoint: Public endpoint.
`attr_intranet_endpoint`	`ros_cdk_core.IResolvable`	Attribute IntranetEndpoint: VPC endpoint.
`attr_order_id`	`ros_cdk_core.IResolvable`	Attribute OrderId: order number.

`node`^Required

node: ConstructNode

Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

`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_drds_instance_id`^Required

attr_drds_instance_id: IResolvable

Type: ros_cdk_core.IResolvable

Attribute DrdsInstanceId: instance id.

`attr_internet_endpoint`^Required

attr_internet_endpoint: IResolvable

Type: ros_cdk_core.IResolvable

Attribute InternetEndpoint: Public endpoint.

`attr_intranet_endpoint`^Required

attr_intranet_endpoint: IResolvable

Type: ros_cdk_core.IResolvable

Attribute IntranetEndpoint: VPC endpoint.

`attr_order_id`^Required

attr_order_id: IResolvable

Type: ros_cdk_core.IResolvable

Attribute OrderId: order number.

DrdsInstance

Initializers

scopeRequired

idRequired

descriptionRequired

instance_seriesRequired

pay_typeRequired

specificationRequired

typeRequired

zone_idRequired

durationOptional

is_auto_renewOptional

my_sql_versionOptional

pricing_cycleOptional

resource_group_idOptional

tagsOptional

vpc_idOptional

vswitch_idOptional

enable_resource_property_constraintOptional

Methods

to_string

synthesize

add_condition

add_count

add_dependency

add_resource_desc

apply_removal_policy

get_att

set_metadata