1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. ess
  5. ScalingGroup
Alibaba Cloud v3.51.0 published on Saturday, Mar 23, 2024 by Pulumi

alicloud.ess.ScalingGroup

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.51.0 published on Saturday, Mar 23, 2024 by Pulumi

    Provides a ESS scaling group resource which is a collection of ECS instances with the same application scenarios.

    It defines the maximum and minimum numbers of ECS instances in the group, and their associated Server Load Balancer instances, RDS instances, and other attributes.

    NOTE: You can launch an ESS scaling group for a VPC network via specifying parameter vswitch_ids.

    For information about ess scaling rule, see CreateScalingGroup.

    NOTE: Available since v1.39.0.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    import * as random from "@pulumi/random";
    
    const config = new pulumi.Config();
    const name = config.get("name") || "terraform-example";
    const defaultRandomInteger = new random.RandomInteger("defaultRandomInteger", {
        min: 10000,
        max: 99999,
    });
    const myName = pulumi.interpolate`${name}-${defaultRandomInteger.result}`;
    const defaultZones = alicloud.getZones({
        availableDiskCategory: "cloud_efficiency",
        availableResourceCreation: "VSwitch",
    });
    const defaultInstanceTypes = defaultZones.then(defaultZones => alicloud.ecs.getInstanceTypes({
        availabilityZone: defaultZones.zones?.[0]?.id,
        cpuCoreCount: 2,
        memorySize: 4,
    }));
    const defaultImages = alicloud.ecs.getImages({
        nameRegex: "^ubuntu_18.*64",
        mostRecent: true,
        owners: "system",
    });
    const defaultNetwork = new alicloud.vpc.Network("defaultNetwork", {
        vpcName: myName,
        cidrBlock: "172.16.0.0/16",
    });
    const defaultSwitch = new alicloud.vpc.Switch("defaultSwitch", {
        vpcId: defaultNetwork.id,
        cidrBlock: "172.16.0.0/24",
        zoneId: defaultZones.then(defaultZones => defaultZones.zones?.[0]?.id),
        vswitchName: myName,
    });
    const defaultSecurityGroup = new alicloud.ecs.SecurityGroup("defaultSecurityGroup", {vpcId: defaultNetwork.id});
    const defaultSecurityGroupRule = new alicloud.ecs.SecurityGroupRule("defaultSecurityGroupRule", {
        type: "ingress",
        ipProtocol: "tcp",
        nicType: "intranet",
        policy: "accept",
        portRange: "22/22",
        priority: 1,
        securityGroupId: defaultSecurityGroup.id,
        cidrIp: "172.16.0.0/24",
    });
    const default2 = new alicloud.vpc.Switch("default2", {
        vpcId: defaultNetwork.id,
        cidrBlock: "172.16.1.0/24",
        zoneId: defaultZones.then(defaultZones => defaultZones.zones?.[0]?.id),
        vswitchName: `${name}-bar`,
    });
    const defaultScalingGroup = new alicloud.ess.ScalingGroup("defaultScalingGroup", {
        minSize: 1,
        maxSize: 1,
        scalingGroupName: myName,
        defaultCooldown: 20,
        vswitchIds: [
            defaultSwitch.id,
            default2.id,
        ],
        removalPolicies: [
            "OldestInstance",
            "NewestInstance",
        ],
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    import pulumi_random as random
    
    config = pulumi.Config()
    name = config.get("name")
    if name is None:
        name = "terraform-example"
    default_random_integer = random.RandomInteger("defaultRandomInteger",
        min=10000,
        max=99999)
    my_name = default_random_integer.result.apply(lambda result: f"{name}-{result}")
    default_zones = alicloud.get_zones(available_disk_category="cloud_efficiency",
        available_resource_creation="VSwitch")
    default_instance_types = alicloud.ecs.get_instance_types(availability_zone=default_zones.zones[0].id,
        cpu_core_count=2,
        memory_size=4)
    default_images = alicloud.ecs.get_images(name_regex="^ubuntu_18.*64",
        most_recent=True,
        owners="system")
    default_network = alicloud.vpc.Network("defaultNetwork",
        vpc_name=my_name,
        cidr_block="172.16.0.0/16")
    default_switch = alicloud.vpc.Switch("defaultSwitch",
        vpc_id=default_network.id,
        cidr_block="172.16.0.0/24",
        zone_id=default_zones.zones[0].id,
        vswitch_name=my_name)
    default_security_group = alicloud.ecs.SecurityGroup("defaultSecurityGroup", vpc_id=default_network.id)
    default_security_group_rule = alicloud.ecs.SecurityGroupRule("defaultSecurityGroupRule",
        type="ingress",
        ip_protocol="tcp",
        nic_type="intranet",
        policy="accept",
        port_range="22/22",
        priority=1,
        security_group_id=default_security_group.id,
        cidr_ip="172.16.0.0/24")
    default2 = alicloud.vpc.Switch("default2",
        vpc_id=default_network.id,
        cidr_block="172.16.1.0/24",
        zone_id=default_zones.zones[0].id,
        vswitch_name=f"{name}-bar")
    default_scaling_group = alicloud.ess.ScalingGroup("defaultScalingGroup",
        min_size=1,
        max_size=1,
        scaling_group_name=my_name,
        default_cooldown=20,
        vswitch_ids=[
            default_switch.id,
            default2.id,
        ],
        removal_policies=[
            "OldestInstance",
            "NewestInstance",
        ])
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ess"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
    	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		name := "terraform-example"
    		if param := cfg.Get("name"); param != "" {
    			name = param
    		}
    		defaultRandomInteger, err := random.NewRandomInteger(ctx, "defaultRandomInteger", &random.RandomIntegerArgs{
    			Min: pulumi.Int(10000),
    			Max: pulumi.Int(99999),
    		})
    		if err != nil {
    			return err
    		}
    		myName := defaultRandomInteger.Result.ApplyT(func(result int) (string, error) {
    			return fmt.Sprintf("%v-%v", name, result), nil
    		}).(pulumi.StringOutput)
    		defaultZones, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{
    			AvailableDiskCategory:     pulumi.StringRef("cloud_efficiency"),
    			AvailableResourceCreation: pulumi.StringRef("VSwitch"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = ecs.GetInstanceTypes(ctx, &ecs.GetInstanceTypesArgs{
    			AvailabilityZone: pulumi.StringRef(defaultZones.Zones[0].Id),
    			CpuCoreCount:     pulumi.IntRef(2),
    			MemorySize:       pulumi.Float64Ref(4),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = ecs.GetImages(ctx, &ecs.GetImagesArgs{
    			NameRegex:  pulumi.StringRef("^ubuntu_18.*64"),
    			MostRecent: pulumi.BoolRef(true),
    			Owners:     pulumi.StringRef("system"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		defaultNetwork, err := vpc.NewNetwork(ctx, "defaultNetwork", &vpc.NetworkArgs{
    			VpcName:   pulumi.String(myName),
    			CidrBlock: pulumi.String("172.16.0.0/16"),
    		})
    		if err != nil {
    			return err
    		}
    		defaultSwitch, err := vpc.NewSwitch(ctx, "defaultSwitch", &vpc.SwitchArgs{
    			VpcId:       defaultNetwork.ID(),
    			CidrBlock:   pulumi.String("172.16.0.0/24"),
    			ZoneId:      pulumi.String(defaultZones.Zones[0].Id),
    			VswitchName: pulumi.String(myName),
    		})
    		if err != nil {
    			return err
    		}
    		defaultSecurityGroup, err := ecs.NewSecurityGroup(ctx, "defaultSecurityGroup", &ecs.SecurityGroupArgs{
    			VpcId: defaultNetwork.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ecs.NewSecurityGroupRule(ctx, "defaultSecurityGroupRule", &ecs.SecurityGroupRuleArgs{
    			Type:            pulumi.String("ingress"),
    			IpProtocol:      pulumi.String("tcp"),
    			NicType:         pulumi.String("intranet"),
    			Policy:          pulumi.String("accept"),
    			PortRange:       pulumi.String("22/22"),
    			Priority:        pulumi.Int(1),
    			SecurityGroupId: defaultSecurityGroup.ID(),
    			CidrIp:          pulumi.String("172.16.0.0/24"),
    		})
    		if err != nil {
    			return err
    		}
    		default2, err := vpc.NewSwitch(ctx, "default2", &vpc.SwitchArgs{
    			VpcId:       defaultNetwork.ID(),
    			CidrBlock:   pulumi.String("172.16.1.0/24"),
    			ZoneId:      pulumi.String(defaultZones.Zones[0].Id),
    			VswitchName: pulumi.String(fmt.Sprintf("%v-bar", name)),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ess.NewScalingGroup(ctx, "defaultScalingGroup", &ess.ScalingGroupArgs{
    			MinSize:          pulumi.Int(1),
    			MaxSize:          pulumi.Int(1),
    			ScalingGroupName: pulumi.String(myName),
    			DefaultCooldown:  pulumi.Int(20),
    			VswitchIds: pulumi.StringArray{
    				defaultSwitch.ID(),
    				default2.ID(),
    			},
    			RemovalPolicies: pulumi.StringArray{
    				pulumi.String("OldestInstance"),
    				pulumi.String("NewestInstance"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    using Random = Pulumi.Random;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var name = config.Get("name") ?? "terraform-example";
        var defaultRandomInteger = new Random.RandomInteger("defaultRandomInteger", new()
        {
            Min = 10000,
            Max = 99999,
        });
    
        var myName = defaultRandomInteger.Result.Apply(result => $"{name}-{result}");
    
        var defaultZones = AliCloud.GetZones.Invoke(new()
        {
            AvailableDiskCategory = "cloud_efficiency",
            AvailableResourceCreation = "VSwitch",
        });
    
        var defaultInstanceTypes = AliCloud.Ecs.GetInstanceTypes.Invoke(new()
        {
            AvailabilityZone = defaultZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
            CpuCoreCount = 2,
            MemorySize = 4,
        });
    
        var defaultImages = AliCloud.Ecs.GetImages.Invoke(new()
        {
            NameRegex = "^ubuntu_18.*64",
            MostRecent = true,
            Owners = "system",
        });
    
        var defaultNetwork = new AliCloud.Vpc.Network("defaultNetwork", new()
        {
            VpcName = myName,
            CidrBlock = "172.16.0.0/16",
        });
    
        var defaultSwitch = new AliCloud.Vpc.Switch("defaultSwitch", new()
        {
            VpcId = defaultNetwork.Id,
            CidrBlock = "172.16.0.0/24",
            ZoneId = defaultZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
            VswitchName = myName,
        });
    
        var defaultSecurityGroup = new AliCloud.Ecs.SecurityGroup("defaultSecurityGroup", new()
        {
            VpcId = defaultNetwork.Id,
        });
    
        var defaultSecurityGroupRule = new AliCloud.Ecs.SecurityGroupRule("defaultSecurityGroupRule", new()
        {
            Type = "ingress",
            IpProtocol = "tcp",
            NicType = "intranet",
            Policy = "accept",
            PortRange = "22/22",
            Priority = 1,
            SecurityGroupId = defaultSecurityGroup.Id,
            CidrIp = "172.16.0.0/24",
        });
    
        var default2 = new AliCloud.Vpc.Switch("default2", new()
        {
            VpcId = defaultNetwork.Id,
            CidrBlock = "172.16.1.0/24",
            ZoneId = defaultZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
            VswitchName = $"{name}-bar",
        });
    
        var defaultScalingGroup = new AliCloud.Ess.ScalingGroup("defaultScalingGroup", new()
        {
            MinSize = 1,
            MaxSize = 1,
            ScalingGroupName = myName,
            DefaultCooldown = 20,
            VswitchIds = new[]
            {
                defaultSwitch.Id,
                default2.Id,
            },
            RemovalPolicies = new[]
            {
                "OldestInstance",
                "NewestInstance",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.random.RandomInteger;
    import com.pulumi.random.RandomIntegerArgs;
    import com.pulumi.alicloud.AlicloudFunctions;
    import com.pulumi.alicloud.inputs.GetZonesArgs;
    import com.pulumi.alicloud.ecs.EcsFunctions;
    import com.pulumi.alicloud.ecs.inputs.GetInstanceTypesArgs;
    import com.pulumi.alicloud.ecs.inputs.GetImagesArgs;
    import com.pulumi.alicloud.vpc.Network;
    import com.pulumi.alicloud.vpc.NetworkArgs;
    import com.pulumi.alicloud.vpc.Switch;
    import com.pulumi.alicloud.vpc.SwitchArgs;
    import com.pulumi.alicloud.ecs.SecurityGroup;
    import com.pulumi.alicloud.ecs.SecurityGroupArgs;
    import com.pulumi.alicloud.ecs.SecurityGroupRule;
    import com.pulumi.alicloud.ecs.SecurityGroupRuleArgs;
    import com.pulumi.alicloud.ess.ScalingGroup;
    import com.pulumi.alicloud.ess.ScalingGroupArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var config = ctx.config();
            final var name = config.get("name").orElse("terraform-example");
            var defaultRandomInteger = new RandomInteger("defaultRandomInteger", RandomIntegerArgs.builder()        
                .min(10000)
                .max(99999)
                .build());
    
            final var myName = defaultRandomInteger.result().applyValue(result -> String.format("%s-%s", name,result));
    
            final var defaultZones = AlicloudFunctions.getZones(GetZonesArgs.builder()
                .availableDiskCategory("cloud_efficiency")
                .availableResourceCreation("VSwitch")
                .build());
    
            final var defaultInstanceTypes = EcsFunctions.getInstanceTypes(GetInstanceTypesArgs.builder()
                .availabilityZone(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .cpuCoreCount(2)
                .memorySize(4)
                .build());
    
            final var defaultImages = EcsFunctions.getImages(GetImagesArgs.builder()
                .nameRegex("^ubuntu_18.*64")
                .mostRecent(true)
                .owners("system")
                .build());
    
            var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()        
                .vpcName(myName)
                .cidrBlock("172.16.0.0/16")
                .build());
    
            var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()        
                .vpcId(defaultNetwork.id())
                .cidrBlock("172.16.0.0/24")
                .zoneId(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .vswitchName(myName)
                .build());
    
            var defaultSecurityGroup = new SecurityGroup("defaultSecurityGroup", SecurityGroupArgs.builder()        
                .vpcId(defaultNetwork.id())
                .build());
    
            var defaultSecurityGroupRule = new SecurityGroupRule("defaultSecurityGroupRule", SecurityGroupRuleArgs.builder()        
                .type("ingress")
                .ipProtocol("tcp")
                .nicType("intranet")
                .policy("accept")
                .portRange("22/22")
                .priority(1)
                .securityGroupId(defaultSecurityGroup.id())
                .cidrIp("172.16.0.0/24")
                .build());
    
            var default2 = new Switch("default2", SwitchArgs.builder()        
                .vpcId(defaultNetwork.id())
                .cidrBlock("172.16.1.0/24")
                .zoneId(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .vswitchName(String.format("%s-bar", name))
                .build());
    
            var defaultScalingGroup = new ScalingGroup("defaultScalingGroup", ScalingGroupArgs.builder()        
                .minSize(1)
                .maxSize(1)
                .scalingGroupName(myName)
                .defaultCooldown(20)
                .vswitchIds(            
                    defaultSwitch.id(),
                    default2.id())
                .removalPolicies(            
                    "OldestInstance",
                    "NewestInstance")
                .build());
    
        }
    }
    
    configuration:
      name:
        type: string
        default: terraform-example
    resources:
      defaultRandomInteger:
        type: random:RandomInteger
        properties:
          min: 10000
          max: 99999
      defaultNetwork:
        type: alicloud:vpc:Network
        properties:
          vpcName: ${myName}
          cidrBlock: 172.16.0.0/16
      defaultSwitch:
        type: alicloud:vpc:Switch
        properties:
          vpcId: ${defaultNetwork.id}
          cidrBlock: 172.16.0.0/24
          zoneId: ${defaultZones.zones[0].id}
          vswitchName: ${myName}
      defaultSecurityGroup:
        type: alicloud:ecs:SecurityGroup
        properties:
          vpcId: ${defaultNetwork.id}
      defaultSecurityGroupRule:
        type: alicloud:ecs:SecurityGroupRule
        properties:
          type: ingress
          ipProtocol: tcp
          nicType: intranet
          policy: accept
          portRange: 22/22
          priority: 1
          securityGroupId: ${defaultSecurityGroup.id}
          cidrIp: 172.16.0.0/24
      default2:
        type: alicloud:vpc:Switch
        properties:
          vpcId: ${defaultNetwork.id}
          cidrBlock: 172.16.1.0/24
          zoneId: ${defaultZones.zones[0].id}
          vswitchName: ${name}-bar
      defaultScalingGroup:
        type: alicloud:ess:ScalingGroup
        properties:
          minSize: 1
          maxSize: 1
          scalingGroupName: ${myName}
          defaultCooldown: 20
          vswitchIds:
            - ${defaultSwitch.id}
            - ${default2.id}
          removalPolicies:
            - OldestInstance
            - NewestInstance
    variables:
      myName: ${name}-${defaultRandomInteger.result}
      defaultZones:
        fn::invoke:
          Function: alicloud:getZones
          Arguments:
            availableDiskCategory: cloud_efficiency
            availableResourceCreation: VSwitch
      defaultInstanceTypes:
        fn::invoke:
          Function: alicloud:ecs:getInstanceTypes
          Arguments:
            availabilityZone: ${defaultZones.zones[0].id}
            cpuCoreCount: 2
            memorySize: 4
      defaultImages:
        fn::invoke:
          Function: alicloud:ecs:getImages
          Arguments:
            nameRegex: ^ubuntu_18.*64
            mostRecent: true
            owners: system
    

    Module Support

    You can use to the existing autoscaling module to create a scaling group, configuration and lifecycle hook one-click.

    Create ScalingGroup Resource

    new ScalingGroup(name: string, args: ScalingGroupArgs, opts?: CustomResourceOptions);
    @overload
    def ScalingGroup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     db_instance_ids: Optional[Sequence[str]] = None,
                     default_cooldown: Optional[int] = None,
                     desired_capacity: Optional[int] = None,
                     group_deletion_protection: Optional[bool] = None,
                     group_type: Optional[str] = None,
                     health_check_type: Optional[str] = None,
                     launch_template_id: Optional[str] = None,
                     launch_template_overrides: Optional[Sequence[ScalingGroupLaunchTemplateOverrideArgs]] = None,
                     launch_template_version: Optional[str] = None,
                     loadbalancer_ids: Optional[Sequence[str]] = None,
                     max_size: Optional[int] = None,
                     min_size: Optional[int] = None,
                     multi_az_policy: Optional[str] = None,
                     on_demand_base_capacity: Optional[int] = None,
                     on_demand_percentage_above_base_capacity: Optional[int] = None,
                     protected_instances: Optional[Sequence[str]] = None,
                     removal_policies: Optional[Sequence[str]] = None,
                     scaling_group_name: Optional[str] = None,
                     spot_instance_pools: Optional[int] = None,
                     spot_instance_remedy: Optional[bool] = None,
                     tags: Optional[Mapping[str, Any]] = None,
                     vswitch_id: Optional[str] = None,
                     vswitch_ids: Optional[Sequence[str]] = None)
    @overload
    def ScalingGroup(resource_name: str,
                     args: ScalingGroupArgs,
                     opts: Optional[ResourceOptions] = None)
    func NewScalingGroup(ctx *Context, name string, args ScalingGroupArgs, opts ...ResourceOption) (*ScalingGroup, error)
    public ScalingGroup(string name, ScalingGroupArgs args, CustomResourceOptions? opts = null)
    public ScalingGroup(String name, ScalingGroupArgs args)
    public ScalingGroup(String name, ScalingGroupArgs args, CustomResourceOptions options)
    
    type: alicloud:ess:ScalingGroup
    properties: # The arguments to resource properties.
    options: # 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.
    resource_name str
    The unique name of the resource.
    args ScalingGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args ScalingGroupArgs
    The arguments to resource properties.
    options 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 Architecture and Concepts docs.

    Inputs

    The ScalingGroup resource accepts the following input properties:

    MaxSize int
    Maximum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, max_size can be set to 2000.
    MinSize int
    Minimum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, min_size can be set to 2000.
    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].
    GroupDeletionProtection bool
    Specifies whether the scaling group deletion protection is enabled. true or false, Default value: false.
    GroupType string
    Resource type within scaling group. Optional values: ECS, ECI. Default to ECS.
    HealthCheckType string
    Resource type within scaling group. Optional values: ECS, NONE. Default to ECS.
    LaunchTemplateId string
    Instance launch template ID, scaling group obtains launch configuration from instance launch template, see Launch Template. Creating scaling group from launch template enable group automatically.
    LaunchTemplateOverrides List<Pulumi.AliCloud.Ess.Inputs.ScalingGroupLaunchTemplateOverride>
    The details of the instance types that are specified by using the Extend Instance Type of Launch Template feature.. See launch_template_override below for details.
    LaunchTemplateVersion string
    The version number of the launch template. Valid values are the version number, Latest, or Default, Default value: Default.
    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 since v1.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.
    ProtectedInstances List<string>
    Set or unset instances within group into protected status.
    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.
    Tags Dictionary<string, object>
    A mapping of tags to assign to the resource.

    • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
    • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
    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, 2000]. NOTE: From version 1.204.1, max_size can be set to 2000.
    MinSize int
    Minimum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, min_size can be set to 2000.
    DbInstanceIds []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].
    GroupDeletionProtection bool
    Specifies whether the scaling group deletion protection is enabled. true or false, Default value: false.
    GroupType string
    Resource type within scaling group. Optional values: ECS, ECI. Default to ECS.
    HealthCheckType string
    Resource type within scaling group. Optional values: ECS, NONE. Default to ECS.
    LaunchTemplateId string
    Instance launch template ID, scaling group obtains launch configuration from instance launch template, see Launch Template. Creating scaling group from launch template enable group automatically.
    LaunchTemplateOverrides []ScalingGroupLaunchTemplateOverrideArgs
    The details of the instance types that are specified by using the Extend Instance Type of Launch Template feature.. See launch_template_override below for details.
    LaunchTemplateVersion string
    The version number of the launch template. Valid values are the version number, Latest, or Default, Default value: Default.
    LoadbalancerIds []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 since v1.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.
    ProtectedInstances []string
    Set or unset instances within group into protected status.
    RemovalPolicies []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.
    Tags map[string]interface{}
    A mapping of tags to assign to the resource.

    • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
    • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
    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 Integer
    Maximum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, max_size can be set to 2000.
    minSize Integer
    Minimum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, min_size can be set to 2000.
    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 Integer
    Default cool-down time (in seconds) of the scaling group. Value range: [0, 86400]. The default value is 300s.
    desiredCapacity Integer
    Expected number of ECS instances in the scaling group. Value range: [min_size, max_size].
    groupDeletionProtection Boolean
    Specifies whether the scaling group deletion protection is enabled. true or false, Default value: false.
    groupType String
    Resource type within scaling group. Optional values: ECS, ECI. Default to ECS.
    healthCheckType String
    Resource type within scaling group. Optional values: ECS, NONE. Default to ECS.
    launchTemplateId String
    Instance launch template ID, scaling group obtains launch configuration from instance launch template, see Launch Template. Creating scaling group from launch template enable group automatically.
    launchTemplateOverrides List<ScalingGroupLaunchTemplateOverride>
    The details of the instance types that are specified by using the Extend Instance Type of Launch Template feature.. See launch_template_override below for details.
    launchTemplateVersion String
    The version number of the launch template. Valid values are the version number, Latest, or Default, Default value: Default.
    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 since v1.54.0).
    onDemandBaseCapacity Integer
    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 Integer
    Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.
    protectedInstances List<String>
    Set or unset instances within group into protected status.
    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 Integer
    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.
    tags Map<String,Object>
    A mapping of tags to assign to the resource.

    • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
    • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
    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 number
    Maximum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, max_size can be set to 2000.
    minSize number
    Minimum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, min_size can be set to 2000.
    dbInstanceIds 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 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].
    groupDeletionProtection boolean
    Specifies whether the scaling group deletion protection is enabled. true or false, Default value: false.
    groupType string
    Resource type within scaling group. Optional values: ECS, ECI. Default to ECS.
    healthCheckType string
    Resource type within scaling group. Optional values: ECS, NONE. Default to ECS.
    launchTemplateId string
    Instance launch template ID, scaling group obtains launch configuration from instance launch template, see Launch Template. Creating scaling group from launch template enable group automatically.
    launchTemplateOverrides ScalingGroupLaunchTemplateOverride[]
    The details of the instance types that are specified by using the Extend Instance Type of Launch Template feature.. See launch_template_override below for details.
    launchTemplateVersion string
    The version number of the launch template. Valid values are the version number, Latest, or Default, Default value: Default.
    loadbalancerIds 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 since v1.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.
    protectedInstances string[]
    Set or unset instances within group into protected status.
    removalPolicies 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 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.
    tags {[key: string]: any}
    A mapping of tags to assign to the resource.

    • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
    • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
    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 int
    Maximum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, max_size can be set to 2000.
    min_size int
    Minimum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, min_size can be set to 2000.
    db_instance_ids Sequence[str]
    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.
    default_cooldown int
    Default cool-down time (in seconds) of the scaling group. Value range: [0, 86400]. The default value is 300s.
    desired_capacity int
    Expected number of ECS instances in the scaling group. Value range: [min_size, max_size].
    group_deletion_protection bool
    Specifies whether the scaling group deletion protection is enabled. true or false, Default value: false.
    group_type str
    Resource type within scaling group. Optional values: ECS, ECI. Default to ECS.
    health_check_type str
    Resource type within scaling group. Optional values: ECS, NONE. Default to ECS.
    launch_template_id str
    Instance launch template ID, scaling group obtains launch configuration from instance launch template, see Launch Template. Creating scaling group from launch template enable group automatically.
    launch_template_overrides Sequence[ScalingGroupLaunchTemplateOverrideArgs]
    The details of the instance types that are specified by using the Extend Instance Type of Launch Template feature.. See launch_template_override below for details.
    launch_template_version str
    The version number of the launch template. Valid values are the version number, Latest, or Default, Default value: Default.
    loadbalancer_ids Sequence[str]
    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.
    multi_az_policy str
    Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available since v1.54.0).
    on_demand_base_capacity 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.
    on_demand_percentage_above_base_capacity int
    Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.
    protected_instances Sequence[str]
    Set or unset instances within group into protected status.
    removal_policies Sequence[str]
    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.
    scaling_group_name str
    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.
    spot_instance_pools int
    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.
    tags Mapping[str, Any]
    A mapping of tags to assign to the resource.

    • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
    • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
    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 Sequence[str]
    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, 2000]. NOTE: From version 1.204.1, max_size can be set to 2000.
    minSize Number
    Minimum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, min_size can be set to 2000.
    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 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].
    groupDeletionProtection Boolean
    Specifies whether the scaling group deletion protection is enabled. true or false, Default value: false.
    groupType String
    Resource type within scaling group. Optional values: ECS, ECI. Default to ECS.
    healthCheckType String
    Resource type within scaling group. Optional values: ECS, NONE. Default to ECS.
    launchTemplateId String
    Instance launch template ID, scaling group obtains launch configuration from instance launch template, see Launch Template. Creating scaling group from launch template enable group automatically.
    launchTemplateOverrides List<Property Map>
    The details of the instance types that are specified by using the Extend Instance Type of Launch Template feature.. See launch_template_override below for details.
    launchTemplateVersion String
    The version number of the launch template. Valid values are the version number, Latest, or Default, Default value: Default.
    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 since v1.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.
    protectedInstances List<String>
    Set or unset instances within group into protected status.
    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 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.
    tags Map<Any>
    A mapping of tags to assign to the resource.

    • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
    • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
    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.

    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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up 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
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            db_instance_ids: Optional[Sequence[str]] = None,
            default_cooldown: Optional[int] = None,
            desired_capacity: Optional[int] = None,
            group_deletion_protection: Optional[bool] = None,
            group_type: Optional[str] = None,
            health_check_type: Optional[str] = None,
            launch_template_id: Optional[str] = None,
            launch_template_overrides: Optional[Sequence[ScalingGroupLaunchTemplateOverrideArgs]] = None,
            launch_template_version: Optional[str] = None,
            loadbalancer_ids: Optional[Sequence[str]] = None,
            max_size: Optional[int] = None,
            min_size: Optional[int] = None,
            multi_az_policy: Optional[str] = None,
            on_demand_base_capacity: Optional[int] = None,
            on_demand_percentage_above_base_capacity: Optional[int] = None,
            protected_instances: Optional[Sequence[str]] = None,
            removal_policies: Optional[Sequence[str]] = None,
            scaling_group_name: Optional[str] = None,
            spot_instance_pools: Optional[int] = None,
            spot_instance_remedy: Optional[bool] = None,
            tags: Optional[Mapping[str, Any]] = None,
            vswitch_id: Optional[str] = None,
            vswitch_ids: Optional[Sequence[str]] = None) -> ScalingGroup
    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)
    public static ScalingGroup get(String name, Output<String> id, ScalingGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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>
    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].
    GroupDeletionProtection bool
    Specifies whether the scaling group deletion protection is enabled. true or false, Default value: false.
    GroupType string
    Resource type within scaling group. Optional values: ECS, ECI. Default to ECS.
    HealthCheckType string
    Resource type within scaling group. Optional values: ECS, NONE. Default to ECS.
    LaunchTemplateId string
    Instance launch template ID, scaling group obtains launch configuration from instance launch template, see Launch Template. Creating scaling group from launch template enable group automatically.
    LaunchTemplateOverrides List<Pulumi.AliCloud.Ess.Inputs.ScalingGroupLaunchTemplateOverride>
    The details of the instance types that are specified by using the Extend Instance Type of Launch Template feature.. See launch_template_override below for details.
    LaunchTemplateVersion string
    The version number of the launch template. Valid values are the version number, Latest, or Default, Default value: Default.
    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.
    MaxSize int
    Maximum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, max_size can be set to 2000.
    MinSize int
    Minimum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, min_size can be set to 2000.
    MultiAzPolicy string
    Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available since v1.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.
    ProtectedInstances List<string>
    Set or unset instances within group into protected status.
    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.
    Tags Dictionary<string, object>
    A mapping of tags to assign to the resource.

    • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
    • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
    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
    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].
    GroupDeletionProtection bool
    Specifies whether the scaling group deletion protection is enabled. true or false, Default value: false.
    GroupType string
    Resource type within scaling group. Optional values: ECS, ECI. Default to ECS.
    HealthCheckType string
    Resource type within scaling group. Optional values: ECS, NONE. Default to ECS.
    LaunchTemplateId string
    Instance launch template ID, scaling group obtains launch configuration from instance launch template, see Launch Template. Creating scaling group from launch template enable group automatically.
    LaunchTemplateOverrides []ScalingGroupLaunchTemplateOverrideArgs
    The details of the instance types that are specified by using the Extend Instance Type of Launch Template feature.. See launch_template_override below for details.
    LaunchTemplateVersion string
    The version number of the launch template. Valid values are the version number, Latest, or Default, Default value: Default.
    LoadbalancerIds []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.
    MaxSize int
    Maximum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, max_size can be set to 2000.
    MinSize int
    Minimum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, min_size can be set to 2000.
    MultiAzPolicy string
    Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available since v1.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.
    ProtectedInstances []string
    Set or unset instances within group into protected status.
    RemovalPolicies []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.
    Tags map[string]interface{}
    A mapping of tags to assign to the resource.

    • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
    • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
    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 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 Integer
    Default cool-down time (in seconds) of the scaling group. Value range: [0, 86400]. The default value is 300s.
    desiredCapacity Integer
    Expected number of ECS instances in the scaling group. Value range: [min_size, max_size].
    groupDeletionProtection Boolean
    Specifies whether the scaling group deletion protection is enabled. true or false, Default value: false.
    groupType String
    Resource type within scaling group. Optional values: ECS, ECI. Default to ECS.
    healthCheckType String
    Resource type within scaling group. Optional values: ECS, NONE. Default to ECS.
    launchTemplateId String
    Instance launch template ID, scaling group obtains launch configuration from instance launch template, see Launch Template. Creating scaling group from launch template enable group automatically.
    launchTemplateOverrides List<ScalingGroupLaunchTemplateOverride>
    The details of the instance types that are specified by using the Extend Instance Type of Launch Template feature.. See launch_template_override below for details.
    launchTemplateVersion String
    The version number of the launch template. Valid values are the version number, Latest, or Default, Default value: Default.
    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.
    maxSize Integer
    Maximum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, max_size can be set to 2000.
    minSize Integer
    Minimum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, min_size can be set to 2000.
    multiAzPolicy String
    Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available since v1.54.0).
    onDemandBaseCapacity Integer
    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 Integer
    Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.
    protectedInstances List<String>
    Set or unset instances within group into protected status.
    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 Integer
    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.
    tags Map<String,Object>
    A mapping of tags to assign to the resource.

    • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
    • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
    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[]
    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 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].
    groupDeletionProtection boolean
    Specifies whether the scaling group deletion protection is enabled. true or false, Default value: false.
    groupType string
    Resource type within scaling group. Optional values: ECS, ECI. Default to ECS.
    healthCheckType string
    Resource type within scaling group. Optional values: ECS, NONE. Default to ECS.
    launchTemplateId string
    Instance launch template ID, scaling group obtains launch configuration from instance launch template, see Launch Template. Creating scaling group from launch template enable group automatically.
    launchTemplateOverrides ScalingGroupLaunchTemplateOverride[]
    The details of the instance types that are specified by using the Extend Instance Type of Launch Template feature.. See launch_template_override below for details.
    launchTemplateVersion string
    The version number of the launch template. Valid values are the version number, Latest, or Default, Default value: Default.
    loadbalancerIds 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.
    maxSize number
    Maximum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, max_size can be set to 2000.
    minSize number
    Minimum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, min_size can be set to 2000.
    multiAzPolicy string
    Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available since v1.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.
    protectedInstances string[]
    Set or unset instances within group into protected status.
    removalPolicies 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 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.
    tags {[key: string]: any}
    A mapping of tags to assign to the resource.

    • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
    • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
    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 Sequence[str]
    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.
    default_cooldown int
    Default cool-down time (in seconds) of the scaling group. Value range: [0, 86400]. The default value is 300s.
    desired_capacity int
    Expected number of ECS instances in the scaling group. Value range: [min_size, max_size].
    group_deletion_protection bool
    Specifies whether the scaling group deletion protection is enabled. true or false, Default value: false.
    group_type str
    Resource type within scaling group. Optional values: ECS, ECI. Default to ECS.
    health_check_type str
    Resource type within scaling group. Optional values: ECS, NONE. Default to ECS.
    launch_template_id str
    Instance launch template ID, scaling group obtains launch configuration from instance launch template, see Launch Template. Creating scaling group from launch template enable group automatically.
    launch_template_overrides Sequence[ScalingGroupLaunchTemplateOverrideArgs]
    The details of the instance types that are specified by using the Extend Instance Type of Launch Template feature.. See launch_template_override below for details.
    launch_template_version str
    The version number of the launch template. Valid values are the version number, Latest, or Default, Default value: Default.
    loadbalancer_ids Sequence[str]
    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.
    max_size int
    Maximum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, max_size can be set to 2000.
    min_size int
    Minimum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, min_size can be set to 2000.
    multi_az_policy str
    Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available since v1.54.0).
    on_demand_base_capacity 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.
    on_demand_percentage_above_base_capacity int
    Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.
    protected_instances Sequence[str]
    Set or unset instances within group into protected status.
    removal_policies Sequence[str]
    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.
    scaling_group_name str
    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.
    spot_instance_pools int
    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.
    tags Mapping[str, Any]
    A mapping of tags to assign to the resource.

    • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
    • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
    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 Sequence[str]
    List of virtual switch IDs in which the ecs instances to be launched.
    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 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].
    groupDeletionProtection Boolean
    Specifies whether the scaling group deletion protection is enabled. true or false, Default value: false.
    groupType String
    Resource type within scaling group. Optional values: ECS, ECI. Default to ECS.
    healthCheckType String
    Resource type within scaling group. Optional values: ECS, NONE. Default to ECS.
    launchTemplateId String
    Instance launch template ID, scaling group obtains launch configuration from instance launch template, see Launch Template. Creating scaling group from launch template enable group automatically.
    launchTemplateOverrides List<Property Map>
    The details of the instance types that are specified by using the Extend Instance Type of Launch Template feature.. See launch_template_override below for details.
    launchTemplateVersion String
    The version number of the launch template. Valid values are the version number, Latest, or Default, Default value: Default.
    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.
    maxSize Number
    Maximum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, max_size can be set to 2000.
    minSize Number
    Minimum number of ECS instances in the scaling group. Value range: [0, 2000]. NOTE: From version 1.204.1, min_size can be set to 2000.
    multiAzPolicy String
    Multi-AZ scaling group ECS instance expansion and contraction strategy. PRIORITY, BALANCE or COST_OPTIMIZED(Available since v1.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.
    protectedInstances List<String>
    Set or unset instances within group into protected status.
    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 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.
    tags Map<Any>
    A mapping of tags to assign to the resource.

    • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
    • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
    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.

    Supporting Types

    ScalingGroupLaunchTemplateOverride, ScalingGroupLaunchTemplateOverrideArgs

    InstanceType string
    The instance type in launchTemplateOverride.
    SpotPriceLimit double

    The maximum bid price of instance type in launchTemplateOverride.

    NOTE: When detach loadbalancers, instances in group will be remove from loadbalancer's Default Server Group; On the contrary, When attach loadbalancers, instances in group will be added to loadbalancer's Default Server Group.

    NOTE: When detach dbInstances, private ip of instances in group will be remove from dbInstance's WhiteList; On the contrary, When attach dbInstances, private ip of instances in group will be added to dbInstance's WhiteList.

    NOTE: on_demand_base_capacity,on_demand_percentage_above_base_capacity,spot_instance_pools,spot_instance_remedy are valid only if multi_az_policy is 'COST_OPTIMIZED'.

    WeightedCapacity int
    The weight of the instance type in launchTemplateOverride.
    InstanceType string
    The instance type in launchTemplateOverride.
    SpotPriceLimit float64

    The maximum bid price of instance type in launchTemplateOverride.

    NOTE: When detach loadbalancers, instances in group will be remove from loadbalancer's Default Server Group; On the contrary, When attach loadbalancers, instances in group will be added to loadbalancer's Default Server Group.

    NOTE: When detach dbInstances, private ip of instances in group will be remove from dbInstance's WhiteList; On the contrary, When attach dbInstances, private ip of instances in group will be added to dbInstance's WhiteList.

    NOTE: on_demand_base_capacity,on_demand_percentage_above_base_capacity,spot_instance_pools,spot_instance_remedy are valid only if multi_az_policy is 'COST_OPTIMIZED'.

    WeightedCapacity int
    The weight of the instance type in launchTemplateOverride.
    instanceType String
    The instance type in launchTemplateOverride.
    spotPriceLimit Double

    The maximum bid price of instance type in launchTemplateOverride.

    NOTE: When detach loadbalancers, instances in group will be remove from loadbalancer's Default Server Group; On the contrary, When attach loadbalancers, instances in group will be added to loadbalancer's Default Server Group.

    NOTE: When detach dbInstances, private ip of instances in group will be remove from dbInstance's WhiteList; On the contrary, When attach dbInstances, private ip of instances in group will be added to dbInstance's WhiteList.

    NOTE: on_demand_base_capacity,on_demand_percentage_above_base_capacity,spot_instance_pools,spot_instance_remedy are valid only if multi_az_policy is 'COST_OPTIMIZED'.

    weightedCapacity Integer
    The weight of the instance type in launchTemplateOverride.
    instanceType string
    The instance type in launchTemplateOverride.
    spotPriceLimit number

    The maximum bid price of instance type in launchTemplateOverride.

    NOTE: When detach loadbalancers, instances in group will be remove from loadbalancer's Default Server Group; On the contrary, When attach loadbalancers, instances in group will be added to loadbalancer's Default Server Group.

    NOTE: When detach dbInstances, private ip of instances in group will be remove from dbInstance's WhiteList; On the contrary, When attach dbInstances, private ip of instances in group will be added to dbInstance's WhiteList.

    NOTE: on_demand_base_capacity,on_demand_percentage_above_base_capacity,spot_instance_pools,spot_instance_remedy are valid only if multi_az_policy is 'COST_OPTIMIZED'.

    weightedCapacity number
    The weight of the instance type in launchTemplateOverride.
    instance_type str
    The instance type in launchTemplateOverride.
    spot_price_limit float

    The maximum bid price of instance type in launchTemplateOverride.

    NOTE: When detach loadbalancers, instances in group will be remove from loadbalancer's Default Server Group; On the contrary, When attach loadbalancers, instances in group will be added to loadbalancer's Default Server Group.

    NOTE: When detach dbInstances, private ip of instances in group will be remove from dbInstance's WhiteList; On the contrary, When attach dbInstances, private ip of instances in group will be added to dbInstance's WhiteList.

    NOTE: on_demand_base_capacity,on_demand_percentage_above_base_capacity,spot_instance_pools,spot_instance_remedy are valid only if multi_az_policy is 'COST_OPTIMIZED'.

    weighted_capacity int
    The weight of the instance type in launchTemplateOverride.
    instanceType String
    The instance type in launchTemplateOverride.
    spotPriceLimit Number

    The maximum bid price of instance type in launchTemplateOverride.

    NOTE: When detach loadbalancers, instances in group will be remove from loadbalancer's Default Server Group; On the contrary, When attach loadbalancers, instances in group will be added to loadbalancer's Default Server Group.

    NOTE: When detach dbInstances, private ip of instances in group will be remove from dbInstance's WhiteList; On the contrary, When attach dbInstances, private ip of instances in group will be added to dbInstance's WhiteList.

    NOTE: on_demand_base_capacity,on_demand_percentage_above_base_capacity,spot_instance_pools,spot_instance_remedy are valid only if multi_az_policy is 'COST_OPTIMIZED'.

    weightedCapacity Number
    The weight of the instance type in launchTemplateOverride.

    Import

    ESS scaling group can be imported using the id, e.g.

    $ pulumi import alicloud:ess/scalingGroup:ScalingGroup example asg-abc123456
    

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.51.0 published on Saturday, Mar 23, 2024 by Pulumi