Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::ECS::Instance.

Initializers

import ros_cdk_ecs
ros_cdk_ecs.Instance(
  scope: Construct,
  id: str,
  instance_type: typing.Union[str, IResolvable],
  affinity: typing.Union[str, IResolvable] = None,
  allocate_public_ip: typing.Union[bool, IResolvable] = None,
  auto_renew: typing.Union[str, IResolvable] = None,
  auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  credit_specification: typing.Union[str, IResolvable] = None,
  dedicated_host_id: typing.Union[str, IResolvable] = None,
  deletion_protection: typing.Union[bool, IResolvable] = None,
  deployment_set_group_no: typing.Union[typing.Union[int, float], IResolvable] = None,
  deployment_set_id: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  disk_mappings: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DiskMappingsProperty]]] = None,
  host_name: typing.Union[str, IResolvable] = None,
  hpc_cluster_id: typing.Union[str, IResolvable] = None,
  http_endpoint: typing.Union[str, IResolvable] = None,
  http_tokens: typing.Union[str, IResolvable] = None,
  image_family: typing.Union[str, IResolvable] = None,
  image_id: typing.Union[str, IResolvable] = None,
  instance_charge_type: typing.Union[str, IResolvable] = None,
  instance_name: 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,
  io_optimized: typing.Union[str, IResolvable] = None,
  key_pair_name: typing.Union[str, IResolvable] = None,
  password: typing.Union[str, IResolvable] = None,
  password_inherit: typing.Union[bool, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  private_ip_address: typing.Union[str, IResolvable] = None,
  private_pool_options: typing.Union[IResolvable, PrivatePoolOptionsProperty] = None,
  ram_role_name: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_enhancement_strategy: typing.Union[str, IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  security_group_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  spot_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  spot_interruption_behavior: typing.Union[str, IResolvable] = None,
  spot_price_limit: typing.Union[str, IResolvable] = None,
  spot_strategy: typing.Union[str, IResolvable] = None,
  storage_set_id: typing.Union[str, IResolvable] = None,
  storage_set_partition_number: typing.Union[typing.Union[int, float], IResolvable] = None,
  subscription_deletion_force: typing.Union[bool, IResolvable] = None,
  system_disk_category: typing.Union[str, IResolvable] = None,
  system_disk_description: typing.Union[str, IResolvable] = None,
  system_disk_disk_name: typing.Union[str, IResolvable] = None,
  system_disk_performance_level: typing.Union[str, IResolvable] = None,
  system_disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  tenancy: typing.Union[str, IResolvable] = None,
  use_additional_service: typing.Union[bool, IResolvable] = None,
  user_data: typing.Union[str, IResolvable] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None,
  zone_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

instance_type^Required

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

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

affinity^Optional

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

Property affinity: Specifies whether to associate the instance on a dedicated host with the dedicated host.

Valid values:

• default: does not associate the ECS instance with the dedicated host. When you start an instance that was stopped in economical mode, the instance is automatically deployed to another dedicated host in the automatic deployment resource pool if the available resources of the original dedicated host are insufficient.
• host: associates the ECS instance with the dedicated host. When you start an instance that was stopped in economical mode, the instance remains on the original dedicated host. If the available resources of the original dedicated host are insufficient, the instance cannot start. Default value: default.

allocate_public_ip^Optional

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

Property allocatePublicIp: The public ip for ecs instance, if properties is true, will allocate public ip.

If property InternetMaxBandwidthOut set to 0, it will not assign public ip.

auto_renew^Optional

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

Property autoRenew: Whether renew the fee automatically?

When the parameter InstanceChargeType is PrePaid, it will take effect. Range of value:True: automatic renewal.False: no automatic renewal. Default 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.

When the parameter InstanceChargeType is PrePaid, it will take effect.It could be 1, 2, 3, 6, 12, 24, 36, 48, 60. Default value is 1.

credit_specification^Optional

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

Property creditSpecification: The performance mode of the burstable instance.

Valid values:

• Standard: the standard mode.
• Unlimited: the unlimited mode.

dedicated_host_id^Optional

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

Property dedicatedHostId: The ID of the dedicated host.

You can call the DescribeDedicatedHosts operation to query the list of dedicated host IDs.

Spot instances cannot be created on dedicated hosts. If you specify DedicatedHostId, SpotStrategy and SpotPriceLimit are automatically ignored.

deletion_protection^Optional

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

Property deletionProtection: Whether an instance can be released manually through the console or API, deletion protection only support postPaid instance.

deployment_set_group_no^Optional

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

Property deploymentSetGroupNo: The number of the deployment set group to which to deploy the instance.

If the deployment set specified by DeploymentSetId uses the high availability group strategy (AvailabilityGroup), you can use DeploymentSetGroupNo to specify a deployment set group in the deployment set. Valid values: 1 to 7.

deployment_set_id^Optional

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

Property deploymentSetId: Deployment set ID.

description^Optional

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

Property description: Description of the instance, [2, 256] characters.

Do not fill or empty, the default is empty.

disk_mappings^Optional

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

Property diskMappings: Disk mappings to attach to instance.

Max support 16 disks. If the image contains a data disk, you can specify other parameters of the data disk via the same value of parameter "Device". If parameter "Category" is not specified, it will be cloud_efficiency instead of "Category" of data disk in the image.

host_name^Optional

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

Property hostName: Host name of created ecs instance.

at least 2 characters, and '.' '-' Is not the first and last characters as hostname, not continuous use. Windows platform can be up to 15 characters, allowing letters (without limiting case), numbers and '-', and does not support the number of points, not all is digital ('.').Other (Linux, etc.) platform up to 64 characters, allowing support number multiple points for the period between the points, each permit letters (without limiting case), numbers and '-' components.

hpc_cluster_id^Optional

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

Property hpcClusterId: The ID of the high performance computing (HPC) cluster to which the instance belongs.

This parameter is required when you create instances of a Supper Computing Cluster (SCC) instance type. For information about how to create an HPC cluster, see CreateHpcCluster.

http_endpoint^Optional

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

Property httpEndpoint: Specifies whether the access channel is enabled for instance metadata.

Valid values:

• enabled
• disabled Default value: enabled.

http_tokens^Optional

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

Property httpTokens: Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata.

Valid values:

• optional: does not forcefully use the security-enhanced mode (IMDSv2).
• required: forcefully uses the security-enhanced mode (IMDSv2). After you set this parameter to required, you cannot access instance metadata in normal mode. Default value: optional.

image_family^Optional

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

Property imageFamily: The name of the image family.

You can set this parameter to obtain the latest available custom image from the specified image family to create the instance.

• ImageFamily must be empty if ImageId is specified.
• ImageFamily can be specified if ImageId is not specified.

image_id^Optional

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

Property imageId: The image ID.

def to_string() -> str

def synthesize(
  session: ISynthesisSession
) -> None

def add_condition(
  condition: RosCondition
) -> None

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

def add_dependency(
  resource: Resource
) -> None

def add_resource_desc(
  desc: str
) -> None

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

def fetch_condition() -> RosCondition

def fetch_dependency() -> typing.List[str]

def fetch_resource_desc() -> str

def get_att(
  name: str
) -> IResolvable

def set_metadata(
  key: str,
  value: typing.Any
) -> None

def add_security_groups(
  security_groups: typing.Union[str, SecurityGroup]
) -> None

def add_user_data_commands(
  commands: typing.Union[str, IResolvable]
) -> None

def auto_create_dependencies(
  zone_id: typing.Union[str, IResolvable] = None,
  vpc_cidr_block: str = None,
  v_switch_cidr_block: str = None,
  whether_create_security_group: bool = None
) -> typing.List[typing.Any]

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

node: ConstructNode

env: IResourceEnvironment

ref: str

stack: Stack

resource: RosResource

attr_host_name: typing.Union[str, IResolvable]

attr_inner_ip: typing.Union[str, IResolvable]

attr_instance_id: typing.Union[str, IResolvable]

attr_primary_network_interface_id: typing.Union[str, IResolvable]

attr_private_ip: typing.Union[str, IResolvable]

attr_public_ip: typing.Union[str, IResolvable]

attr_security_group_ids: typing.Union[str, IResolvable]

attr_zone_id: typing.Union[str, IResolvable]

props: InstanceProps