Methods

Class/Module Index [+]

Quicksearch

Fog::Compute::AWS::DhcpOptions

Public Class Methods

new(attributes) click to toggle source
Creates a new dhcp option

AWS.dhcp_options.new

==== Returns

Returns the details of the new DHCP options

>> AWS.dhcp_options.new

> <Fog::Compute::AWS::DhcpOption

id=nil, dhcp_configuration_set=nil, tag_set=nil >

# File lib/fog/aws/models/compute/dhcp_options.rb, line 30
def initialize(attributes)
  self.filters ||= {}
  super
end

Public Instance Methods

all(filters = filters) click to toggle source
Returns an array of all DhcpOptions that have been created

AWS.dhcp_options.all

==== Returns

Returns an array of all DhcpOptions

>> AWS.dhcp_options.all <Fog::Compute::AWS::DhcpOptions filters={} [ <Fog::Compute::AWS::DhcpOption id="dopt-some-id", dhcp_configuration_set={"vpcId"=>"vpc-some-id", "state"=>"available"}, tag_set={} > ] >

# File lib/fog/aws/models/compute/dhcp_options.rb, line 56
def all(filters = filters)
  unless filters.is_a?(Hash)
    Fog::Logger.warning("all with #{filters.class} param is deprecated, use all('internet-gateway-id' => []) instead [light_black](#{caller.first})[/]")
    filters = {'dhcp-options-id' => [*filters]}
  end
  self.filters = filters
  data = service.describe_dhcp_options(filters).body
  load(data['dhcpOptionsSet'])
end
get(dhcp_options_id) click to toggle source
Used to retrieve an DhcpOption

You can run the following command to get the details:
AWS.dhcp_options.get("dopt-12345678")

==== Returns

>> AWS.dhcp_options.get("dopt-12345678")

> <Fog::Compute::AWS::DhcpOption

id="dopt-12345678", dhcp_configuration_set={"vpcId"=>"vpc-12345678", "state"=>"available"}, tag_set={} >

# File lib/fog/aws/models/compute/dhcp_options.rb, line 81
def get(dhcp_options_id)
  if dhcp_options_id
    self.class.new(:service => service).all('dhcp-options-id' => dhcp_options_id).first
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.