ScalingGroup

Create a ScalingGroup Resource

new ScalingGroup(name: string, args: ScalingGroupArgs, opts?: CustomResourceOptions);

def ScalingGroup(resource_name, opts=None, db_instance_ids=None, default_cooldown=None, desired_capacity=None, loadbalancer_ids=None, max_size=None, min_size=None, multi_az_policy=None, on_demand_base_capacity=None, on_demand_percentage_above_base_capacity=None, removal_policies=None, scaling_group_name=None, spot_instance_pools=None, spot_instance_remedy=None, vswitch_id=None, vswitch_ids=None, __props__=None);

func NewScalingGroup(ctx *Context, name string, args ScalingGroupArgs, opts ...ResourceOption) (*ScalingGroup, error)

public ScalingGroup(string name, ScalingGroupArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ScalingGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ScalingGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ScalingGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ScalingGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ScalingGroup resource accepts the following input properties:

MaxSize int

Maximum number of ECS instances in the scaling group. Value range: [0, 1000].

MinSize int

Minimum number of ECS instances in the scaling group. Value range: [0, 1000].

DbInstanceIds List<string>

If an RDS instance is specified in the scaling group, the scaling group automatically attaches the Intranet IP addresses of its ECS instances to the RDS access whitelist. - The specified RDS instance must be in running status. - The specified RDS instance’s whitelist must have room for more IP addresses.

DefaultCooldown int

Default cool-down time (in seconds) of the scaling group. Value range: [0, 86400]. The default value is 300s.

DesiredCapacity int

Expected number of ECS instances in the scaling group. Value range: [min_size, max_size].

LoadbalancerIds List<string>

If a Server Load Balancer instance is specified in the scaling group, the scaling group automatically attaches its ECS instances to the Server Load Balancer instance. - The Server Load Balancer instance must be enabled. - At least one listener must be configured for each Server Load Balancer and it HealthCheck must be on. Otherwise, creation will fail (it may be useful to add a depends_on argument targeting your alicloud.slb.Listener in order to make sure the listener with its HealthCheck configuration is ready before creating your scaling group). - The Server Load Balancer instance attached with VPC-type ECS instances cannot be attached to the scaling group. - The default weight of an ECS instance attached to the Server Load Balancer instance is 50.

MultiAzPolicy string

Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available in 1.54.0+).

OnDemandBaseCapacity int

The minimum amount of the Auto Scaling group’s capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

OnDemandPercentageAboveBaseCapacity int

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

RemovalPolicies List<string>

RemovalPolicy is used to select the ECS instances you want to remove from the scaling group when multiple candidates for removal exist. Optional values: - OldestInstance: removes the ECS instance that is added to the scaling group at the earliest point in time. - NewestInstance: removes the ECS instance that is added to the scaling group at the latest point in time. - OldestScalingConfiguration: removes the ECS instance that is created based on the earliest scaling configuration. - Default values: Default value of RemovalPolicy.1: OldestScalingConfiguration. Default value of RemovalPolicy.2: OldestInstance.

ScalingGroupName string

Name shown for the scaling group, which must contain 2-64 characters (English or Chinese), starting with numbers, English letters or Chinese characters, and can contain numbers, underscores _, hyphens -, and decimal points .. If this parameter is not specified, the default value is ScalingGroupId.

SpotInstancePools int

The number of Spot pools to use to allocate your Spot capacity. The Spot pools is composed of instance types of lowest price.

SpotInstanceRemedy bool

Whether to replace spot instances with newly created spot/onDemand instance when receive a spot recycling message.

VswitchId string

It has been deprecated from version 1.7.1 and new field ‘vswitch_ids’ replaces it.

Deprecated: Field 'vswitch_id' has been deprecated from provider version 1.7.1, and new field 'vswitch_ids' can replace it.

VswitchIds List<string>

List of virtual switch IDs in which the ecs instances to be launched.

MaxSize int

Maximum number of ECS instances in the scaling group. Value range: [0, 1000].

MinSize int

Minimum number of ECS instances in the scaling group. Value range: [0, 1000].

DbInstanceIds []string

DefaultCooldown int

Default cool-down time (in seconds) of the scaling group. Value range: [0, 86400]. The default value is 300s.

DesiredCapacity int

Expected number of ECS instances in the scaling group. Value range: [min_size, max_size].

LoadbalancerIds []string

MultiAzPolicy string

Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available in 1.54.0+).

