Skip to content

ScalingConfiguration

This class encapsulates and extends the ROS resource type ALIYUN::ESS::ScalingConfiguration, which is used to create a scaling configuration for a scaling group.

Initializers 

import ros_cdk_ess
ros_cdk_ess.ScalingConfiguration(
  scope: Construct,
  id: str,
  scaling_group_id: typing.Union[str, IResolvable],
  affinity: typing.Union[str, IResolvable] = None,
  cpu: typing.Union[typing.Union[int, float], IResolvable] = None,
  credit_specification: typing.Union[str, IResolvable] = None,
  dedicated_host_id: typing.Union[str, IResolvable] = None,
  deployment_set_id: 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,
  image_family: typing.Union[str, IResolvable] = None,
  image_id: typing.Union[str, IResolvable] = None,
  image_name: typing.Union[str, IResolvable] = None,
  image_options_login_as_non_root: typing.Union[bool, IResolvable] = None,
  instance_description: typing.Union[str, IResolvable] = None,
  instance_id: typing.Union[str, IResolvable] = None,
  instance_name: typing.Union[str, IResolvable] = None,
  instance_pattern_infos: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, InstancePatternInfosProperty]]] = None,
  instance_type: typing.Union[str, IResolvable] = None,
  instance_type_overrides: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, InstanceTypeOverridesProperty]]] = None,
  instance_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  internet_charge_type: typing.Union[str, IResolvable] = None,
  internet_max_bandwidth_in: typing.Union[typing.Union[int, float], IResolvable] = None,
  internet_max_bandwidth_out: typing.Union[typing.Union[int, float], IResolvable] = None,
  io_optimized: typing.Union[str, IResolvable] = None,
  ipv6_address_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  key_pair_name: typing.Union[str, IResolvable] = None,
  load_balancer_weight: typing.Union[typing.Union[int, float], IResolvable] = None,
  memory: typing.Union[typing.Union[int, float], IResolvable] = None,
  password: typing.Union[str, IResolvable] = None,
  password_inherit: typing.Union[bool, 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,
  scaling_configuration_name: 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[typing.Union[int, float], IResolvable] = None,
  spot_price_limit_for_instance_type: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  spot_strategy: typing.Union[str, IResolvable] = None,
  system_disk_auto_snapshot_policy_id: typing.Union[str, IResolvable] = None,
  system_disk_bursting_enabled: typing.Union[bool, IResolvable] = None,
  system_disk_categories: typing.Union[IResolvable, typing.List[typing.Union[str, 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_encrypt_algorithm: typing.Union[str, IResolvable] = None,
  system_disk_encrypted: typing.Union[bool, IResolvable] = None,
  system_disk_kms_key_id: typing.Union[str, IResolvable] = None,
  system_disk_performance_level: typing.Union[str, IResolvable] = None,
  system_disk_provisioned_iops: typing.Union[typing.Union[int, float], IResolvable] = None,
  system_disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  tag_list: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, TagListProperty]]] = None,
  tenancy: typing.Union[str, IResolvable] = None,
  user_data: typing.Union[str, IResolvable] = None,
  zone_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.
scaling_group_id typing.Union[str, ros_cdk_core.IResolvable] Property scalingGroupId: Scaling group id to create the scaling configuration.
affinity typing.Union[str, ros_cdk_core.IResolvable] Property affinity: Specifies whether to associate an ECS instance on a dedicated host with the dedicated host.
cpu typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property cpu: The number of vCPUs.
credit_specification typing.Union[str, ros_cdk_core.IResolvable] Property creditSpecification: The performance mode of the burstable instance.
dedicated_host_id typing.Union[str, ros_cdk_core.IResolvable] Property dedicatedHostId: The ID of the dedicated host on which you want to create an ECS instance.
deployment_set_id typing.Union[str, ros_cdk_core.IResolvable] Property deploymentSetId: Deployment set ID.
disk_mappings typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DiskMappingsProperty]]] Property diskMappings: Disk mappings to attach to instance.
host_name typing.Union[str, ros_cdk_core.IResolvable] Property hostName: The hostname of the ECS instance.
hpc_cluster_id typing.Union[str, ros_cdk_core.IResolvable] Property hpcClusterId: The HPC cluster ID to which the instance belongs.
image_family typing.Union[str, ros_cdk_core.IResolvable] Property imageFamily: The name of the image family.
image_id typing.Union[str, ros_cdk_core.IResolvable] Property imageId: Image ID to create ecs instance .
image_name typing.Union[str, ros_cdk_core.IResolvable] Property imageName: The name of the image.
image_options_login_as_non_root typing.Union[bool, ros_cdk_core.IResolvable] Property imageOptionsLoginAsNonRoot: Whether the ecs instance is logged in as ecs-user.Valid values: - true - false Default value: false.
instance_description typing.Union[str, ros_cdk_core.IResolvable] Property instanceDescription: The description of the ECS instance.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: Source ECS instance to copy configuration, if the properties is setting, Which will copy the InstanceType, ImageId, InternetChargeType, IoOptimized,UserData, KeyPairName, RamRoleName, InternetMaxBandwidthIn,InternetMaxBandwidthOut, and first security group id from source instance, you can also specify the relative properties to overwrite the properties copy from source instance id.
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: The name of the instance launched from the current scaling configuration.
instance_pattern_infos typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, InstancePatternInfosProperty]]] Property instancePatternInfos: Details of the intelligent configuration settings that determine the range of instance types that meet the specified criteria.
instance_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceType: ecs supported instance type.
instance_type_overrides typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, InstanceTypeOverridesProperty]]] Property instanceTypeOverrides: The instance types.
instance_types typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property instanceTypes: ecs supported instance types.
internet_charge_type typing.Union[str, ros_cdk_core.IResolvable] Property internetChargeType: Instance internet access charge type.Support 'PayByBandwidth' and 'PayByTraffic' only.
internet_max_bandwidth_in typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property internetMaxBandwidthIn: Maximum incoming bandwidth from the public network, measured in Mbps (Mega bit per second).
internet_max_bandwidth_out typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property internetMaxBandwidthOut: Maximum outgoing bandwidth from the public network, measured in Mbps (Mega bit per second).
io_optimized typing.Union[str, ros_cdk_core.IResolvable] Property ioOptimized: The 'optimized' instance can provide better IO performance.
ipv6_address_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property ipv6AddressCount: The number of randomly generated IPv6 addresses to be assigned to the elastic network interface (ENI).
key_pair_name typing.Union[str, ros_cdk_core.IResolvable] Property keyPairName: SSH key pair name.
load_balancer_weight typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property loadBalancerWeight: The weight of the ECS instance as a backend server.
memory typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property memory: The memory size.
password typing.Union[str, ros_cdk_core.IResolvable] Property password: Password of created ecs instance.
password_inherit typing.Union[bool, ros_cdk_core.IResolvable] Property passwordInherit: Whether to use the password pre-configured in the image you select or not.
private_pool_options typing.Union[ros_cdk_core.IResolvable, PrivatePoolOptionsProperty] Property privatePoolOptions: Option settings for private pools.
ram_role_name typing.Union[str, ros_cdk_core.IResolvable] Property ramRoleName: Instance RAM role name.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group id.
scaling_configuration_name typing.Union[str, ros_cdk_core.IResolvable] Property scalingConfigurationName: Name of created scaling configuration.
security_enhancement_strategy typing.Union[str, ros_cdk_core.IResolvable] Property securityEnhancementStrategy: Specifies whether to enable security hardening.
security_group_id typing.Union[str, ros_cdk_core.IResolvable] Property securityGroupId: Security Group to create ecs instance.
security_group_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property securityGroupIds: The IDs of the security groups with which you want to associate the ECS instances that are created by using the scaling configuration.
spot_duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property spotDuration: The retention period of the preemptible instance.
spot_interruption_behavior typing.Union[str, ros_cdk_core.IResolvable] Property spotInterruptionBehavior: The interruption mode of the preemptible instance.
spot_price_limit typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property spotPriceLimit: Set the hourly maximum price for the instance.
spot_price_limit_for_instance_type typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property spotPriceLimitForInstanceType: Set the hourly maximum price for the instance of specified instance type.
spot_strategy typing.Union[str, ros_cdk_core.IResolvable] Property spotStrategy: Preemption strategy for post-paid instances.
system_disk_auto_snapshot_policy_id typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskAutoSnapshotPolicyId: Auto snapshot policy ID.
system_disk_bursting_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property systemDiskBurstingEnabled: Specifies whether to enable the burst feature for the system disk.
system_disk_categories typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property systemDiskCategories: The categories of the system disks.
system_disk_category typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskCategory: Category of system disk.
system_disk_description typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskDescription: The description of the system disk.
system_disk_disk_name typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskDiskName: The name of the system disk.
system_disk_encrypt_algorithm typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskEncryptAlgorithm: The encryption algorithm that you want to use to encrypt the system disk.
system_disk_encrypted typing.Union[bool, ros_cdk_core.IResolvable] Property systemDiskEncrypted: Specifies whether to encrypt the system disk.
system_disk_kms_key_id typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskKmsKeyId: The ID of the KMS key that you want to use to encrypt the system disk.
system_disk_performance_level typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskPerformanceLevel: The performance level of an ESSD.
system_disk_provisioned_iops typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property systemDiskProvisionedIops: The IOPS metric that is preconfigured for the system disk.
system_disk_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property systemDiskSize: Size of system disk.
tag_list typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, TagListProperty]]] Property tagList: The tags of an instance in list format.
tenancy typing.Union[str, ros_cdk_core.IResolvable] Property tenancy: Specifies whether to create an ECS instance on a dedicated host.
user_data typing.Union[str, ros_cdk_core.IResolvable] Property userData: User data to pass to instance.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The zone ID of the ECS instance.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

