Class: Fog::DNS::AWS::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::DNS::AWS.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.

change_resource_record_sets(zone_id, change_batch, options = {})

Use this action to create or change your authoritative DNS information for a zone docs.amazonwebservices.com/Route53/latest/DeveloperGuide/RRSchanges.html#RRSchanges_API

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> - Time-to-live value - omit if using an alias record
  - weight<~Integer> - Time-to-live value - omit if using an alias record
  - set_identifier<~String> - An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.
  - region<~String> - The Amazon EC2 region where the resource that is specified in this resource record set resides. (Latency only)
  - failover<~String> - To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY.
  - geo_location<~String XML> - A complex type currently requiring XML that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query.
  - health_check_id<~String> - If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include the HealthCheckId element and specify the ID of the applicable health check.
  - 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)
    - 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
    - evaluate_target_health<~Boolean> - Applies only to alias, weighted alias, latency alias, and failover alias resource record sets: If you set the value of EvaluateTargetHealth to true, the alias resource record sets inherit the health of the referenced resource record sets.

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> - 200 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)

create_health_check(ip_address, port, type, options = {})

This action creates a new health check. docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHealthCheck.html

Parameters (options as symbols Hash)

ip_address<~String> - (optional if fqdn) The IPv4 IP address of the endpoint on which you want Amazon Route 53 to perform health checks
port<~Integer> - The port on the endpoint on which you want Amazon Route 53 to perform health checks
type<~String> - HTTP | HTTPS | HTTP_STR_MATCH | HTTPS_STR_MATCH | TCP
resource_path<~Stringy> - (required for all types except TCP) The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy
fqdn<~String> - (optional if ip_address) The value that you want Amazon Route 53 to pass in the Host header in all health checks except TCP health checks
search_string<~String> - If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource
request_interval<~String> - 10 | 30 (optional) The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request
failure_threshold<~Integer> - 1-10 (optional) The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa

Returns

response<~Excon::Response>:
- body<~Hash>:
  - ‘HealthCheck’<~Hash>
    - ‘Id’<~String> - The ID of the request
    - ‘CallerReference’<~String> - A unique string that identifies the request and that allows failed CreateHealthCheck requests to be retried without the risk of executing the operation twice.
    - ‘HealthCheckConfig’<~Hash>
      - ‘IPAddress‘
      - ‘Port‘
      - ‘Type‘
      - ‘ResourcePath‘
      - ‘FullyQualifiedDomainName‘
      - ‘RequestInterval‘
      - ‘FailureThreshold‘
- status<~Integer> - 201 when successful

create_hosted_zone(name, options = {})

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<~String> -
- vpc_id<~String> - specify both a VPC‘s ID and its region to create a private zone for that VPC
- vpc_region<~String> - specify both a VPC‘s ID and its region to create a private zone for that VPC

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

delete_health_check(id)

This action deletes a health check. docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteHealthCheck.html

Parameters

id<~String> - Health check ID

Returns

response<~Excon::Response>:
- status<~Integer> - 200 when successful

delete_hosted_zone(zone_id)

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

get_change(change_id)

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

get_health_check(id)

 This action gets information about a specified health check.

docs.aws.amazon.com/Route53/latest/APIReference/API_GetHealthCheck.html

 ==== Parameters
 * id<~String> - The ID of the health check

 ==== Returns
 * response<~Excon::Response>:
   * body<~Hash>:
     * 'HealthCheck'<~Hash>:
       * 'Id'<~String> -
       * 'CallerReference'<~String>
       * 'HealthCheckConfig'<~Hash>:
         * 'IPAddress'<~String> -
         * 'Port'<~String> -
         * 'Type'<~String> -
         * 'ResourcePath'<~String> -
         * 'FullyQualifiedDomainName'<~String> -
         * 'SearchString'<~String> -
         * 'RequestInterval'<~Integer> -
         * 'FailureThreshold'<~String> -
       * 'HealthCheckVersion'<~Integer> -
   * status<~Integer> - 200 when successful

get_hosted_zone(zone_id)

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> - 200 when successful

list_health_checks()

This action gets a list of the health checks that are associated with the current AWS account. docs.aws.amazon.com/Route53/latest/APIReference/API_ListHealthChecks.html

Returns

response<~Excon::Response>:
- body<~Hash>:
  - ‘HealthChecks’<~Array>:
    - ‘HealthCheck’<~Hash>:
      - ‘Id’<~String> -
      - ‘CallerReference’<~String>
      - ‘HealthCheckVersion’<~Integer> -
  - ‘Marker’<~String> -
  - ‘MaxItems’<~Integer> -
  - ‘IsTruncated’<~String> -
  - ‘NextMarker’<~String>
- status<~Integer> - 200 when successful

list_hosted_zones(options = {})

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> -
  - ‘NextMarker’<~String>
- status<~Integer> - 200 when successful

list_resource_record_sets(zone_id, options = {})

list your resource record sets

Parameters

zone_id<~String> -
options<~Hash>
- type<~String> -
- name<~String> -
- identifier<~String> -
- max_items<~Integer> -

Returns

response<~Excon::Response>:
- body<~Hash>:
  - ‘ResourceRecordSet’<~Array>:
    - ‘Name’<~String> -
    - ‘Type’<~String> -
    - ‘TTL’<~Integer> -
    - ‘AliasTarget’<~Hash> -
      - ‘HostedZoneId’<~String> -
      - ‘DNSName’<~String> -
    - ‘ResourceRecords’<~Array>
      - ‘Value’<~String> -
  - ‘IsTruncated’<~String> -
  - ‘MaxItems’<~String> -
  - ‘NextRecordName’<~String>
  - ‘NextRecordType’<~String>
  - ‘NextRecordIdentifier’<~String>
- status<~Integer> - 201 when successful

reload()

Methods

Included Modules

Public Class methods

Notes

Examples

Parameters

Returns

Public Instance methods

Parameters

Returns

Examples

Parameters (options as symbols Hash)

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns