Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::ENS::Instance, which is used to create Edge Node Service (ENS) instances.

Initializers

import ros_cdk_ens
ros_cdk_ens.Instance(
  scope: Construct,
  id: str,
  data_disk_size: typing.Union[typing.Union[int, float], IResolvable],
  ens_region_id: typing.Union[str, IResolvable],
  image_id: typing.Union[str, IResolvable],
  instance_type: typing.Union[str, IResolvable],
  period: typing.Union[typing.Union[int, float], IResolvable],
  quantity: typing.Union[typing.Union[int, float], IResolvable],
  system_disk_size: typing.Union[typing.Union[int, float], IResolvable],
  auto_renew: typing.Union[str, IResolvable] = None,
  auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  host_name: typing.Union[str, IResolvable] = None,
  instance_name: typing.Union[str, IResolvable] = None,
  internet_charge_type: typing.Union[str, IResolvable] = None,
  ip_type: typing.Union[str, IResolvable] = None,
  key_pair_name: typing.Union[str, IResolvable] = None,
  password: typing.Union[str, IResolvable] = None,
  payment_type: typing.Union[str, IResolvable] = None,
  private_ip_address: typing.Union[str, IResolvable] = None,
  unique_suffix: typing.Union[bool, IResolvable] = None,
  user_data: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

data_disk_size^Required

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

Property dataDiskSize: Disk size of the system disk, range from 20 to 500 GB.

If you specify with your own image, make sure the system disk size bigger than image size.

ens_region_id^Required

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

Property ensRegionId: ENS Region Id.

image_id^Required

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

Property imageId: Image ID to create ens instance.

instance_type^Required

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

Property instanceType: ENS instance supported instance type, make sure it should be correct.

period^Required

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

Property period: Prepaid time period.

Unit is month, it could be from 1 to 9 or 12. Default value is 1.

quantity^Required

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

Property quantity: number of instances to create.

system_disk_size^Required

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

Property systemDiskSize: Disk size of the system disk.

auto_renew^Optional

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

Property autoRenew: Whether renew the fee automatically?it could be True,FalseDefault value is False.

auto_renew_period^Optional

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

Property autoRenewPeriod: The time period of auto renew.

it will take effect.It could be 1, 2, 3, 6, 12. Default value is 1.

host_name^Optional

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

Property hostName: The hostname of the instance.

instance_name^Optional

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

Property instanceName: Instance name.

internet_charge_type^Optional

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

Property internetChargeType: Instance Charge type.it could be 95BandwidthByMonth, PayByBandwidth4thMonth.

ip_type^Optional

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

Property ipType: ip type, It could be ipv4Andipv6,ipv4,ipv6.default value isi pv4.

key_pair_name^Optional

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

Property keyPairName: SSH key pair name.

password^Optional

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

Property password: Password of created ens instance.

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

payment_type^Optional

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

Property paymentType: Payment Type.only support value Subscription.

private_ip_address^Optional

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

Property privateIpAddress: Private IP for the instance created.

unique_suffix^Optional

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

Property uniqueSuffix: Specifies whether to automatically append sequential suffixes to the hostnames specified by the HostName parameter and instance names specified by the InstanceName parameter when you create multiple instances at a time.

The sequential suffix ranges from 001 to 999. Valid values: true false Default value: false.

user_data^Optional

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

Property userData: User data to pass to instance.

[1, 16KB] characters.User data should not be base64 encoded. If you want to pass base64 encoded string to the property, use function Fn::Base64Decode to decode the base64 string first.

v_switch_id^Optional

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

Property vSwitchId: The vSwitch Id to create ens instance.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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

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

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

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

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_auto_renew^Required

attr_auto_renew: typing.Union[str, IResolvable]

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

Attribute AutoRenew: Whether renew the fee automatically?it could be True,FalseDefault value is False.

attr_auto_renew_period^Required

attr_auto_renew_period: typing.Union[str, IResolvable]

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

Attribute AutoRenewPeriod: The time period of auto renew.

it will take effect.It could be 1, 2, 3, 6, 12. Default value is 1.

attr_data_disk_size^Required

attr_data_disk_size: typing.Union[str, IResolvable]

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

Attribute DataDiskSize: Disk size of the system disk, range from 20 to 500 GB.

If you specify with your own image, make sure the system disk size bigger than image size.

attr_ens_region_id^Required

attr_ens_region_id: typing.Union[str, IResolvable]

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

Attribute EnsRegionId: ENS Region Id.

attr_host_name^Required

attr_host_name: typing.Union[str, IResolvable]

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

Attribute HostName: The hostname of the instance.

attr_image_id^Required

attr_image_id: typing.Union[str, IResolvable]

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

Attribute ImageId: Image ID to create ens instance.

attr_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

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

Attribute InstanceId: InstanceId.

attr_instance_name^Required

attr_instance_name: typing.Union[str, IResolvable]

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

Attribute InstanceName: Instance name.

attr_instance_type^Required

attr_instance_type: typing.Union[str, IResolvable]

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

Attribute InstanceType: ENS instance supported instance type, make sure it should be correct.

attr_internet_charge_type^Required

attr_internet_charge_type: typing.Union[str, IResolvable]

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

Attribute InternetChargeType: Instance Charge type.it could be 95BandwidthByMonth, PayByBandwidth4thMonth.

attr_ip_type^Required

attr_ip_type: typing.Union[str, IResolvable]

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

Attribute IpType: ip type, It could be ipv4Andipv6,ipv4,ipv6.default value isi pv4.

attr_key_pair_name^Required

attr_key_pair_name: typing.Union[str, IResolvable]

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

Attribute KeyPairName: SSH key pair name.

attr_payment_type^Required

attr_payment_type: typing.Union[str, IResolvable]

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

Attribute PaymentType: Payment Type.only support value Subscription.

attr_period^Required

attr_period: typing.Union[str, IResolvable]

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

Attribute Period: Prepaid time period.

Unit is month, it could be from 1 to 9 or 12. Default value is 1.

attr_private_ip_address^Required

attr_private_ip_address: typing.Union[str, IResolvable]

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

Attribute PrivateIpAddress: Private IP for the instance created.

attr_private_ips^Required

attr_private_ips: typing.Union[str, IResolvable]

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

Attribute PrivateIps: Private IP.

attr_public_ips^Required

attr_public_ips: typing.Union[str, IResolvable]

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

Attribute PublicIps: Public IP.

attr_quantity^Required

attr_quantity: typing.Union[str, IResolvable]

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

Attribute Quantity: number of instances to create.

attr_system_disk_size^Required

attr_system_disk_size: typing.Union[str, IResolvable]

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

Attribute SystemDiskSize: Disk size of the system disk.

attr_unique_suffix^Required

attr_unique_suffix: typing.Union[str, IResolvable]

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

Attribute UniqueSuffix: Specifies whether to automatically append sequential suffixes to the hostnames specified by the HostName parameter and instance names specified by the InstanceName parameter when you create multiple instances at a time.

The sequential suffix ranges from 001 to 999. Valid values: true false Default value: false.

attr_user_data^Required

attr_user_data: typing.Union[str, IResolvable]

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

Attribute UserData: User data to pass to instance.

[1, 16KB] characters.User data should not be base64 encoded. If you want to pass base64 encoded string to the property, use function Fn::Base64Decode to decode the base64 string first.

attr_v_switch_id^Required

attr_v_switch_id: typing.Union[str, IResolvable]

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

Attribute VSwitchId: The vSwitch Id to create ens instance.

props^Required

props: InstanceProps

• Type: InstanceProps