Class: Fog::AWS::DNS::Real
- Inherits:
-
Object
- Object
- Fog::AWS::DNS::Real
- Defined in:
- lib/fog/dns/aws.rb,
lib/fog/dns/requests/aws/get_change.rb,
lib/fog/dns/requests/aws/get_hosted_zone.rb,
lib/fog/dns/requests/aws/list_hosted_zones.rb,
lib/fog/dns/requests/aws/create_hosted_zone.rb,
lib/fog/dns/requests/aws/delete_hosted_zone.rb,
lib/fog/dns/requests/aws/list_resource_record_sets.rb,
lib/fog/dns/requests/aws/change_resource_record_sets.rb
Instance Method Summary collapse
-
#change_resource_record_sets(zone_id, change_batch, options = {}) ⇒ Object
Use this action to create or change your authoritative DNS information for a zone.
-
#create_hosted_zone(name, options = {}) ⇒ Object
Creates a new hosted zone.
-
#delete_hosted_zone(zone_id) ⇒ Object
Delete a hosted zone.
-
#get_change(change_id) ⇒ Object
returns the current state of a change request.
-
#get_hosted_zone(zone_id) ⇒ Object
retrieve information about a hosted zone.
-
#initialize(options = {}) ⇒ Real
constructor
Initialize connection to Route 53 DNS service.
-
#list_hosted_zones(options = {}) ⇒ Object
Describe all or specified instances.
-
#list_resource_record_sets(zone_id, options = {}) ⇒ Object
list your resource record sets.
- #reload ⇒ Object
Constructor Details
#initialize(options = {}) ⇒ Real
Initialize connection to Route 53 DNS service
Notes
options parameter must include values for :aws_access_key_id and :aws_secret_access_key in order to create a connection
Examples
dns = Fog::AWS::DNS.new(
:aws_access_key_id => your_aws_access_key_id,
:aws_secret_access_key => your_aws_secret_access_key
)
Parameters
-
options<~Hash> - config arguments for connection. Defaults to {}.
Returns
-
dns object with connection to aws.
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/fog/dns/aws.rb', line 79 def initialize(={}) unless .delete(:provider) location = caller.first warning = "[yellow][WARN] Fog::AWS::DNS.new is deprecated, use Fog::DNS.new(:provider => 'DNS') instead[/]" warning << " [light_black](" << location << ")[/] " Formatador.display_line(warning) end @aws_access_key_id = [:aws_access_key_id] @aws_secret_access_key = [:aws_secret_access_key] @hmac = Fog::HMAC.new('sha1', @aws_secret_access_key) @host = [:host] || 'route53.amazonaws.com' @path = [:path] || '/' @port = [:port] || 443 @scheme = [:scheme] || 'https' @version = [:version] || '2010-10-01' @connection = Fog::Connection.new("#{@scheme}://#{@host}:#{@port}#{@path}", [:persistent] || true) end |
Instance Method Details
#change_resource_record_sets(zone_id, change_batch, options = {}) ⇒ Object
Use this action to create or change your authoritative DNS information for a zone
Parameters
-
zone_id<~String> - ID of the zone these changes apply to
-
options<~Hash>
-
comment<~String> - Any comments you want to include about the change.
-
change_batch<~Array> - The information for a change request
-
changes<~Hash> -
-
action<~String> - ‘CREATE’ or ‘DELETE’
-
name<~String> - This must be a fully-specified name, ending with a final period
-
type<~String> - A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT
-
ttl<~Integer> -
-
resource_record<~String>
-
-
-
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ChangeInfo’<~Hash>
-
‘Id’<~String> - The ID of the request
-
‘Status’<~String> - status of the request - PENDING | INSYNC
-
‘SubmittedAt’<~String> - The date and time the change was made
-
-
-
status<~Integer> - 201 when successful
-
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/fog/dns/requests/aws/change_resource_record_sets.rb', line 30 def change_resource_record_sets(zone_id, change_batch, = {}) # AWS methods return zone_ids that looks like '/hostedzone/id'. Let the caller either use # that form or just the actual id (which is what this request needs) zone_id = zone_id.sub('/hostedzone/', '') = '' .each { |option, value| case option when :comment += "<Comment>#{value}</Comment>" end } #build XML if change_batch.count > 0 changes= "<ChangeBatch>#{}<Changes>" change_batch.each { |change_item| action_tag = %Q{<Action>#{change_item[:action]}</Action>} name_tag = %Q{<Name>#{change_item[:name]}</Name>} type_tag = %Q{<Type>#{change_item[:type]}</Type>} ttl_tag = %Q{<TTL>#{change_item[:ttl]}</TTL>} resource_records= change_item[:resource_records] = '' resource_records.each { |record| += %Q{<ResourceRecord><Value>#{record}</Value></ResourceRecord>} } resource_tag= %Q{<ResourceRecords>#{}</ResourceRecords>} = %Q{<Change>#{action_tag}<ResourceRecordSet>#{name_tag}#{type_tag}#{ttl_tag}#{resource_tag}</ResourceRecordSet></Change>} changes+= } changes+= '</Changes></ChangeBatch>' end body = %Q{<?xml version="1.0" encoding="UTF-8"?><ChangeResourceRecordSetsRequest xmlns="https://route53.amazonaws.com/doc/2010-10-01/">#{changes}</ChangeResourceRecordSetsRequest>} request({ :body => body, :parser => Fog::Parsers::AWS::DNS::ChangeResourceRecordSets.new, :expects => 200, :method => 'POST', :path => "hostedzone/#{zone_id}/rrset" }) end |
#create_hosted_zone(name, options = {}) ⇒ Object
Creates a new hosted zone
Parameters
-
name<~String> - The name of the domain. Must be a fully-specified domain that ends with a period
-
options<~Hash>
-
caller_ref<~String> - unique string that identifies the request & allows failed
calls to be retried without the risk of executing the operation twice
-
comment<~Integer> -
-
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘HostedZone’<~Hash>:
-
‘Id’<~String> -
-
‘Name’<~String> -
-
‘CallerReference’<~String>
-
‘Comment’<~String> -
-
-
‘ChangeInfo’<~Hash> -
-
‘Id’<~String>
-
‘Status’<~String>
-
‘SubmittedAt’<~String>
-
-
‘NameServers’<~Array>
-
‘NameServer’<~String>
-
-
-
status<~Integer> - 201 when successful
-
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/fog/dns/requests/aws/create_hosted_zone.rb', line 32 def create_hosted_zone(name, = {}) = '' if [:caller_ref] += "<CallerReference>#{[:call_ref]}</CallerReference>" else #make sure we have a unique call reference caller_ref = "ref-#{rand(1000000).to_s}" += "<CallerReference>#{caller_ref}</CallerReference>" end if [:comment] += "<HostedZoneConfig><Comment>#{[:comment]}</Comment></HostedZoneConfig>" end request({ :body => %Q{<?xml version="1.0" encoding="UTF-8"?><CreateHostedZoneRequest xmlns="https://route53.amazonaws.com/doc/2010-10-01/"><Name>#{name}</Name>#{}</CreateHostedZoneRequest>}, :parser => Fog::Parsers::AWS::DNS::CreateHostedZone.new, :expects => 201, :method => 'POST', :path => "hostedzone" }) end |
#delete_hosted_zone(zone_id) ⇒ Object
Delete a hosted zone
Parameters
-
zone_id<~String> -
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ChangeInfo’<~Hash> -
-
‘Id’<~String> The ID of the request
-
‘Status’<~String> The current state of the hosted zone
-
‘SubmittedAt’<~String> The date and time the change was made
-
-
-
status<~Integer> - 200 when successful
-
21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
# File 'lib/fog/dns/requests/aws/delete_hosted_zone.rb', line 21 def delete_hosted_zone(zone_id) # AWS methods return zone_ids that looks like '/hostedzone/id'. Let the caller either use # that form or just the actual id (which is what this request needs) zone_id = zone_id.sub('/hostedzone/', '') request({ :expects => 200, :parser => Fog::Parsers::AWS::DNS::DeleteHostedZone.new, :method => 'DELETE', :path => "hostedzone/#{zone_id}" }) end |
#get_change(change_id) ⇒ Object
returns the current state of a change request
Parameters
-
change_id<~String>
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘Id’<~String>
-
‘Status’<~String>
-
‘SubmittedAt’<~String>
-
-
status<~Integer> - 200 when successful
-
20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
# File 'lib/fog/dns/requests/aws/get_change.rb', line 20 def get_change(change_id) # AWS methods return change_ids that looks like '/change/id'. Let the caller either use # that form or just the actual id (which is what this request needs) change_id = change_id.sub('/change/', '') request({ :expects => 200, :parser => Fog::Parsers::AWS::DNS::GetChange.new, :method => 'GET', :path => "change/#{change_id}" }) end |
#get_hosted_zone(zone_id) ⇒ Object
retrieve information about a hosted zone
Parameters
-
zone_id<~String> - The ID of the hosted zone
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘HostedZone’<~Hash>:
-
‘Id’<~String> -
-
‘Name’<~String> -
-
‘CallerReference’<~String>
-
‘Comment’<~String> -
-
-
‘NameServers’<~Array>
-
‘NameServer’<~String>
-
-
-
status<~Integer> - 201 when successful
-
24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
# File 'lib/fog/dns/requests/aws/get_hosted_zone.rb', line 24 def get_hosted_zone(zone_id) # AWS methods return zone_ids that looks like '/hostedzone/id'. Let the caller either use # that form or just the actual id (which is what this request needs) zone_id = zone_id.sub('/hostedzone/', '') request({ :expects => 200, :parser => Fog::Parsers::AWS::DNS::GetHostedZone.new, :method => 'GET', :path => "hostedzone/#{zone_id}" }) end |
#list_hosted_zones(options = {}) ⇒ Object
Describe all or specified instances
Parameters
-
options<~Hash>
-
marker<~String> - Indicates where to begin in your list of hosted zones.
-
max_items<~Integer> - The maximum number of hosted zones to be included in the response body
-
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘HostedZones’<~Array>:
-
‘HostedZone’<~Hash>:
-
‘Id’<~String> -
-
‘Name’<~String> -
-
‘CallerReference’<~String>
-
‘Comment’<~String> -
-
-
-
‘Marker’<~String> -
-
‘MaxItems’<~Integer> -
-
‘IsTruncated’<~String> -
-
‘NextMarket’<~String>
-
-
status<~Integer> - 200 when successful
-
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/fog/dns/requests/aws/list_hosted_zones.rb', line 29 def list_hosted_zones( = {}) parameters = {} .each { |option, value| case option when :marker parameters[option] = value when :max_items parameters[:maxitems] = value end } request({ :query => parameters, :parser => Fog::Parsers::AWS::DNS::ListHostedZones.new, :expects => 200, :method => 'GET', :path => "hostedzone" }) end |
#list_resource_record_sets(zone_id, options = {}) ⇒ Object
list your resource record sets
Parameters
-
zone_id<~String> -
-
options<~Hash>
-
type<~String> -
-
name<~String> -
-
max_items<~Integer> -
-
Returns
-
response<~Excon::Response>:
-
body<~Hash>:
-
‘ResourceRecordSet’<~Array>:
-
‘Name’<~String> -
-
‘Type’<~String> -
-
‘TTL’<~Integer> -
-
‘ResourceRecords’<~Array>
-
‘Value’<~String> -
-
-
-
‘IsTruncated’<~String> -
-
‘MaxItems’<~String> -
-
‘NextRecordName’<~String>
-
‘NexRecordType’<~String>
-
-
status<~Integer> - 201 when successful
-
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/fog/dns/requests/aws/list_resource_record_sets.rb', line 31 def list_resource_record_sets(zone_id, = {}) # AWS methods return zone_ids that looks like '/hostedzone/id'. Let the caller either use # that form or just the actual id (which is what this request needs) zone_id = zone_id.sub('/hostedzone/', '') parameters = {} .each { |option, value| case option when :type, :name parameters[option]= "#{value}" when :max_items parameters['maxitems']= "#{value}" end } request({ :query => parameters, :parser => Fog::Parsers::AWS::DNS::ListResourceRecordSets.new, :expects => 200, :method => 'GET', :path => "hostedzone/#{zone_id}/rrset" }) end |
#reload ⇒ Object
98 99 100 |
# File 'lib/fog/dns/aws.rb', line 98 def reload @connection.reset end |