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

Class: Aws::AutoScaling::Tag

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

Defined Under Namespace

Classes: Collection

Actions collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(key, resource_id, resource_type, options = {}) ⇒ Tag #initialize(options = {}) ⇒ Tag

Returns a new instance of Tag

Overloads:

  • #initialize(key, resource_id, resource_type, options = {}) ⇒ Tag

    Parameters:

    • key (String)
    • resource_id (String)
    • resource_type (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Tag

    Options Hash (options):

    • :key (required, String)
    • :resource_id (required, String)
    • :resource_type (required, String)
    • :client (Client)


23
24
25
26
27
28
29
30
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/tag.rb', line 23

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)
end

Instance Method Details

#clientClient

Returns:



65
66
67
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/tag.rb', line 65

def client
  @client
end

#create(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


tag.create({
  tags: [ # required
    {
      resource_id: "XmlString",
      resource_type: "XmlString",
      key: "TagKey", # required
      value: "TagValue",
      propagate_at_launch: false,
    },
  ],
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :tags (required, Array<Types::Tag>)

    One or more tags.

Returns:

  • (EmptyStructure)


220
221
222
223
224
225
226
227
228
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/tag.rb', line 220

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

#dataTypes::TagDescription

Returns the data for this Aws::AutoScaling::Tag. Calls Client#describe_tags if #data_loaded? is false.

Returns:



94
95
96
97
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/tag.rb', line 94

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



102
103
104
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/tag.rb', line 102

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


tag.delete({
  tags: [ # required
    {
      resource_id: "XmlString",
      resource_type: "XmlString",
      key: "TagKey", # required
      value: "TagValue",
      propagate_at_launch: false,
    },
  ],
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :tags (required, Array<Types::Tag>)

    One or more tags.

Returns:

  • (EmptyStructure)


247
248
249
250
251
252
253
254
255
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/tag.rb', line 247

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

#keyString

Returns:

  • (String)


35
36
37
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/tag.rb', line 35

def key
  @key
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::AutoScaling::Tag. Returns self making it possible to chain methods.

tag.reload.data

Returns:

  • (self)


75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/tag.rb', line 75

def load
  resp = @client.describe_tags(filters: [
    {
      name: "key",
      values: [@key]
    },
    {
      name: @resource_type,
      values: [@resource_id]
    }
  ])
  @data = resp.tags[0]
  self
end

#propagate_at_launchBoolean

Determines whether the tag is added to new instances as they are launched in the group.

Returns:

  • (Boolean)


58
59
60
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/tag.rb', line 58

def propagate_at_launch
  data[:propagate_at_launch]
end

#resource_idString

Returns:

  • (String)


40
41
42
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/tag.rb', line 40

def resource_id
  @resource_id
end

#resource_typeString

Returns:

  • (String)


45
46
47
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/tag.rb', line 45

def resource_type
  @resource_type
end

#valueString

The tag value.

Returns:

  • (String)


51
52
53
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/tag.rb', line 51

def value
  data[:value]
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::AutoScaling::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged

Waiter polls an API operation until a resource enters a desired state.

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) {|instance| instance.state.name == 'running' }

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

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (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.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/tag.rb', line 184

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