Skip to content

MyBase

This class encapsulates and extends the ROS resource type ALIYUN::CDDC::MyBase, which is used to create a host in a Proprietary MyBase dedicated cluster in ApsaraDB for MyBase.

Initializers

import ros_cdk_cddc
ros_cdk_cddc.MyBase(
  scope: Construct,
  id: str,
  ecs_class_list: typing.Union[IResolvable, typing.List[typing.Mapping[typing.Any]]],
  engine: typing.Union[str, IResolvable],
  pay_type: typing.Union[str, IResolvable],
  period: typing.Union[typing.Union[int, float], IResolvable],
  security_group_id: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  auto_renew: typing.Union[bool, IResolvable] = None,
  dedicated_host_group_description: typing.Union[str, IResolvable] = None,
  dedicated_host_group_id: typing.Union[str, IResolvable] = None,
  ecs_deployment_set_id: typing.Union[str, IResolvable] = None,
  ecs_host_name: typing.Union[str, IResolvable] = None,
  ecs_instance_name: typing.Union[str, IResolvable] = None,
  ecs_unique_suffix: typing.Union[bool, IResolvable] = None,
  image_id: typing.Union[str, IResolvable] = None,
  internet_charge_type: typing.Union[str, IResolvable] = None,
  internet_max_bandwidth_out: typing.Union[typing.Union[int, float], IResolvable] = None,
  key_pair_name: typing.Union[str, IResolvable] = None,
  os_password: typing.Union[str, IResolvable] = None,
  password_inherit: typing.Union[bool, IResolvable] = None,
  period_type: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  user_data: typing.Union[str, IResolvable] = None,
  user_data_in_base64: typing.Union[bool, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
ecs_class_list typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Mapping[typing.Any]]] Property ecsClassList: ECS Class List.
engine typing.Union[str, ros_cdk_core.IResolvable] Property engine: Database type.
pay_type typing.Union[str, ros_cdk_core.IResolvable] Property payType: Payment type, currently only supports PrePaid.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The period of the subscription in months.
security_group_id typing.Union[str, ros_cdk_core.IResolvable] Property securityGroupId: The ID of the security group.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the VPC.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: Virtual switch ID.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: Availability Zone ID.
auto_renew typing.Union[bool, ros_cdk_core.IResolvable] Property autoRenew: Whether to enable auto renew.
dedicated_host_group_description typing.Union[str, ros_cdk_core.IResolvable] Property dedicatedHostGroupDescription: The name of the dedicated cluster.
dedicated_host_group_id typing.Union[str, ros_cdk_core.IResolvable] Property dedicatedHostGroupId: The ID of the dedicated cluster.
ecs_deployment_set_id typing.Union[str, ros_cdk_core.IResolvable] Property ecsDeploymentSetId: The ID of the deployment set.
ecs_host_name typing.Union[str, ros_cdk_core.IResolvable] Property ecsHostName: The host name of the ECS instance.
ecs_instance_name typing.Union[str, ros_cdk_core.IResolvable] Property ecsInstanceName: The name of the ECS instance.
ecs_unique_suffix typing.Union[bool, ros_cdk_core.IResolvable] Property ecsUniqueSuffix: The unique suffix of the ECS instance.
image_id typing.Union[str, ros_cdk_core.IResolvable] Property imageId: The image ID.
internet_charge_type typing.Union[str, ros_cdk_core.IResolvable] Property internetChargeType: Network billing type.
internet_max_bandwidth_out typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property internetMaxBandwidthOut: Set internet output bandwidth of instance.
key_pair_name typing.Union[str, ros_cdk_core.IResolvable] Property keyPairName: The name of the key pair.
os_password typing.Union[str, ros_cdk_core.IResolvable] Property osPassword: Password of created ecs instance.
password_inherit typing.Union[bool, ros_cdk_core.IResolvable] Property passwordInherit: Whether to inherit the password from the parent cluster.
period_type typing.Union[str, ros_cdk_core.IResolvable] Property periodType: Prepaid type, currently only supports Monthly (monthly subscription).
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group id.
user_data typing.Union[str, ros_cdk_core.IResolvable] Property userData: User-defined script data, the original data is up to 16KB.
user_data_in_base64 typing.Union[bool, ros_cdk_core.IResolvable] Property userDataInBase64: The user data of the ECS instance.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

ecs_class_listRequired

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

Property ecsClassList: ECS Class List.


engineRequired

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

Property engine: Database type.


pay_typeRequired

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

Property payType: Payment type, currently only supports PrePaid.


periodRequired

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

Property period: The period of the subscription in months.


security_group_idRequired

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

Property securityGroupId: The ID of the security group.


vpc_idRequired

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

Property vpcId: The ID of the VPC.


v_switch_idRequired

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

Property vSwitchId: Virtual switch ID.


zone_idRequired

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

Property zoneId: Availability Zone ID.


auto_renewOptional

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

Property autoRenew: Whether to enable auto renew.


dedicated_host_group_descriptionOptional

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

Property dedicatedHostGroupDescription: The name of the dedicated cluster.


dedicated_host_group_idOptional

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

Property dedicatedHostGroupId: The ID of the dedicated cluster.


ecs_deployment_set_idOptional

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

Property ecsDeploymentSetId: The ID of the deployment set.


ecs_host_nameOptional

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

Property ecsHostName: The host name of the ECS instance.


ecs_instance_nameOptional

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

Property ecsInstanceName: The name of the ECS instance.


ecs_unique_suffixOptional

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

Property ecsUniqueSuffix: The unique suffix of the ECS instance.


image_idOptional

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

Property imageId: The image ID.


internet_charge_typeOptional

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

Property internetChargeType: Network billing type.

Value range: PayByBandwidth: billed based on fixed bandwidth. PayByTraffic: Pay by traffic usage.


internet_max_bandwidth_outOptional

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

Property internetMaxBandwidthOut: Set internet output bandwidth of instance.

Unit is Mbps(Mega bit per second). Range is [0,200]. Default is 1. While the property is not 0, public ip will be assigned for instance.


key_pair_nameOptional

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

Property keyPairName: The name of the key pair.


os_passwordOptional

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

Property osPassword: Password of created ecs instance.

Must contain at least 3 types of special character, lower character, upper character, number.


password_inheritOptional

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

Property passwordInherit: Whether to inherit the password from the parent cluster.


period_typeOptional

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

Property periodType: Prepaid type, currently only supports Monthly (monthly subscription).


resource_group_idOptional

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

Property resourceGroupId: Resource group id.


user_dataOptional

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

Property userData: User-defined script data, the original data is up to 16KB.


user_data_in_base64Optional

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

Property userDataInBase64: The user data of the ECS 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.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc 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

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

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_cddc
ros_cdk_cddc.MyBase.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.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
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_instance_ids typing.Union[str, ros_cdk_core.IResolvable] Attribute InstanceIds: The instance id list of created ecs instances.
attr_order_ids typing.Union[str, ros_cdk_core.IResolvable] Attribute OrderIds: The order id list.
props MyBaseProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


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_instance_idsRequired

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

Attribute InstanceIds: The instance id list of created ecs instances.


attr_order_idsRequired

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

Attribute OrderIds: The order id list.


propsRequired

props: MyBaseProps