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

Class: Aws::AutoScaling::Types::AutoScalingGroup

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

Overview

Describes an Auto Scaling group.

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_arnString

The Amazon Resource Name (ARN) of the group.

Returns:

  • (String)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#auto_scaling_group_nameString

The name of the group.

Returns:

  • (String)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :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>)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#created_timeTime

The date and time the group was created.

Returns:

  • (Time)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :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.

Returns:

  • (Integer)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#desired_capacityInteger

The desired size of the group.

Returns:

  • (Integer)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#enabled_metricsArray<Types::EnabledMetric>

The metrics enabled for the group.

Returns:



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :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.

Returns:

  • (Integer)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :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)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#instancesArray<Types::Instance>

The EC2 instances associated with the group.

Returns:



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#launch_configuration_nameString

The name of the associated launch configuration.

Returns:

  • (String)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#load_balancer_namesArray<String>

One or more load balancers associated with the group.

Returns:

  • (Array<String>)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#max_sizeInteger

The maximum size of the group.

Returns:

  • (Integer)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#min_sizeInteger

The minimum size of the group.

Returns:

  • (Integer)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :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)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :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)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#statusString

The current state of the group when DeleteAutoScalingGroup is in progress.

Returns:

  • (String)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#suspended_processesArray<Types::SuspendedProcess>

The suspended processes associated with the group.

Returns:



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#tagsArray<Types::TagDescription>

The tags for the group.

Returns:



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#target_group_arnsArray<String>

The Amazon Resource Names (ARN) of the target groups for your load balancer.

Returns:

  • (Array<String>)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#termination_policiesArray<String>

The termination policies for the group.

Returns:

  • (Array<String>)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end

#vpc_zone_identifierString

One or more subnet IDs, if applicable, separated by commas.

If you specify VPCZoneIdentifier and AvailabilityZones, ensure that the Availability Zones of the subnets match the values for AvailabilityZones.

Returns:

  • (String)


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 329

class AutoScalingGroup < Struct.new(
  :auto_scaling_group_name,
  :auto_scaling_group_arn,
  :launch_configuration_name,
  :min_size,
  :max_size,
  :desired_capacity,
  :default_cooldown,
  :availability_zones,
  :load_balancer_names,
  :target_group_arns,
  :health_check_type,
  :health_check_grace_period,
  :instances,
  :created_time,
  :suspended_processes,
  :placement_group,
  :vpc_zone_identifier,
  :enabled_metrics,
  :status,
  :tags,
  :termination_policies,
  :new_instances_protected_from_scale_in)
  include Aws::Structure
end