kotovalexarian-likes-github/fog--fog
1
0
Fork 0
mirror of https://github.com/fog/fog.git synced 2022-11-09 13:51:43 -05:00
Code Releases Activity

Correct docs for change_resource_record_sets

Browse source 
I came across errors in the docs for the change_resource_record_sets
method. I've updated the docs for the method and provided an example of
using it.
This commit is contained in:
Gavin Sandie 2012-04-26 17:27:48 +01:00
parent 282ee0fb20
commit d45ce70c9b
1 changed files with 35 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
lib/fog/aws/requests/dns/change_resource_record_sets.rb
View file

@ -6,22 +6,22 @@ module Fog
require 'fog/aws/parsers/dns/change_resource_record_sets' require 'fog/aws/parsers/dns/change_resource_record_sets'
# Use this action to create or change your authoritative DNS information for a zone # Use this action to create or change your authoritative DNS information for a zone
# http://docs.amazonwebservices.com/Route53/latest/DeveloperGuide/RRSchanges.html#RRSchanges_API
# #
# ==== Parameters # ==== Parameters
# * zone_id<~String> - ID of the zone these changes apply to # * zone_id<~String> - ID of the zone these changes apply to
# * options<~Hash> # * options<~Hash>
# * comment<~String> - Any comments you want to include about the change. # * comment<~String> - Any comments you want to include about the change.
# * change_batch<~Array> - The information for a change request # * change_batch<~Array> - The information for a change request
# * changes<~Hash> - # * changes<~Hash> -
# * action<~String> - 'CREATE' or 'DELETE' # * action<~String> - 'CREATE' or 'DELETE'
# * name<~String> - This must be a fully-specified name, ending with a final period # * 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 # * type<~String> - A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT
# * ttl<~Integer> - Time-to-live value - omit if using an alias record # * ttl<~Integer> - Time-to-live value - omit if using an alias record
# * resource_record<~String> - Omit if using an alias record # * resource_records<~Array> - Omit if using an alias record
# * alias_target<~Hash> - Information about the domain to which you are redirecting traffic (Alias record sets only) # * alias_target<~Hash> - Information about the domain to which you are redirecting traffic (Alias record sets only)
# * dns_name<~String> - The Elastic Load Balancing domain to which you want to reroute traffic # * dns_name<~String> - The Elastic Load Balancing domain to which you want to reroute traffic
# * hosted_zone_id<~String> - The ID of the hosted zone that contains the Elastic Load Balancing domain to which you want to reroute traffic # * hosted_zone_id<~String> - The ID of the hosted zone that contains the Elastic Load Balancing domain to which you want to reroute traffic
#
# ==== Returns # ==== Returns
# * response<~Excon::Response>: # * response<~Excon::Response>:
# * body<~Hash>: # * body<~Hash>:
@ -30,6 +30,30 @@ module Fog
# * 'Status'<~String> - status of the request - PENDING | INSYNC # * 'Status'<~String> - status of the request - PENDING | INSYNC
# * 'SubmittedAt'<~String> - The date and time the change was made # * 'SubmittedAt'<~String> - The date and time the change was made
# * status<~Integer> - 201 when successful # * status<~Integer> - 201 when successful
#
# ==== Examples
#
# Example changing a CNAME record:
#
# change_batch_options = [
# {
# :action => "DELETE",
# :name => "foo.example.com.",
# :type => "CNAME",
# :ttl => 3600,
# :resource_records => [ "baz.example.com." ]
# },
# {
# :action => "CREATE",
# :name => "foo.example.com.",
# :type => "CNAME",
# :ttl => 3600,
# :resource_records => [ "bar.example.com." ]
# }
# ]
#
# change_resource_record_sets("ABCDEFGHIJKLMN", change_batch_options)
#
def change_resource_record_sets(zone_id, change_batch, options = {}) def change_resource_record_sets(zone_id, change_batch, options = {})
# AWS methods return zone_ids that looks like '/hostedzone/id'. Let the caller either use # AWS methods return zone_ids that looks like '/hostedzone/id'. Let the caller either use