Class: Aws::EC2::DhcpOptions

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options = {}) ⇒ DhcpOptions #initialize(options = {}) ⇒ DhcpOptions

Returns a new instance of DhcpOptions.

Overloads:

  • #initialize(id, options = {}) ⇒ DhcpOptions

    Parameters:

    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ DhcpOptions

    Options Hash (options):

    • :id (required, String)
    • :client (Client) 


22
23
24
25
26
27
28
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/dhcp_options.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @id = extract_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#associate_with_vpc(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


dhcp_options.associate_with_vpc({
  vpc_id: "VpcId", # required
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :vpc_id (required, String) —

    The ID of the VPC.

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

Returns:

  • (EmptyStructure) 


210
211
212
213
214
215
216
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/dhcp_options.rb', line 210

def associate_with_vpc(options = {})
  options = options.merge(dhcp_options_id: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.associate_dhcp_options(options)
  end
  resp.data
end

#client ⇒ Client

Returns:



60
61
62
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/dhcp_options.rb', line 60

def client
  @client
end

#create_tags(options = {}) ⇒ Tag::Collection

Examples:

Request syntax with placeholder values


tag = dhcp_options.create_tags({
  dry_run: false,
  tags: [ # required
    {
      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 (required, Array<Types::Tag>) —

    The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

Returns:



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/dhcp_options.rb', line 240

def create_tags(options = {})
  batch = []
  options = Aws::Util.deep_merge(options, resources: [@id])
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.create_tags(options)
  end
  options[:tags].each do |t|
    batch << Tag.new(
      resource_id: @id,
      key: t[:key],
      value: t[:value],
      client: @client
    )
  end
  Tag::Collection.new([batch], size: batch.size)
end

#data ⇒ Types::DhcpOptions

Returns the data for this Aws::EC2::DhcpOptions. Calls Client#describe_dhcp_options if #data_loaded? is false.

Returns:



82
83
84
85
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/dhcp_options.rb', line 82

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.



90
91
92
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/dhcp_options.rb', line 90

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


dhcp_options.delete({
  dry_run: false,
})

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.

Returns:

  • (EmptyStructure) 


316
317
318
319
320
321
322
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/dhcp_options.rb', line 316

def delete(options = {})
  options = options.merge(dhcp_options_id: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_dhcp_options(options)
  end
  resp.data
end

#delete_tags(options = {}) ⇒ Tag::Collection

Examples:

Request syntax with placeholder values


tag = dhcp_options.delete_tags({
  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:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/dhcp_options.rb', line 287

def delete_tags(options = {})
  batch = []
  options = Aws::Util.deep_merge(options, resources: [@id])
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_tags(options)
  end
  options[:tags].each do |t|
    batch << Tag.new(
      resource_id: @id,
      key: t[:key],
      value: t[:value],
      client: @client
    )
  end
  Tag::Collection.new([batch], size: batch.size)
end

#dhcp_configurations ⇒ Array<Types::DhcpConfiguration>

The DHCP options in the set.

Returns:



53
54
55
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/dhcp_options.rb', line 53

def dhcp_configurations
  data[:dhcp_configurations]
end

#id ⇒ String Also known as: dhcp_options_id

Returns:

  • (String) 


33
34
35
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/dhcp_options.rb', line 33

def id
  @id
end

#load ⇒ self Also known as: reload

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

dhcp_options.reload.data

Returns:

  • (self) 


70
71
72
73
74
75
76
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/dhcp_options.rb', line 70

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.describe_dhcp_options(dhcp_options_ids: [@id])
  end
  @data = resp.dhcp_options[0]
  self
end

#owner_id ⇒ String

The ID of the Amazon Web Services account that owns the DHCP options set.

Returns:

  • (String) 


41
42
43
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/dhcp_options.rb', line 41

def owner_id
  data[:owner_id]
end

#tags ⇒ Array<Types::Tag>

Any tags assigned to the DHCP options set.

Returns:



47
48
49
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/dhcp_options.rb', line 47

def tags
  data[:tags]
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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/dhcp_options.rb', line 174

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.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end