scaling_group_idRequired

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

Property scalingGroupId: Scaling group id to create the scaling configuration.

affinityOptional

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

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

Valid values:

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

cpuOptional

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

Property cpu: The number of vCPUs.

You can specify the number of vCPUs and the memory size to determine the range of instance types. For example, you can set CPU to 2 and Memory to 16 to specify instance types that have 2 vCPUs and 16 GiB of memory. If you specify Cpu and Memory, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates instances by using the lowest-priced instance type. Note: You can specify Cpu and Memory to determine the range of instance types only if you set Scaling Policy to Cost Optimization Policy and you do not specify instance types in the scaling configuration.

credit_specificationOptional

  • 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_idOptional

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

Property dedicatedHostId: The ID of the dedicated host on which you want to create an ECS instance.

You cannot create preemptible instances on dedicated hosts. If you specify DedicatedHostId, SpotStrategy and SpotPriceLimit are ignored. You can call the DescribeDedicatedHosts operation to query dedicated host IDs.

deployment_set_idOptional

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

Property deploymentSetId: Deployment set ID.

disk_mappingsOptional

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

Property diskMappings: Disk mappings to attach to instance.

host_nameOptional

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

Property hostName: The hostname of the ECS instance.

The hostname cannot start or end with a period (.) or a hyphen (-). The hostname cannot contain consecutive periods (.) or hyphens (-). Naming conventions for different types of instances: Windows instances: The hostname must be 2 to 15 characters in length, and can contain letters, digits, and hyphens (-). The hostname cannot contain periods (.) or contain only digits. Other instances such as Linux instances: The hostname must be 2 to 64 characters in length. You can use periods (.) to separate a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).