OnDemandBaseCapacity int

The minimum amount of the Auto Scaling group’s capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

OnDemandPercentageAboveBaseCapacity int

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

RemovalPolicies []string

ScalingGroupName string

SpotInstancePools int

The number of Spot pools to use to allocate your Spot capacity. The Spot pools is composed of instance types of lowest price.

SpotInstanceRemedy bool

Whether to replace spot instances with newly created spot/onDemand instance when receive a spot recycling message.

VswitchId string

It has been deprecated from version 1.7.1 and new field ‘vswitch_ids’ replaces it.

Deprecated: Field 'vswitch_id' has been deprecated from provider version 1.7.1, and new field 'vswitch_ids' can replace it.

VswitchIds []string

List of virtual switch IDs in which the ecs instances to be launched.

maxSize number

Maximum number of ECS instances in the scaling group. Value range: [0, 1000].

minSize number

Minimum number of ECS instances in the scaling group. Value range: [0, 1000].

dbInstanceIds string[]

defaultCooldown number

Default cool-down time (in seconds) of the scaling group. Value range: [0, 86400]. The default value is 300s.

desiredCapacity number

Expected number of ECS instances in the scaling group. Value range: [min_size, max_size].

loadbalancerIds string[]

multiAzPolicy string

Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available in 1.54.0+).

onDemandBaseCapacity number

The minimum amount of the Auto Scaling group’s capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

onDemandPercentageAboveBaseCapacity number

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

removalPolicies string[]

scalingGroupName string

spotInstancePools number

The number of Spot pools to use to allocate your Spot capacity. The Spot pools is composed of instance types of lowest price.

spotInstanceRemedy boolean

Whether to replace spot instances with newly created spot/onDemand instance when receive a spot recycling message.

vswitchId string

It has been deprecated from version 1.7.1 and new field ‘vswitch_ids’ replaces it.

Deprecated: Field 'vswitch_id' has been deprecated from provider version 1.7.1, and new field 'vswitch_ids' can replace it.

vswitchIds string[]

List of virtual switch IDs in which the ecs instances to be launched.

max_size float

Maximum number of ECS instances in the scaling group. Value range: [0, 1000].

min_size float

Minimum number of ECS instances in the scaling group. Value range: [0, 1000].

db_instance_ids List[str]

default_cooldown float

Default cool-down time (in seconds) of the scaling group. Value range: [0, 86400]. The default value is 300s.

desired_capacity float

Expected number of ECS instances in the scaling group. Value range: [min_size, max_size].

loadbalancer_ids List[str]

multi_az_policy str

Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available in 1.54.0+).

on_demand_base_capacity float

The minimum amount of the Auto Scaling group’s capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

on_demand_percentage_above_base_capacity float

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

removal_policies List[str]

scaling_group_name str

spot_instance_pools float

The number of Spot pools to use to allocate your Spot capacity. The Spot pools is composed of instance types of lowest price.

spot_instance_remedy bool

Whether to replace spot instances with newly created spot/onDemand instance when receive a spot recycling message.

vswitch_id str

It has been deprecated from version 1.7.1 and new field ‘vswitch_ids’ replaces it.

Deprecated: Field 'vswitch_id' has been deprecated from provider version 1.7.1, and new field 'vswitch_ids' can replace it.

vswitch_ids List[str]

List of virtual switch IDs in which the ecs instances to be launched.

Outputs

All input properties are implicitly available as output properties. Additionally, the ScalingGroup resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing ScalingGroup Resource

Get an existing ScalingGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ScalingGroupState, opts?: CustomResourceOptions): ScalingGroup

static get(resource_name, id, opts=None, db_instance_ids=None, default_cooldown=None, desired_capacity=None, loadbalancer_ids=None, max_size=None, min_size=None, multi_az_policy=None, on_demand_base_capacity=None, on_demand_percentage_above_base_capacity=None, removal_policies=None, scaling_group_name=None, spot_instance_pools=None, spot_instance_remedy=None, vswitch_id=None, vswitch_ids=None, __props__=None);

func GetScalingGroup(ctx *Context, name string, id IDInput, state *ScalingGroupState, opts ...ResourceOption) (*ScalingGroup, error)

