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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/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, fix_inclusion, #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.



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

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.



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

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.



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

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.



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

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.



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

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. If unspecified then the current group value will be used.

Returns:

  • (String) —

    Name of the Launch configuration to use for the group. See the ec2_lc module for managing these. If unspecified then the current group value will be used.



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

attribute :launch_config_name

#lc_check ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :lc_check

#load_balancers ⇒ Array<String>, ...

Returns List of ELB names to use for the group. Use for classic load balancers.

Returns:

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

    List of ELB names to use for the group. Use for classic load balancers.



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

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.



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

attribute :max_size

#metrics_collection ⇒ :yes, ...

Returns Enable ASG metrics collection.

Returns:

  • (:yes, :no, nil) —

    Enable ASG metrics collection



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

attribute :metrics_collection

#metrics_granularity ⇒ String?

Returns When metrics_collection is enabled this will determine granularity of metrics collected by CloudWatch.

Returns:

  • (String, nil) —

    When metrics_collection is enabled this will determine granularity of metrics collected by CloudWatch



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

attribute :metrics_granularity

#metrics_list ⇒ String?

Returns List of autoscaling metrics to collect when enabling metrics_collection.

Returns:

  • (String, nil) —

    List of autoscaling metrics to collect when enabling metrics_collection



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

attribute :metrics_list

#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.



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

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



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

attribute :name

#notification_topic ⇒ Object?

Returns A SNS topic ARN to send auto scaling notifications to.

Returns:

  • (Object, nil) —

    A SNS topic ARN to send auto scaling notifications to.



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

attribute :notification_topic

#notification_types ⇒ String?

Returns A list of auto scaling events to trigger notifications on.

Returns:

  • (String, nil) —

    A list of auto scaling events to trigger notifications on.



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

attribute :notification_types

#placement_group ⇒ Object?

Returns Physical location of your cluster placement group created in Amazon EC2.

Returns:

  • (Object, nil) —

    Physical location of your cluster placement group created in Amazon EC2.



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

attribute :placement_group

#replace_all_instances ⇒ String?

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

Returns:

  • (String, nil) —

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



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

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.



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

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.



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

attribute :replace_instances

#state ⇒ :present, ...

Returns register or deregister the instance.

Returns:

  • (:present, :absent, nil) —

    register or deregister the instance



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

attribute :state

#suspend_processes ⇒ :Launch, ...

Returns A list of scaling processes to suspend.

Returns:

  • (:Launch, :Terminate, :HealthCheck, :ReplaceUnhealthy, :AZRebalance, :AlarmNotification, :ScheduledActions, :AddToLoadBalancer, nil) —

    A list of scaling processes to suspend.



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

attribute :suspend_processes

#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.



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

attribute :tags

#target_group_arns ⇒ Object?

Returns List of target group ARNs to use for the group. Use for application load balancers.

Returns:

  • (Object, nil) —

    List of target group ARNs to use for the group. Use for application load balancers.



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

attribute :target_group_arns

#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”i value is used. When used to change an existent autoscaling group, the current termination policies are maintained.

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”i value is used. When used to change an existent autoscaling group, the current termination policies are maintained.



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

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



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

attribute :vpc_zone_identifier

#wait_for_instances ⇒ String?

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:

  • (String, 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”.



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

attribute :wait_for_instances

#wait_timeout ⇒ Integer?

Returns How long to wait for instances to become viable when replaced. If you experience the error “Waited too long for ELB instances to be healthy”, try increasing this value.

Returns:

  • (Integer, nil) —

    How long to wait for instances to become viable when replaced. If you experience the error “Waited too long for ELB instances to be healthy”, try increasing this value.



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

attribute :wait_timeout