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",
  launch_template: {
    launch_template_id: "XmlStringMaxLen255",
    launch_template_name: "LaunchTemplateName",
    version: "XmlStringMaxLen255",
  },
  mixed_instances_policy: {
    launch_template: {
      launch_template_specification: {
        launch_template_id: "XmlStringMaxLen255",
        launch_template_name: "LaunchTemplateName",
        version: "XmlStringMaxLen255",
      },
      overrides: [
        {
          instance_type: "XmlStringMaxLen255",
        },
      ],
    },
    instances_distribution: {
      on_demand_allocation_strategy: "XmlString",
      on_demand_base_capacity: 1,
      on_demand_percentage_above_base_capacity: 1,
      spot_allocation_strategy: "XmlString",
      spot_instance_pools: 1,
      spot_max_price: "MixedInstanceSpotPrice",
    },
  },
  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,
  service_linked_role_arn: "ResourceName",
}

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_nameString

The name of the Auto Scaling group.

Returns:

  • (String)


5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  include Aws::Structure
end

#availability_zonesArray<String>

One or more Availability Zones for the group.

Returns:

  • (Array<String>)


5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  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 value is 300.

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

Returns:

  • (Integer)


5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  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)


5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  include Aws::Structure
end

#health_check_grace_periodInteger

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

For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is required if you are adding an ELB health check.

Returns:

  • (Integer)


5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  include Aws::Structure
end

#health_check_typeString

The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.

Returns:

  • (String)


5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  include Aws::Structure
end

#launch_configuration_nameString

The name of the launch configuration. If you specify this parameter, you can't specify a launch template or a mixed instances policy.

Returns:

  • (String)


5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  include Aws::Structure
end

#launch_templateTypes::LaunchTemplateSpecification

The launch template and version to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a mixed instances policy.



5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  include Aws::Structure
end

#max_sizeInteger

The maximum size of the Auto Scaling group.

Returns:

  • (Integer)


5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  include Aws::Structure
end

#min_sizeInteger

The minimum size of the Auto Scaling group.

Returns:

  • (Integer)


5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  include Aws::Structure
end

#mixed_instances_policyTypes::MixedInstancesPolicy

The mixed instances policy to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a launch template.

For more information, see Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.



5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  include Aws::Structure
end

#new_instances_protected_from_scale_inBoolean

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

For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

Returns:

  • (Boolean)


5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  include Aws::Structure
end

#placement_groupString

The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

Returns:

  • (String)


5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  include Aws::Structure
end

#service_linked_role_arnString

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.

Returns:

  • (String)


5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  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 Amazon EC2 Auto Scaling User Guide.

Returns:

  • (Array<String>)


5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  include Aws::Structure
end

#vpc_zone_identifierString

A comma-separated list of subnet IDs, if you are launching into a VPC.

If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.

Returns:

  • (String)


5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5022

class UpdateAutoScalingGroupType < Struct.new(
  :auto_scaling_group_name,
  :launch_configuration_name,
  :launch_template,
  :mixed_instances_policy,
  :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,
  :service_linked_role_arn)
  include Aws::Structure
end