hpc_cluster_idOptional

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

Property hpcClusterId: The HPC cluster ID to which the instance belongs.

image_familyOptional

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

Property imageFamily: The name of the image family.

You can configure this parameter to obtain the latest available images within the specified image family. The images are used to create ECS instances. If you have set the ImageId parameter, you cannot set the ImageFamily parameter.

image_idOptional

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

Property imageId: Image ID to create ecs instance .

image_nameOptional

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

Property imageName: The name of the image.

Each image name must be unique in a region. If you specify ImageId, ImageName is ignored. You cannot use ImageName to specify images that are purchased from Alibaba Cloud Marketplace.

image_options_login_as_non_rootOptional

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

Property imageOptionsLoginAsNonRoot: Whether the ecs instance is logged in as ecs-user.Valid values: - true - false Default value: false.

instance_descriptionOptional

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

Property instanceDescription: The description of the ECS instance.

The description must be 2 to 256 characters in length. The description can contain letters and cannot start with http:// or https://.

instance_idOptional

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

Property instanceId: Source ECS instance to copy configuration, if the properties is setting, Which will copy the InstanceType, ImageId, InternetChargeType, IoOptimized,UserData, KeyPairName, RamRoleName, InternetMaxBandwidthIn,InternetMaxBandwidthOut, and first security group id from source instance, you can also specify the relative properties to overwrite the properties copy from source instance id.

instance_nameOptional

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

Property instanceName: The name of the instance launched from the current scaling configuration.

instance_pattern_infosOptional

Property instancePatternInfos: Details of the intelligent configuration settings that determine the range of instance types that meet the specified criteria.

instance_typeOptional

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

Property instanceType: ecs supported instance type.

instance_type_overridesOptional

Property instanceTypeOverrides: The instance types.

instance_typesOptional

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

Property instanceTypes: ecs supported instance types.

