You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AutoScaling::Types::UpdateAutoScalingGroupType

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

Note:

When making an API call, you may pass UpdateAutoScalingGroupType data as a hash:

{
  auto_scaling_group_name: "ResourceName", # required
  launch_configuration_name: "ResourceName",
  min_size: 1,
  max_size: 1,
  desired_capacity: 1,
  default_cooldown: 1,
  availability_zones: ["XmlStringMaxLen255"],
  health_check_type: "XmlStringMaxLen32",
  health_check_grace_period: 1,
  placement_group: "XmlStringMaxLen255",
  vpc_zone_identifier: "XmlStringMaxLen2047",
  termination_policies: ["XmlStringMaxLen1600"],
  new_instances_protected_from_scale_in: false,
}

Contains the parameters for UpdateAutoScalingGroup.

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_nameString

The name of the Auto Scaling group.

Returns:

  • (String)


4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4216

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#availability_zonesArray<String>

One or more Availability Zones for the group.

Returns:

  • (Array<String>)


4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4216

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#default_cooldownInteger

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.

For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.

Returns:

  • (Integer)


4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4216

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#desired_capacityInteger

The number of EC2 instances that should be running in the Auto Scaling group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.

Returns:

  • (Integer)


4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4216

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#health_check_grace_periodInteger

The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 0.

For more information, see Health Checks in the Auto Scaling User Guide.

Returns:

  • (Integer)


4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4216

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#health_check_typeString

The service to use for the health checks. The valid values are EC2 and ELB.

Returns:

  • (String)


4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4216

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#launch_configuration_nameString

The name of the launch configuration.

Returns:

  • (String)


4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4216

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#max_sizeInteger

The maximum size of the Auto Scaling group.

Returns:

  • (Integer)


4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4216

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#min_sizeInteger

The minimum size of the Auto Scaling group.

Returns:

  • (Integer)


4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4216

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#new_instances_protected_from_scale_inBoolean

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

Returns:

  • (Boolean)


4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4216

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#placement_groupString

The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String)


4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4216

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#termination_policiesArray<String>

A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling User Guide.

Returns:

  • (Array<String>)


4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4216

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#vpc_zone_identifierString

The ID of the subnet, if you are launching into a VPC. You can specify several subnets in a comma-separated list.

When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the subnets' Availability Zones match the values you specify for AvailabilityZones.

For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.

Returns:

  • (String)


4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4216

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :health_check_type,
  :health_check_grace_period,
  :placement_group,
  :vpc_zone_identifier,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end