Class: Aws::EC2::Tag

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-ec2/tag.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Tag.

Overloads:

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

    Parameters:

    • resource_id (String)
    • key (String)
    • value (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Tag

    Options Hash (options):

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


26
27
28
29
30
31
32
33
34
 
# File 'lib/aws-sdk-ec2/tag.rb', line 26

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @resource_id = extract_resource_id(args, options)
  @key = extract_key(args, options)
  @value = extract_value(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#client ⇒ Client

Returns:



62
63
64
 
# File 'lib/aws-sdk-ec2/tag.rb', line 62

def client
  @client
end

#data ⇒ Types::TagDescription

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

Returns:



93
94
95
96
 
# File 'lib/aws-sdk-ec2/tag.rb', line 93

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.



101
102
103
 
# File 'lib/aws-sdk-ec2/tag.rb', line 101

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


tag.delete({
  dry_run: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ‘DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

  • :tags (Array<Types::Tag>) —

    The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

    If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the ‘aws:` prefix).

    Constraints: Up to 1000 tags.

Returns:

  • (EmptyStructure) 


236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/aws-sdk-ec2/tag.rb', line 236

def delete(options = {})
  options = Aws::Util.deep_merge(options,
    resources: [@resource_id],
    tags: [{
      key: @key,
      value: @value
    }]
  )
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.delete_tags(options)
  end
  resp.data
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


252
253
254
255
256
257
258
 
# File 'lib/aws-sdk-ec2/tag.rb', line 252

def identifiers
  {
    resource_id: @resource_id,
    key: @key,
    value: @value
  }
end

#key ⇒ String

Returns:

  • (String) 


44
45
46
 
# File 'lib/aws-sdk-ec2/tag.rb', line 44

def key
  @key
end

#load ⇒ self Also known as: reload

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

tag.reload.data

Returns:

  • (self) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/aws-sdk-ec2/tag.rb', line 72

def load
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.describe_tags(filters: [
    {
      name: "key",
      values: [@key]
    },
    {
      name: "value",
      values: [@value]
    }
  ])
  end
  @data = resp.tags[0]
  self
end

#resource_id ⇒ String

Returns:

  • (String) 


39
40
41
 
# File 'lib/aws-sdk-ec2/tag.rb', line 39

def resource_id
  @resource_id
end

#resource_type ⇒ String

The resource type.

Returns:

  • (String) 


55
56
57
 
# File 'lib/aws-sdk-ec2/tag.rb', line 55

def resource_type
  data[:resource_type]
end

#value ⇒ String

Returns:

  • (String) 


49
50
51
 
# File 'lib/aws-sdk-ec2/tag.rb', line 49

def value
  @value
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::EC2::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) 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

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

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

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



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

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::Plugins::UserAgent.feature('resource') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end