File: group.rb

package info (click to toggle)
ruby-aws-sdk 1.66.0-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 6,808 kB
  • ctags: 4,854
  • sloc: ruby: 28,354; makefile: 7
file content (421 lines) | stat: -rw-r--r-- 12,367 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
#     http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.

module AWS
  class AutoScaling

    # @attr_reader [String] arn
    #
    # @attr_reader [Array<String>] availability_zone_names
    #
    # @attr_reader [Time] created_time
    #
    # @attr_reader [Integer] default_cooldown
    #
    # @attr_reader [Integer] desired_capacity
    #
    # @attr_reader [Array<Hash>] enabled_metrics Returns a hash of enabled
    #   metric names (keys) and granularities (values).
    #
    # @attr_reader [Integer] health_check_grace_period
    #
    # @attr_reader [Symbol] health_check_type Returns :ec2 or :vpc.
    #
    # @attr_reader [String] launch_configuration_name
    #
    # @attr_reader [Array<String>] load_balancer_names
    #
    # @attr_reader [Integer] min_size
    #
    # @attr_reader [Integer] max_size
    #
    # @attr_reader [String,nil] placement_group
    #
    # @attr_reader [Hash] suspended_processes A hash of suspended process
    #   names (keys) and reasons (values).
    #
    class Group < Core::Resource

      include GroupOptions

      def initialize name, options = {}
        @name = name
        super
      end

      # @return [String]
      attr_reader :name

      attribute :auto_scaling_group_arn, :static => true

      alias_method :arn, :auto_scaling_group_arn

      attribute :availability_zone_names, :from => :availability_zones

      attribute :created_time, :static => true

      attribute :default_cooldown

      attribute :desired_capacity

      attribute :enabled_metrics do
        translates_output do |metrics|
          metrics.inject({}) do |hash,metric|
            hash.merge(metric.metric => metric.granularity)
          end
        end
      end

      attribute :health_check_grace_period

      attribute :health_check_type, :to_sym => true

      attribute :instances

      protected :instances

      attribute :launch_configuration_name

      attribute :load_balancer_names, :static => true

      attribute :min_size

      attribute :max_size

      attribute :placement_group

      attribute :termination_policies

      attribute :suspended_processes do
        translates_output do |processes|
          processes.inject({}) do |hash,process|
            hash.merge(process.process_name => process.suspension_reason)
          end
        end
      end

      attribute :tag_details, :from => :tags

      protected :tag_details

      attribute :vpc_zone_identifier

      protected :vpc_zone_identifier

      populates_from(:describe_auto_scaling_groups) do |resp|
        resp.auto_scaling_groups.find{|g| g.auto_scaling_group_name == name }
      end

      # @return [ScalingPolicyCollection]
      def scaling_policies
        ScalingPolicyCollection.new(self)
      end

      # @return [NotificationConfigurationCollection]
      def notification_configurations
        NotificationConfigurationCollection.new(:group => self)
      end

      # @return [ScheduledActionCollection]
      def scheduled_actions
        actions = ScheduledActionCollection.new(:config => config)
        actions.filter(:group => self)
      end

      # @return [Tag]
      def tags
        tag_details.collect do |tag|
          Tag.new(tag.to_hash.merge(:config => config))
        end
      end

      # @return [LaunchConfiguration]
      def launch_configuration
        LaunchConfiguration.new(launch_configuration_name, :config => config)
      end

      # @return [ActivityCollection]
      def activities
        ActivityCollection.new(:group => self)
      end

      # @return [Array<AutoScaling::Instance>]
      def auto_scaling_instances
        instances.collect do |details|
          Instance.new_from(
            :describe_auto_scaling_groups,
            details,
            details.instance_id,
            :auto_scaling_group_name => name, # not provided by the response
            :config => config)
        end
      end

      # Returns a collection that represents the instances belonging to this
      # Auto Scaling group.  You can use this collection to further refine
      # the instances you are interested in:
      #
      #     group.ec2_instances.filter('availability-zone', 'us-west-2a').each do |i|
      #       puts instance.id
      #     end
      #
      # @return [EC2::InstanceCollection] Returns an instance collection
      #   (without making a request) that represents the instances
      #   belonging to this Auto Scaling group.
      #
      def ec2_instances
        instances = EC2::InstanceCollection.new(:config => config)
        instances.filter('tag:aws:autoscaling:groupName', name)
      end

      # @return [Array<EC2::Subnet>]
      def subnets
        vpc_zone_identifier.to_s.split(/,/).collect do |subnet_id|
          EC2::Subnet.new(subnet_id, :config => config)
        end
      end

      # @return [Array<EC2::AvailabilityZone>]
      def availability_zones
        availability_zone_names.collect do |az_name|
          EC2::AvailabilityZone.new(az_name, :config => config)
        end
      end

      # @return [Array,<ELB::LoadBalancer>]
      def load_balancers
        load_balancer_names.collect do |name|
          ELB::LoadBalancer.new(name, :config => config)
        end
      end

      # Adjusts the desired size of the Auto Scaling group by initiating
      # scaling activities. When reducing the size of the group, it is
      # not possible to define which Amazon EC2 instances will be
      # terminated. This applies to any Auto Scaling decisions that might
      # result in terminating instances.
      #
      # @param [Integer] capacity The new capacity setting for this Auto
      #   Scaling group.
      #
      # @param [Hash] options
      #
      # @option options [Boolean] :honor_cooldown (false)
      #
      # @return [nil]
      #
      def set_desired_capacity capacity, options = {}
        client_opts = {}
        client_opts[:auto_scaling_group_name] = name
        client_opts[:desired_capacity] = capacity
        client_opts[:honor_cooldown] = options[:honor_cooldown] == true
        client.set_desired_capacity(client_opts)
        nil
      end

      # Suspends processes for this Auto Scaling group.
      #
      #     # suspend two processes by name
      #     auto_scaling_group.suspend_processes 'Launch', 'AZRebalance'
      #
      # @param [Array<String>] processes A list of process to suspend.
      #
      # @return [nil]
      #
      def suspend_processes *processes
        client_opts = {}
        client_opts[:auto_scaling_group_name] = name
        client_opts[:scaling_processes] = processes.flatten
        client.suspend_processes(client_opts)
        nil
      end

      # Suspends all processes for this Auto Scaling group.
      # @return [nil]
      def suspend_all_processes
        suspend_processes
      end

      # Resumes processes for this Auto Scaling group.
      #
      #     # resume two processes by name
      #     auto_scaling_group.suspend_processes 'Launch', 'AZRebalance'
      #
      # @param [Array<String>] processes A list of process to resume.
      #
      # @return [nil]
      #
      def resume_processes *processes
        client_opts = {}
        client_opts[:auto_scaling_group_name] = name
        client_opts[:scaling_processes] = processes.flatten
        client.resume_processes(client_opts)
        nil
      end

      # Resumes all processes for this Auto Scaling group.
      # @return [nil]
      def resume_all_processes
        resume_processes
      end

      # @param [Array<String>] metrics A list of metrics to collect.
      # @return [nil]
      def enable_metrics_collection *metrics
        client_opts = {}
        client_opts[:auto_scaling_group_name] = name
        client_opts[:granularity] = '1Minute'
        client_opts[:metrics] = metrics.flatten
        client.enable_metrics_collection(client_opts)
        nil
      end

      # Enables all metrics collection for the Auto Scaling group.
      # @return [nil]
      def enable_all_metrics_collection
        enable_metrics_collection
      end

      # @param [Array<String>] metrics A list of metrics to collect.
      # @return [nil]
      def disable_metrics_collection *metrics
        client_opts = {}
        client_opts[:auto_scaling_group_name] = name
        client_opts[:metrics] = metrics.flatten
        client.disable_metrics_collection(client_opts)
        nil
      end

      # Disables all metrics collection for the Auto Scaling group.
      # @return [nil]
      def disable_all_metrics_collection
        disable_metrics_collection
      end

      # Update one or more attributes on the Auto Scaling group.
      #
      # @param (see GroupOptions#group_options)
      #
      # @option (see GroupOptions#group_options)
      #
      # @return [nil]
      #
      def update options = {}

        group_opts = group_options(options)

        # tags must be updated using a separate request from the
        # other attributes, *sigh*
        if tags = group_opts.delete(:tags)
          tags.map(&:to_hash).each do |tag|
            tag[:resource_type] = 'auto-scaling-group'
            tag[:resource_id] = name
          end
          client.create_or_update_tags(:tags => tags)
        end

        unless group_opts.empty?
          client_opts = group_opts.merge(:auto_scaling_group_name => name)
          client.update_auto_scaling_group(client_opts)
        end

        nil

      end

      # Deletes specific tags from this Auto Scaling group.
      #
      #     group.delete_tags([
      #       { :key => 'role', :value => 'webserver' },
      #     ])
      #
      # You may also pass {Tag} objects.
      #
      # @param [Array<Tag,Hash>] tags An array of {Tag} objects or
      #   tag hashes to remove. If you pass hashes they should have
      #   the following keys:
      #     * `:key`
      #     * `:value`
      #     * `:propagate_at_launch`
      #
      # @return [nil]
      #
      def delete_tags *tags
        tags = tags.flatten.collect do |tag|
          tag.to_hash.merge(
            :resource_type => 'auto-scaling-group',
            :resource_id => name)
        end
        client.delete_tags(:tags => tags)
        nil
      end

      # Removes all tags from this Auto Scaling group.
      # @return [nil]
      def delete_all_tags
        delete_tags(self.tags)
        nil
      end

      # Deletes the Auto Scaling group.  If you pass `:force` as true
      # then all the instances associated with this group will also
      # be terminated.
      #
      # @see #delete!
      #
      # @param [Hash] options
      #
      # @option options [Boolean] :force (false) When true, the Auto Scaling
      #   group will be deleted along with all instances associated with
      #   the group, without waiting for all instances to be terminated.
      #
      # @return [nil]
      #
      def delete options = {}
        client_opts = {}
        client_opts[:force_delete] = options[:force] == true
        client_opts[:auto_scaling_group_name] = name
        client.delete_auto_scaling_group(client_opts)
        nil
      end

      # Deletes the Auto Scaling group along with all instances
      # associated with the group, without waiting for all instances
      # to be terminated.
      # @return [nil]
      def delete!
        delete(:force => true)
        nil
      end

      # @return [Boolean]
      def exists?
        client_opts = {}
        client_opts[:auto_scaling_group_names] = [name]
        resp = client.describe_auto_scaling_groups(client_opts)
        !resp.auto_scaling_groups.empty?
      end

      protected

      def resource_identifiers
        [[:name, name]]
      end

      def get_resource attr_name = nil
        client.describe_auto_scaling_groups(:auto_scaling_group_names => [name])
      end

    end
  end
end