Length [1,10]. If InstanceTypes is specified,the InstanceType will be ignored.

internet_charge_typeOptional

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

Property internetChargeType: Instance internet access charge type.Support 'PayByBandwidth' and 'PayByTraffic' only.

internet_max_bandwidth_inOptional

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

Property internetMaxBandwidthIn: Maximum incoming bandwidth from the public network, measured in Mbps (Mega bit per second).

The value range is [1,200]. If this parameter value is not specified, AliyunAPI automatically sets the value to 200 Mbps.

internet_max_bandwidth_outOptional

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

Property internetMaxBandwidthOut: Maximum outgoing bandwidth from the public network, measured in Mbps (Mega bit per second).

The value range for PayByBandwidth is [0,100]. If this parameter value is not specified, AliyunAPI automatically sets the value to 0 Mbps. The value range for PayByTraffic is [0,100]. If this parameter value is not specified, an error is reported

io_optimizedOptional

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

Property ioOptimized: The 'optimized' instance can provide better IO performance.

Support 'none' and 'optimized' only, default is 'none'.

ipv6_address_countOptional

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

Property ipv6AddressCount: The number of randomly generated IPv6 addresses to be assigned to the elastic network interface (ENI).

key_pair_nameOptional

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

Property keyPairName: SSH key pair name.

load_balancer_weightOptional

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

Property loadBalancerWeight: The weight of the ECS instance as a backend server.

Valid values: 1 to 100. Default value: 50.

memoryOptional

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

Property memory: The memory size.

Unit: GiB. You can specify the number of vCPUs and the memory size to determine the range of instance types. For example, you can set Cpu to 2 and Memory to 16 to specify instance types that have 2 vCPUs and 16 GiB of memory. If you specify Cpu and Memory, Auto Scaling determines the available instance types based on factors such as I/O optimization requirements and zones. Then, Auto Scaling preferentially creates instances by using the lowest-priced instance type. Note: You can specify Cpu and Memory to determine the range of instance types only if you set Scaling Policy to Cost Optimization Policy and you do not specify instance types in the scaling configuration.

passwordOptional

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

Property password: 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 use the password pre-configured in the image you select or not.

When PasswordInherit is specified, the Password must be null. For a secure access, make sure that the selected image has password configured.

private_pool_optionsOptional

Property privatePoolOptions: Option settings for private pools.

ram_role_nameOptional

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

Property ramRoleName: Instance RAM role name.

The name is provided and maintained by Resource Access Management (RAM) and can be queried using ListRoles. For more information, see RAM API CreateRole and ListRoles.

resource_group_idOptional

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

Property resourceGroupId: Resource group id.

scaling_configuration_nameOptional

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

Property scalingConfigurationName: Name of created scaling configuration.

security_enhancement_strategyOptional

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

Property securityEnhancementStrategy: Specifies whether to enable security hardening.

Valid values:

  • Active: enables security hardening. This value is applicable only to public images.
  • Deactive: disables security hardening. This value is applicable to all image types.

security_group_idOptional

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

Property securityGroupId: Security Group to create ecs instance.

security_group_idsOptional

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

Property securityGroupIds: The IDs of the security groups with which you want to associate the ECS instances that are created by using the scaling configuration.

Note: If you specify SecurityGroupId, you cannot specify SecurityGroupIds.

spot_durationOptional

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

Property spotDuration: The retention period of the preemptible instance.

Unit: hours. Valid values: 0, 1, 2, 3, 4, 5, and 6. The following retention periods are available in invitational preview: 2, 3, 4, 5, and 6 hours. If you want to set this parameter to one of these values, submit a ticket. If you set this parameter to 0, no protection period is specified for the preemptible instance. Default value: 1

spot_interruption_behaviorOptional

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

Property spotInterruptionBehavior: The interruption mode of the preemptible instance.

Default value: Terminate. Set the value to Terminate. This value specifies that the preemptible instance is to be released.

spot_price_limitOptional

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

Property spotPriceLimit: Set the hourly maximum price for the instance.

Supports a maximum of 3 decimal places, and the parameter takes effect only when the value of SpotStrategy is SpotWithPriceLimit.It is a default value for all instance types, and can be overwrite by SpotPriceLimitForInstanceType

spot_price_limit_for_instance_typeOptional

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

Property spotPriceLimitForInstanceType: Set the hourly maximum price for the instance of specified instance type.

