class Aws::AutoScaling::Tag
Public Class Methods
@overload def initialize(key, resource_id
, resource_type
, options = {})
@param [String] key @param [String] resource_id @param [String] resource_type @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :key @option options [required, String] :resource_id @option options [required, String] :resource_type @option options [Client] :client
# File lib/aws-sdk-autoscaling/tag.rb, line 26 def initialize(*args) options = Hash === args.last ? args.pop.dup : {} @key = extract_key(args, options) @resource_id = extract_resource_id(args, options) @resource_type = extract_resource_type(args, options) @data = options.delete(:data) @client = options.delete(:client) || Client.new(options) @waiter_block_warned = false end
Public Instance Methods
@return [Client]
# File lib/aws-sdk-autoscaling/tag.rb, line 69 def client @client end
@example Request syntax with placeholder values
tag.create({ tags: [ # required { resource_id: "XmlString", resource_type: "XmlString", key: "TagKey", # required value: "TagValue", propagate_at_launch: false, }, ], })
@param [Hash] options ({}) @option options [required, Array<Types::Tag>] :tags
One or more tags.
@return [EmptyStructure]
# File lib/aws-sdk-autoscaling/tag.rb, line 226 def create(options = {}) options = Aws::Util.deep_merge(options, tags: [{ resource_type: @resource_type, resource_id: @resource_id, key: @key }]) resp = @client.create_or_update_tags(options) resp.data end
@return [Types::TagDescription]
Returns the data for this {Tag}. Calls {Client#describe_tags} if {#data_loaded?} is `false`.
# File lib/aws-sdk-autoscaling/tag.rb, line 98 def data load unless @data @data end
@return [Boolean]
Returns `true` if this resource is loaded. Accessing attributes or {#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-autoscaling/tag.rb, line 106 def data_loaded? !!@data end
@example Request syntax with placeholder values
tag.delete({ tags: [ # required { resource_id: "XmlString", resource_type: "XmlString", key: "TagKey", # required value: "TagValue", propagate_at_launch: false, }, ], })
@param [Hash] options ({}) @option options [required, Array<Types::Tag>] :tags
One or more tags.
@return [EmptyStructure]
# File lib/aws-sdk-autoscaling/tag.rb, line 253 def delete(options = {}) options = Aws::Util.deep_merge(options, tags: [{ resource_type: @resource_type, resource_id: @resource_id, key: @key }]) resp = @client.delete_tags(options) resp.data end
@deprecated @api private
# File lib/aws-sdk-autoscaling/tag.rb, line 265 def identifiers { key: @key, resource_id: @resource_id, resource_type: @resource_type } end
@return [String]
# File lib/aws-sdk-autoscaling/tag.rb, line 39 def key @key end
Loads, or reloads {#data} for the current {Tag}. Returns `self` making it possible to chain methods.
tag.reload.data
@return [self]
# File lib/aws-sdk-autoscaling/tag.rb, line 79 def load resp = @client.describe_tags(filters: [ { name: "key", values: [@key] }, { name: @resource_type, values: [@resource_id] } ]) @data = resp.tags[0] self end
Determines whether the tag is added to new instances as they are launched in the group. @return [Boolean]
# File lib/aws-sdk-autoscaling/tag.rb, line 62 def propagate_at_launch data[:propagate_at_launch] end
@return [String]
# File lib/aws-sdk-autoscaling/tag.rb, line 44 def resource_id @resource_id end
@return [String]
# File lib/aws-sdk-autoscaling/tag.rb, line 49 def resource_type @resource_type end
The tag value. @return [String]
# File lib/aws-sdk-autoscaling/tag.rb, line 55 def value data[:value] end
@deprecated Use [Aws::AutoScaling::Client] wait_until
instead
Waiter polls an API operation until a resource enters a desired state.
@note The waiting operation is performed on a copy. The original resource
remains unchanged.
## Basic Usage
Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop until condition is true resource.wait_until(options) {|resource| condition}
## Example
instance.wait_until(max_attempts:10, delay:5) do |instance| instance.state.name == 'running' end
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to {#wait_until}:
# poll for ~25 seconds resource.wait_until(max_attempts:5,delay:5) {|resource|...}
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw `:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now # poll for 1 hour, instead of a number of attempts proc = Proc.new do |attempts, response| throw :failure if Time.now - started_at > 3600 end # disable max attempts instance.wait_until(before_wait:proc, max_attempts:nil) {...}
## Handling Errors
When a waiter is successful, it returns the Resource
. When a waiter fails, it raises an error.
begin resource.wait_until(...) rescue Aws::Waiters::Errors::WaiterFailed # resource did not enter the desired state in time end
@yieldparam [Resource] resource to be used in the waiting condition.
@raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
terminates because the waiter has entered a state that it will not transition out of, preventing success. yet successful.
@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
encountered while polling for a resource that is not expected.
@raise [NotImplementedError] Raised when the resource does not
@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful
# File lib/aws-sdk-autoscaling/tag.rb, line 190 def wait_until(options = {}, &block) self_copy = self.dup attempts = 0 options[:max_attempts] = 10 unless options.key?(:max_attempts) options[:delay] ||= 10 options[:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == options[:max_attempts] :retry end end Aws::Waiters::Waiter.new(options).wait({}) end
Private Instance Methods
# File lib/aws-sdk-autoscaling/tag.rb, line 276 def extract_key(args, options) value = args[0] || options.delete(:key) case value when String then value when nil then raise ArgumentError, "missing required option :key" else msg = "expected :key to be a String, got #{value.class}" raise ArgumentError, msg end end
# File lib/aws-sdk-autoscaling/tag.rb, line 287 def extract_resource_id(args, options) value = args[1] || options.delete(:resource_id) case value when String then value when nil then raise ArgumentError, "missing required option :resource_id" else msg = "expected :resource_id to be a String, got #{value.class}" raise ArgumentError, msg end end
# File lib/aws-sdk-autoscaling/tag.rb, line 298 def extract_resource_type(args, options) value = args[2] || options.delete(:resource_type) case value when String then value when nil then raise ArgumentError, "missing required option :resource_type" else msg = "expected :resource_type to be a String, got #{value.class}" raise ArgumentError, msg end end