Class: Ansible::Ruby::Modules::Ec2_asg

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb,
lib/ansible/ruby/modules/custom/cloud/core/amazon/ec2_asg.rb

Overview

Can create or delete AWS Autoscaling Groups Works with the ec2_lc module to manage Launch Configurations

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#availability_zones ⇒ Array<String>, ...

Returns List of availability zone names in which to create the group. Defaults to all the availability zones in the region if vpc_zone_identifier is not set.

Returns:

  • (Array<String>, String, nil) —

    List of availability zone names in which to create the group. Defaults to all the availability zones in the region if vpc_zone_identifier is not set.



24
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 24

attribute :availability_zones

#default_cooldown ⇒ String?

Returns The number of seconds after a scaling activity completes before another can begin.

Returns:

  • (String, nil) —

    The number of seconds after a scaling activity completes before another can begin.



76
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 76

attribute :default_cooldown

#desired_capacity ⇒ Integer?

Returns Desired number of instances in group, if unspecified then the current group value will be used.

Returns:

  • (Integer, nil) —

    Desired number of instances in group, if unspecified then the current group value will be used.



40
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 40

attribute :desired_capacity

#health_check_period ⇒ String?

Returns Length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health.

Returns:

  • (String, nil) —

    Length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health.



68
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 68

attribute :health_check_period

#health_check_type ⇒ :EC2, ...

Returns The service you want the health status from, Amazon EC2 or Elastic Load Balancer.

Returns:

  • (:EC2, :ELB, nil) —

    The service you want the health status from, Amazon EC2 or Elastic Load Balancer.



72
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 72

attribute :health_check_type

#launch_config_name ⇒ String

Returns Name of the Launch configuration to use for the group. See the ec2_lc module for managing these.

Returns:

  • (String) —

    Name of the Launch configuration to use for the group. See the ec2_lc module for managing these.



28
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 28

attribute :launch_config_name

#lc_check ⇒ Boolean?

Returns Check to make sure instances that are being replaced with replace_instances do not aready have the current launch_config.

Returns:

  • (Boolean, nil) —

    Check to make sure instances that are being replaced with replace_instances do not aready have the current launch_config.



56
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 56

attribute :lc_check

#load_balancers ⇒ Array<String>, ...

Returns List of ELB names to use for the group.

Returns:

  • (Array<String>, String, nil) —

    List of ELB names to use for the group



20
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 20

attribute :load_balancers

#max_size ⇒ Integer?

Returns Maximum number of instances in group, if unspecified then the current group value will be used.

Returns:

  • (Integer, nil) —

    Maximum number of instances in group, if unspecified then the current group value will be used.



36
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 36

attribute :max_size

#min_size ⇒ Integer?

Returns Minimum number of instances in group, if unspecified then the current group value will be used.

Returns:

  • (Integer, nil) —

    Minimum number of instances in group, if unspecified then the current group value will be used.



32
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 32

attribute :min_size

#name ⇒ String

Returns Unique name for group to be created or deleted.

Returns:

  • (String) —

    Unique name for group to be created or deleted



16
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 16

attribute :name

#replace_all_instances ⇒ Boolean?

Returns In a rolling fashion, replace all instances with an old launch configuration with one from the current launch configuration.

Returns:

  • (Boolean, nil) —

    In a rolling fashion, replace all instances with an old launch configuration with one from the current launch configuration.



44
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 44

attribute :replace_all_instances

#replace_batch_size ⇒ Integer?

Returns Number of instances you’d like to replace at a time. Used with replace_all_instances.

Returns:

  • (Integer, nil) —

    Number of instances you’d like to replace at a time. Used with replace_all_instances.



48
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 48

attribute :replace_batch_size

#replace_instances ⇒ Array<String>, ...

Returns List of instance_ids belonging to the named ASG that you would like to terminate and be replaced with instances matching the current launch configuration.

Returns:

  • (Array<String>, String, nil) —

    List of instance_ids belonging to the named ASG that you would like to terminate and be replaced with instances matching the current launch configuration.



52
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 52

attribute :replace_instances

#state ⇒ :present, :absent

Returns register or deregister the instance.

Returns:

  • (:present, :absent) —

    register or deregister the instance



12
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 12

attribute :state

#tags ⇒ Array<Hash>, ...

Returns A list of tags to add to the Auto Scale Group. Optional key is ‘propagate_at_launch’, which defaults to true.

Returns:

  • (Array<Hash>, Hash, nil) —

    A list of tags to add to the Auto Scale Group. Optional key is ‘propagate_at_launch’, which defaults to true.



64
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 64

attribute :tags

#termination_policies ⇒ :OldestInstance, ...

Returns An ordered list of criteria used for selecting instances to be removed from the Auto Scaling group when reducing capacity.,For ‘Default’, when used to create a new autoscaling group, the “Default” value is used. When used to change an existent autoscaling group, the current termination policies are mantained.

Returns:

  • (:OldestInstance, :NewestInstance, :OldestLaunchConfiguration, :ClosestToNextInstanceHour, :Default, nil) —

    An ordered list of criteria used for selecting instances to be removed from the Auto Scaling group when reducing capacity.,For ‘Default’, when used to create a new autoscaling group, the “Default” value is used. When used to change an existent autoscaling group, the current termination policies are mantained



12
 
# File 'lib/ansible/ruby/modules/custom/cloud/core/amazon/ec2_asg.rb', line 12

attribute :termination_policies

#vpc_zone_identifier ⇒ Array<String>, ...

Returns List of VPC subnets to use.

Returns:

  • (Array<String>, String, nil) —

    List of VPC subnets to use



60
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 60

attribute :vpc_zone_identifier

#wait_for_instances ⇒ Boolean?

Returns Wait for the ASG instances to be in a ready state before exiting. If instances are behind an ELB, it will wait until the ELB determines all instances have a lifecycle_state of “InService” and a health_status of “Healthy”.

Returns:

  • (Boolean, nil) —

    Wait for the ASG instances to be in a ready state before exiting. If instances are behind an ELB, it will wait until the ELB determines all instances have a lifecycle_state of “InService” and a health_status of “Healthy”.



84
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 84

attribute :wait_for_instances

#wait_timeout ⇒ Integer?

Returns how long before wait instances to become viable when replaced. Used in concjunction with instance_ids option.

Returns:

  • (Integer, nil) —

    how long before wait instances to become viable when replaced. Used in concjunction with instance_ids option.



80
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_asg.rb', line 80

attribute :wait_timeout