The parameter takes effect only when the value of SpotStrategy is SpotWithPriceLimit. You should input the information of the tag with the format of the Key-Value, such as {"key1":"value1","key2":"value2", ... "key5":"value5"}. At most 50 items can be specified. Key ecs instance type Value Supports a maximum of 3 decimal places.

spot_strategyOptional

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

Property spotStrategy: Preemption strategy for post-paid instances.

It takes effect when the parameter InstanceChargeType takes the value of PostPaid. Ranges: NoSpot: Normal pay-per-use instance SpotWithPriceLimit: Set a preemptive instance of the cap price SpotAsPriceGo: System automatic bidding, following the current market actual price Default: NoSpot.

system_disk_auto_snapshot_policy_idOptional

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

Property systemDiskAutoSnapshotPolicyId: Auto snapshot policy ID.

system_disk_bursting_enabledOptional

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

Property systemDiskBurstingEnabled: Specifies whether to enable the burst feature for the system disk.

Valid values:

  • true
  • false Note: This parameter is available only if you set SystemDiskCategory to cloud_auto.

system_disk_categoriesOptional

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

Property systemDiskCategories: The categories of the system disks.

If Auto Scaling cannot create instances by using the disk category that has the highest priority, Auto Scaling creates instances by using the disk category that has the next highest priority. Valid values:

  • cloud: basic disk
  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • cloud_essd: ESSD Note: If you specify SystemDiskCategories, you cannot specify SystemDiskCategory.

system_disk_categoryOptional

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

Property systemDiskCategory: Category of system disk.

Default is cloud.support cloud|cloud_efficiency|cloud_ssd|cloud_essd|ephemeral_ssd|cloud_auto

system_disk_descriptionOptional

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

Property systemDiskDescription: The description of the system disk.

The description must be 2 to 256 characters in length. The description can contain letters and cannot start with http:// or https://.

system_disk_disk_nameOptional

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

Property systemDiskDiskName: The name of the system disk.

The name must be 2 to 128 characters in length. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter but cannot start with http:// or https://.

system_disk_encrypt_algorithmOptional

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

Property systemDiskEncryptAlgorithm: The encryption algorithm that you want to use to encrypt the system disk.

Valid values:

  • AES-256
  • SM4-128 Default value: AES-256

system_disk_encryptedOptional

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

Property systemDiskEncrypted: Specifies whether to encrypt the system disk.

Valid values:

  • true
  • false Default value: false

system_disk_kms_key_idOptional

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

Property systemDiskKmsKeyId: The ID of the KMS key that you want to use to encrypt the system disk.

system_disk_performance_levelOptional

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

Property systemDiskPerformanceLevel: The performance level of an ESSD.

system_disk_provisioned_iopsOptional

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

Property systemDiskProvisionedIops: The IOPS metric that is preconfigured for the system disk.

Note: IOPS measures the number of read and write operations that an EBS device can process per second.

system_disk_sizeOptional

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

Property systemDiskSize: Size of system disk.

Unit is GB.

tag_listOptional

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

Property tagList: The tags of an instance in list format.

Do not use with Tags at the same time. You should input the information of the tag with the format of Key-Value list, such as [{"Key":"key1","Value":"value1"}, ...]. At most 20 tags can be specified. Key It can be up to 64 characters in length. Cannot begin with aliyun. Cannot begin with http:// or https://. Cannot be a null string. Value It can be up to 128 characters in length. Cannot begin with aliyun. Cannot begin with http:// or https://. Can be a null string.If less then 20 tags are specified, ros will add a tag(Key: "ros-aliyun-created", Value:"stack") if possible.

tenancyOptional

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

Property tenancy: Specifies whether to create an ECS instance on a dedicated host.

Valid values:

  • default: does not create an ECS instance on a dedicated host.
  • host: creates an ECS instance on a dedicated host. If you do not specify DedicatedHostId, Alibaba Cloud selects a dedicated host for the ECS instance. Default value: default

user_dataOptional

  • 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.

zone_idOptional

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

Property zoneId: The zone ID 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.
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_ess
ros_cdk_ess.ScalingConfiguration.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_scaling_configuration_id ros_cdk_core.IResolvable Attribute ScalingConfigurationId: The scaling configuration id.
attr_scaling_group_id ros_cdk_core.IResolvable Attribute ScalingGroupId: The id of the scaling group to which the scaling configuration belongs.

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_scaling_configuration_idRequired 

attr_scaling_configuration_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ScalingConfigurationId: The scaling configuration id.

attr_scaling_group_idRequired 

attr_scaling_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ScalingGroupId: The id of the scaling group to which the scaling configuration belongs.