public static ScalingGroup Get(string name, Input<string> id, ScalingGroupState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DbInstanceIds List<string>

DefaultCooldown int

Default cool-down time (in seconds) of the scaling group. Value range: [0, 86400]. The default value is 300s.

DesiredCapacity int

Expected number of ECS instances in the scaling group. Value range: [min_size, max_size].

LoadbalancerIds List<string>

MaxSize int

Maximum number of ECS instances in the scaling group. Value range: [0, 1000].

MinSize int

Minimum number of ECS instances in the scaling group. Value range: [0, 1000].

MultiAzPolicy string

Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available in 1.54.0+).

OnDemandBaseCapacity int

The minimum amount of the Auto Scaling group’s capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

OnDemandPercentageAboveBaseCapacity int

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

RemovalPolicies List<string>

ScalingGroupName string

SpotInstancePools int

The number of Spot pools to use to allocate your Spot capacity. The Spot pools is composed of instance types of lowest price.

SpotInstanceRemedy bool

Whether to replace spot instances with newly created spot/onDemand instance when receive a spot recycling message.

VswitchId string

It has been deprecated from version 1.7.1 and new field ‘vswitch_ids’ replaces it.

Deprecated: Field 'vswitch_id' has been deprecated from provider version 1.7.1, and new field 'vswitch_ids' can replace it.

VswitchIds List<string>

List of virtual switch IDs in which the ecs instances to be launched.

DbInstanceIds []string

DefaultCooldown int

Default cool-down time (in seconds) of the scaling group. Value range: [0, 86400]. The default value is 300s.

DesiredCapacity int

Expected number of ECS instances in the scaling group. Value range: [min_size, max_size].

LoadbalancerIds []string

MaxSize int

Maximum number of ECS instances in the scaling group. Value range: [0, 1000].

MinSize int

Minimum number of ECS instances in the scaling group. Value range: [0, 1000].

MultiAzPolicy string

Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available in 1.54.0+).

OnDemandBaseCapacity int

The minimum amount of the Auto Scaling group’s capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

OnDemandPercentageAboveBaseCapacity int

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

RemovalPolicies []string

ScalingGroupName string

SpotInstancePools int

The number of Spot pools to use to allocate your Spot capacity. The Spot pools is composed of instance types of lowest price.

SpotInstanceRemedy bool

Whether to replace spot instances with newly created spot/onDemand instance when receive a spot recycling message.

VswitchId string

It has been deprecated from version 1.7.1 and new field ‘vswitch_ids’ replaces it.

Deprecated: Field 'vswitch_id' has been deprecated from provider version 1.7.1, and new field 'vswitch_ids' can replace it.

VswitchIds []string

List of virtual switch IDs in which the ecs instances to be launched.

dbInstanceIds string[]

defaultCooldown number

Default cool-down time (in seconds) of the scaling group. Value range: [0, 86400]. The default value is 300s.

desiredCapacity number

Expected number of ECS instances in the scaling group. Value range: [min_size, max_size].

loadbalancerIds string[]

maxSize number

Maximum number of ECS instances in the scaling group. Value range: [0, 1000].

minSize number

Minimum number of ECS instances in the scaling group. Value range: [0, 1000].

multiAzPolicy string

Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available in 1.54.0+).

onDemandBaseCapacity number

The minimum amount of the Auto Scaling group’s capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

onDemandPercentageAboveBaseCapacity number

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.

removalPolicies string[]

scalingGroupName string

spotInstancePools number

The number of Spot pools to use to allocate your Spot capacity. The Spot pools is composed of instance types of lowest price.

spotInstanceRemedy boolean

Whether to replace spot instances with newly created spot/onDemand instance when receive a spot recycling message.

vswitchId string

It has been deprecated from version 1.7.1 and new field ‘vswitch_ids’ replaces it.

Deprecated: Field 'vswitch_id' has been deprecated from provider version 1.7.1, and new field 'vswitch_ids' can replace it.

vswitchIds string[]

List of virtual switch IDs in which the ecs instances to be launched.

db_instance_ids List[str]

default_cooldown float

Default cool-down time (in seconds) of the scaling group. Value range: [0, 86400]. The default value is 300s.

desired_capacity float

Expected number of ECS instances in the scaling group. Value range: [min_size, max_size].

loadbalancer_ids List[str]

max_size float

Maximum number of ECS instances in the scaling group. Value range: [0, 1000].

min_size float

Minimum number of ECS instances in the scaling group. Value range: [0, 1000].

multi_az_policy str

Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available in 1.54.0+).

on_demand_base_capacity float

The minimum amount of the Auto Scaling group’s capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

on_demand_percentage_above_base_capacity float