Class: AWS.Route53

Inherits:
AWS.Service show all
Identifier:
route53
API Version:
2013-04-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using Route53

var route53 = new AWS.Route53();
route53.associateVPCWithHostedZone(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Route53 object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var route53 = new AWS.Route53({apiVersion: '2013-04-01'});

You can also set the API version globally in AWS.config.apiVersions using the route53 service identifier:

AWS.config.apiVersions = {
  route53: '2013-04-01',
  // other service API versions
};

var route53 = new AWS.Route53();

Version:

  • 2013-04-01

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

resourceRecordSetsChanged

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, defineService

Constructor Details

new AWS.Route53(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Route53 object

var route53 = new AWS.Route53({apiVersion: '2013-04-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Route53.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Route53.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Route53.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateVPCWithHostedZone(params = {}, callback) ⇒ AWS.Request

Associates an Amazon VPC with a private hosted zone.

To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.

Note: If you want to associate a VPC that was created by using one AWS account with a private hosted zone that was created by using a different account, the AWS account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone request.

Service Reference:

Examples:

To associate a VPC with a hosted zone


/* The following example associates the VPC with ID vpc-1a2b3c4d with the hosted zone with ID Z3M3LMPEXAMPLE. */

 var params = {
  Comment: "", 
  HostedZoneId: "Z3M3LMPEXAMPLE", 
  VPC: {
   VPCId: "vpc-1a2b3c4d", 
   VPCRegion: "us-east-2"
  }
 };
 route53.associateVPCWithHostedZone(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeInfo: {
     Comment: "", 
     Id: "/change/C3HC6WDB2UANE2", 
     Status: "INSYNC", 
     SubmittedAt: <Date Representation>
    }
   }
   */
 });

Calling the associateVPCWithHostedZone operation

var params = {
  HostedZoneId: 'STRING_VALUE', /* required */
  VPC: { /* required */
    VPCId: 'STRING_VALUE',
    VPCRegion: us-east-1 | us-east-2 | us-west-1 | us-west-2 | eu-west-1 | eu-west-2 | eu-central-1 | ap-southeast-1 | ap-southeast-2 | ap-south-1 | ap-northeast-1 | ap-northeast-2 | sa-east-1 | ca-central-1 | cn-north-1
  },
  Comment: 'STRING_VALUE'
};
route53.associateVPCWithHostedZone(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HostedZoneId — (String)

      The ID of the private hosted zone that you want to associate an Amazon VPC with.

      Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association.

    • VPC — (map)

      A complex type that contains information about the VPC that you want to associate with a private hosted zone.

      • VPCRegion — (String)

        (Private hosted zones only) The region in which you created an Amazon VPC.

        Possible values include:
        • "us-east-1"
        • "us-east-2"
        • "us-west-1"
        • "us-west-2"
        • "eu-west-1"
        • "eu-west-2"
        • "eu-central-1"
        • "ap-southeast-1"
        • "ap-southeast-2"
        • "ap-south-1"
        • "ap-northeast-1"
        • "ap-northeast-2"
        • "sa-east-1"
        • "ca-central-1"
        • "cn-north-1"
      • VPCId — (String)

        (Private hosted zones only) The ID of an Amazon VPC.

    • Comment — (String)

      Optional: A comment about the association request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ChangeInfo — (map)

        A complex type that describes the changes made to your hosted zone.

        • Idrequired — (String)

          The ID of the request.

        • Statusrequired — (String)

          The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

          Possible values include:
          • "PENDING"
          • "INSYNC"
        • SubmittedAtrequired — (Date)

          The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

        • Comment — (String)

          A complex type that describes change information about changes made to your hosted zone.

          This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

changeResourceRecordSets(params = {}, callback) ⇒ AWS.Request

Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.

Change Batches and Transactional Changes

The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. When using the Amazon Route 53 API to change resource record sets, Amazon Route 53 either makes all or none of the changes in a change batch request. This ensures that Amazon Route 53 never partially implements the intended changes to the resource record sets in a hosted zone.

For example, a change batch request that deletes the CNAME record for www.example.com and creates an alias resource record set for www.example.com. Amazon Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If either the DELETE or the CREATE action fails, then both changes (plus any other changes in the batch) fail, and the original CNAME record continues to exist.

Due to the nature of transactional changes, you can't delete the same resource record set more than once in a single change batch. If you attempt to delete the same change batch more than once, Amazon Route 53 returns an InvalidChangeBatch error.

Traffic Flow

To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Amazon Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide.

Create, Delete, and Upsert

Use ChangeResourceRecordsSetsRequest to perform the following actions:

  • CREATE: Creates a resource record set that has the specified values.

  • DELETE: Deletes an existing resource record set that has the specified values.

  • UPSERT: If a resource record set does not already exist, AWS creates it. If a resource set does exist, Amazon Route 53 updates it with the values in the request.

Syntaxes for Creating, Updating, and Deleting Resource Record Sets

The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.

For an example for each type of resource record set, see "Examples."

Don't refer to the syntax in the "Parameter Syntax" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets.

Change Propagation to Amazon Route 53 DNS Servers

When you submit a ChangeResourceRecordSets request, Amazon Route 53 propagates your changes to all of the Amazon Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Amazon Route 53 name servers in a few minutes. In rare circumstances, propagation can take up to 30 minutes. For more information, see GetChange.

Limits on ChangeResourceRecordSets Requests

For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.

Service Reference:

Examples:

To create a basic resource record set


/* The following example creates a resource record set that routes Internet traffic to a resource with an IP address of 192.0.2.44. */

 var params = {
  ChangeBatch: {
   Changes: [
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      Name: "example.com", 
      ResourceRecords: [
         {
        Value: "192.0.2.44"
       }
      ], 
      TTL: 60, 
      Type: "A"
     }
    }
   ], 
   Comment: "Web server for example.com"
  }, 
  HostedZoneId: "Z3M3LMPEXAMPLE"
 };
 route53.changeResourceRecordSets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeInfo: {
     Comment: "Web server for example.com", 
     Id: "/change/C2682N5HXP0BZ4", 
     Status: "PENDING", 
     SubmittedAt: <Date Representation>
    }
   }
   */
 });

To create weighted resource record sets


/* The following example creates two weighted resource record sets. The resource with a Weight of 100 will get 1/3rd of traffic (100/100+200), and the other resource will get the rest of the traffic for example.com. */

 var params = {
  ChangeBatch: {
   Changes: [
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      HealthCheckId: "abcdef11-2222-3333-4444-555555fedcba", 
      Name: "example.com", 
      ResourceRecords: [
         {
        Value: "192.0.2.44"
       }
      ], 
      SetIdentifier: "Seattle data center", 
      TTL: 60, 
      Type: "A", 
      Weight: 100
     }
    }, 
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      HealthCheckId: "abcdef66-7777-8888-9999-000000fedcba", 
      Name: "example.com", 
      ResourceRecords: [
         {
        Value: "192.0.2.45"
       }
      ], 
      SetIdentifier: "Portland data center", 
      TTL: 60, 
      Type: "A", 
      Weight: 200
     }
    }
   ], 
   Comment: "Web servers for example.com"
  }, 
  HostedZoneId: "Z3M3LMPEXAMPLE"
 };
 route53.changeResourceRecordSets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeInfo: {
     Comment: "Web servers for example.com", 
     Id: "/change/C2682N5HXP0BZ4", 
     Status: "PENDING", 
     SubmittedAt: <Date Representation>
    }
   }
   */
 });

To create an alias resource record set


/* The following example creates an alias resource record set that routes traffic to a CloudFront distribution. */

 var params = {
  ChangeBatch: {
   Changes: [
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      AliasTarget: {
       DNSName: "d123rk29d0stfj.cloudfront.net", 
       EvaluateTargetHealth: false, 
       HostedZoneId: "Z2FDTNDATAQYW2"
      }, 
      Name: "example.com", 
      Type: "A"
     }
    }
   ], 
   Comment: "CloudFront distribution for example.com"
  }, 
  HostedZoneId: "Z3M3LMPEXAMPLE"// Depends on the type of resource that you want to route traffic to
 };
 route53.changeResourceRecordSets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeInfo: {
     Comment: "CloudFront distribution for example.com", 
     Id: "/change/C2682N5HXP0BZ4", 
     Status: "PENDING", 
     SubmittedAt: <Date Representation>
    }
   }
   */
 });

To create weighted alias resource record sets


/* The following example creates two weighted alias resource record sets that route traffic to ELB load balancers. The resource with a Weight of 100 will get 1/3rd of traffic (100/100+200), and the other resource will get the rest of the traffic for example.com. */

 var params = {
  ChangeBatch: {
   Changes: [
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      AliasTarget: {
       DNSName: "example-com-123456789.us-east-2.elb.amazonaws.com ", 
       EvaluateTargetHealth: true, 
       HostedZoneId: "Z3AADJGX6KTTL2"
      }, 
      Name: "example.com", 
      SetIdentifier: "Ohio region", 
      Type: "A", 
      Weight: 100
     }
    }, 
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      AliasTarget: {
       DNSName: "example-com-987654321.us-west-2.elb.amazonaws.com ", 
       EvaluateTargetHealth: true, 
       HostedZoneId: "Z1H1FL5HABSF5"
      }, 
      Name: "example.com", 
      SetIdentifier: "Oregon region", 
      Type: "A", 
      Weight: 200
     }
    }
   ], 
   Comment: "ELB load balancers for example.com"
  }, 
  HostedZoneId: "Z3M3LMPEXAMPLE"// Depends on the type of resource that you want to route traffic to
 };
 route53.changeResourceRecordSets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeInfo: {
     Comment: "ELB load balancers for example.com", 
     Id: "/change/C2682N5HXP0BZ4", 
     Status: "PENDING", 
     SubmittedAt: <Date Representation>
    }
   }
   */
 });

To create latency resource record sets


/* The following example creates two latency resource record sets that route traffic to EC2 instances. Traffic for example.com is routed either to the Ohio region or the Oregon region, depending on the latency between the user and those regions. */

 var params = {
  ChangeBatch: {
   Changes: [
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      HealthCheckId: "abcdef11-2222-3333-4444-555555fedcba", 
      Name: "example.com", 
      Region: "us-east-2", 
      ResourceRecords: [
         {
        Value: "192.0.2.44"
       }
      ], 
      SetIdentifier: "Ohio region", 
      TTL: 60, 
      Type: "A"
     }
    }, 
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      HealthCheckId: "abcdef66-7777-8888-9999-000000fedcba", 
      Name: "example.com", 
      Region: "us-west-2", 
      ResourceRecords: [
         {
        Value: "192.0.2.45"
       }
      ], 
      SetIdentifier: "Oregon region", 
      TTL: 60, 
      Type: "A"
     }
    }
   ], 
   Comment: "EC2 instances for example.com"
  }, 
  HostedZoneId: "Z3M3LMPEXAMPLE"
 };
 route53.changeResourceRecordSets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeInfo: {
     Comment: "EC2 instances for example.com", 
     Id: "/change/C2682N5HXP0BZ4", 
     Status: "PENDING", 
     SubmittedAt: <Date Representation>
    }
   }
   */
 });

To create latency alias resource record sets


/* The following example creates two latency alias resource record sets that route traffic for example.com to ELB load balancers. Requests are routed either to the Ohio region or the Oregon region, depending on the latency between the user and those regions. */

 var params = {
  ChangeBatch: {
   Changes: [
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      AliasTarget: {
       DNSName: "example-com-123456789.us-east-2.elb.amazonaws.com ", 
       EvaluateTargetHealth: true, 
       HostedZoneId: "Z3AADJGX6KTTL2"
      }, 
      Name: "example.com", 
      Region: "us-east-2", 
      SetIdentifier: "Ohio region", 
      Type: "A"
     }
    }, 
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      AliasTarget: {
       DNSName: "example-com-987654321.us-west-2.elb.amazonaws.com ", 
       EvaluateTargetHealth: true, 
       HostedZoneId: "Z1H1FL5HABSF5"
      }, 
      Name: "example.com", 
      Region: "us-west-2", 
      SetIdentifier: "Oregon region", 
      Type: "A"
     }
    }
   ], 
   Comment: "ELB load balancers for example.com"
  }, 
  HostedZoneId: "Z3M3LMPEXAMPLE"// Depends on the type of resource that you want to route traffic to
 };
 route53.changeResourceRecordSets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeInfo: {
     Comment: "ELB load balancers for example.com", 
     Id: "/change/C2682N5HXP0BZ4", 
     Status: "PENDING", 
     SubmittedAt: <Date Representation>
    }
   }
   */
 });

To create failover resource record sets


/* The following example creates primary and secondary failover resource record sets that route traffic to EC2 instances. Traffic is generally routed to the primary resource, in the Ohio region. If that resource is unavailable, traffic is routed to the secondary resource, in the Oregon region. */

 var params = {
  ChangeBatch: {
   Changes: [
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      Failover: "PRIMARY", 
      HealthCheckId: "abcdef11-2222-3333-4444-555555fedcba", 
      Name: "example.com", 
      ResourceRecords: [
         {
        Value: "192.0.2.44"
       }
      ], 
      SetIdentifier: "Ohio region", 
      TTL: 60, 
      Type: "A"
     }
    }, 
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      Failover: "SECONDARY", 
      HealthCheckId: "abcdef66-7777-8888-9999-000000fedcba", 
      Name: "example.com", 
      ResourceRecords: [
         {
        Value: "192.0.2.45"
       }
      ], 
      SetIdentifier: "Oregon region", 
      TTL: 60, 
      Type: "A"
     }
    }
   ], 
   Comment: "Failover configuration for example.com"
  }, 
  HostedZoneId: "Z3M3LMPEXAMPLE"
 };
 route53.changeResourceRecordSets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeInfo: {
     Comment: "Failover configuration for example.com", 
     Id: "/change/C2682N5HXP0BZ4", 
     Status: "PENDING", 
     SubmittedAt: <Date Representation>
    }
   }
   */
 });

To create failover alias resource record sets


/* The following example creates primary and secondary failover alias resource record sets that route traffic to ELB load balancers. Traffic is generally routed to the primary resource, in the Ohio region. If that resource is unavailable, traffic is routed to the secondary resource, in the Oregon region. */

 var params = {
  ChangeBatch: {
   Changes: [
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      AliasTarget: {
       DNSName: "example-com-123456789.us-east-2.elb.amazonaws.com ", 
       EvaluateTargetHealth: true, 
       HostedZoneId: "Z3AADJGX6KTTL2"
      }, 
      Failover: "PRIMARY", 
      Name: "example.com", 
      SetIdentifier: "Ohio region", 
      Type: "A"
     }
    }, 
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      AliasTarget: {
       DNSName: "example-com-987654321.us-west-2.elb.amazonaws.com ", 
       EvaluateTargetHealth: true, 
       HostedZoneId: "Z1H1FL5HABSF5"
      }, 
      Failover: "SECONDARY", 
      Name: "example.com", 
      SetIdentifier: "Oregon region", 
      Type: "A"
     }
    }
   ], 
   Comment: "Failover alias configuration for example.com"
  }, 
  HostedZoneId: "Z3M3LMPEXAMPLE"// Depends on the type of resource that you want to route traffic to
 };
 route53.changeResourceRecordSets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeInfo: {
     Comment: "Failover alias configuration for example.com", 
     Id: "/change/C2682N5HXP0BZ4", 
     Status: "PENDING", 
     SubmittedAt: <Date Representation>
    }
   }
   */
 });

To create geolocation resource record sets


/* The following example creates four geolocation resource record sets that use IPv4 addresses to route traffic to resources such as web servers running on EC2 instances. Traffic is routed to one of four IP addresses, for North America (NA), for South America (SA), for Europe (EU), and for all other locations (*). */

 var params = {
  ChangeBatch: {
   Changes: [
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      GeoLocation: {
       ContinentCode: "NA"
      }, 
      Name: "example.com", 
      ResourceRecords: [
         {
        Value: "192.0.2.44"
       }
      ], 
      SetIdentifier: "North America", 
      TTL: 60, 
      Type: "A"
     }
    }, 
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      GeoLocation: {
       ContinentCode: "SA"
      }, 
      Name: "example.com", 
      ResourceRecords: [
         {
        Value: "192.0.2.45"
       }
      ], 
      SetIdentifier: "South America", 
      TTL: 60, 
      Type: "A"
     }
    }, 
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      GeoLocation: {
       ContinentCode: "EU"
      }, 
      Name: "example.com", 
      ResourceRecords: [
         {
        Value: "192.0.2.46"
       }
      ], 
      SetIdentifier: "Europe", 
      TTL: 60, 
      Type: "A"
     }
    }, 
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      GeoLocation: {
       CountryCode: "*"
      }, 
      Name: "example.com", 
      ResourceRecords: [
         {
        Value: "192.0.2.47"
       }
      ], 
      SetIdentifier: "Other locations", 
      TTL: 60, 
      Type: "A"
     }
    }
   ], 
   Comment: "Geolocation configuration for example.com"
  }, 
  HostedZoneId: "Z3M3LMPEXAMPLE"
 };
 route53.changeResourceRecordSets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeInfo: {
     Comment: "Geolocation configuration for example.com", 
     Id: "/change/C2682N5HXP0BZ4", 
     Status: "PENDING", 
     SubmittedAt: <Date Representation>
    }
   }
   */
 });

To create geolocation alias resource record sets


/* The following example creates four geolocation alias resource record sets that route traffic to ELB load balancers. Traffic is routed to one of four IP addresses, for North America (NA), for South America (SA), for Europe (EU), and for all other locations (*). */

 var params = {
  ChangeBatch: {
   Changes: [
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      AliasTarget: {
       DNSName: "example-com-123456789.us-east-2.elb.amazonaws.com ", 
       EvaluateTargetHealth: true, 
       HostedZoneId: "Z3AADJGX6KTTL2"
      }, 
      GeoLocation: {
       ContinentCode: "NA"
      }, 
      Name: "example.com", 
      SetIdentifier: "North America", 
      Type: "A"
     }
    }, 
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      AliasTarget: {
       DNSName: "example-com-234567890.sa-east-1.elb.amazonaws.com ", 
       EvaluateTargetHealth: true, 
       HostedZoneId: "Z2P70J7HTTTPLU"
      }, 
      GeoLocation: {
       ContinentCode: "SA"
      }, 
      Name: "example.com", 
      SetIdentifier: "South America", 
      Type: "A"
     }
    }, 
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      AliasTarget: {
       DNSName: "example-com-234567890.eu-central-1.elb.amazonaws.com ", 
       EvaluateTargetHealth: true, 
       HostedZoneId: "Z215JYRZR1TBD5"
      }, 
      GeoLocation: {
       ContinentCode: "EU"
      }, 
      Name: "example.com", 
      SetIdentifier: "Europe", 
      Type: "A"
     }
    }, 
      {
     Action: "CREATE", 
     ResourceRecordSet: {
      AliasTarget: {
       DNSName: "example-com-234567890.ap-southeast-1.elb.amazonaws.com ", 
       EvaluateTargetHealth: true, 
       HostedZoneId: "Z1LMS91P8CMLE5"
      }, 
      GeoLocation: {
       CountryCode: "*"
      }, 
      Name: "example.com", 
      SetIdentifier: "Other locations", 
      Type: "A"
     }
    }
   ], 
   Comment: "Geolocation alias configuration for example.com"
  }, 
  HostedZoneId: "Z3M3LMPEXAMPLE"// Depends on the type of resource that you want to route traffic to
 };
 route53.changeResourceRecordSets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeInfo: {
     Comment: "Geolocation alias configuration for example.com", 
     Id: "/change/C2682N5HXP0BZ4", 
     Status: "PENDING", 
     SubmittedAt: <Date Representation>
    }
   }
   */
 });

Calling the changeResourceRecordSets operation

var params = {
  ChangeBatch: { /* required */
    Changes: [ /* required */
      {
        Action: CREATE | DELETE | UPSERT, /* required */
        ResourceRecordSet: { /* required */
          Name: 'STRING_VALUE', /* required */
          Type: SOA | A | TXT | NS | CNAME | MX | NAPTR | PTR | SRV | SPF | AAAA, /* required */
          AliasTarget: {
            DNSName: 'STRING_VALUE', /* required */
            EvaluateTargetHealth: true || false, /* required */
            HostedZoneId: 'STRING_VALUE' /* required */
          },
          Failover: PRIMARY | SECONDARY,
          GeoLocation: {
            ContinentCode: 'STRING_VALUE',
            CountryCode: 'STRING_VALUE',
            SubdivisionCode: 'STRING_VALUE'
          },
          HealthCheckId: 'STRING_VALUE',
          Region: us-east-1 | us-east-2 | us-west-1 | us-west-2 | ca-central-1 | eu-west-1 | eu-west-2 | eu-central-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | ap-northeast-2 | sa-east-1 | cn-north-1 | ap-south-1,
          ResourceRecords: [
            {
              Value: 'STRING_VALUE' /* required */
            },
            /* more items */
          ],
          SetIdentifier: 'STRING_VALUE',
          TTL: 0,
          TrafficPolicyInstanceId: 'STRING_VALUE',
          Weight: 0
        }
      },
      /* more items */
    ],
    Comment: 'STRING_VALUE'
  },
  HostedZoneId: 'STRING_VALUE' /* required */
};
route53.changeResourceRecordSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HostedZoneId — (String)

      The ID of the hosted zone that contains the resource record sets that you want to change.

    • ChangeBatch — (map)

      A complex type that contains an optional comment and the Changes element.

      • Comment — (String)

        Optional: Any comments you want to include about a change batch request.

      • Changesrequired — (Array<map>)

        Information about the changes to make to the record sets.

        • Actionrequired — (String)

          The action to perform:

          • CREATE: Creates a resource record set that has the specified values.

          • DELETE: Deletes a existing resource record set.

            To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance . Amazon Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Amazon Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

          • UPSERT: If a resource record set doesn't already exist, Amazon Route 53 creates it. If a resource record set does exist, Amazon Route 53 updates it with the values in the request.

          The values that you need to include in the request depend on the type of resource record set that you're creating, deleting, or updating:

          Basic resource record sets (excluding alias, failover, geolocation, latency, and weighted resource record sets)

          • Name

          • Type

          • TTL

          Failover, geolocation, latency, or weighted resource record sets (excluding alias resource record sets)

          • Name

          • Type

          • TTL

          • SetIdentifier

          Alias resource record sets (including failover alias, geolocation alias, latency alias, and weighted alias resource record sets)

          • Name

          • Type

          • AliasTarget (includes DNSName, EvaluateTargetHealth, and HostedZoneId)

          • SetIdentifier (for failover, geolocation, latency, and weighted resource record sets)

          Possible values include:
          • "CREATE"
          • "DELETE"
          • "UPSERT"
        • ResourceRecordSetrequired — (map)

          Information about the resource record set to create, delete, or update.

          • Namerequired — (String)

            The name of the domain you want to perform the action on.

            Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 still assumes that the domain name that you specify is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

            For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

            You can use the asterisk () wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following:

            • The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com.

            • The * can't replace any of the middle labels, for example, marketing..example.com.

            • If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.

              You can't use the * wildcard for resource records sets that have a type of NS.

            You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * for one of the middle labels, for example, marketing.*.example.com. In addition, the * must replace the entire label; for example, you can't specify prod*.example.com.

          • Typerequired — (String)

            The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

            Valid values for basic resource record sets: A | AAAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

            Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.

            Note: SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, "...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it." In RFC 7208, see section 14.1, The SPF DNS Record Type.

            Values for alias resource record sets:

            • CloudFront distributions: A

              If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA.

            • AWS Elastic Beanstalk environment that has a regionalized subdomain: A

            • ELB load balancers: A | AAAA

            • Amazon S3 buckets: A

            • Another resource record set in this hosted zone: Specify the type of the resource record set for which you're creating the alias. Specify any value except NS or SOA.

            Possible values include:
            • "SOA"
            • "A"
            • "TXT"
            • "NS"
            • "CNAME"
            • "MX"
            • "NAPTR"
            • "PTR"
            • "SRV"
            • "SPF"
            • "AAAA"
          • SetIdentifier — (String)

            Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type. The value of SetIdentifier must be unique for each resource record set that has the same combination of DNS name and type. Omit SetIdentifier for any other types of record sets.

          • Weight — (Integer)

            Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Amazon Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Amazon Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:

            • You must specify a value for the Weight element for every weighted resource record set.

            • You can only specify one ResourceRecord per weighted resource record set.

            • You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.

            • You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements.

            • For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Amazon Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.

              The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Amazon Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.

          • Region — (String)

            Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.

            Note: Creating latency and latency alias resource record sets in private hosted zones is not supported.

            When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Amazon Route 53 then returns the value that is associated with the selected resource record set.

            Note the following:

            • You can only specify one ResourceRecord per latency resource record set.

            • You can only create one latency resource record set for each Amazon EC2 Region.

            • You aren't required to create latency resource record sets for all Amazon EC2 Regions. Amazon Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.

            • You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.

            Possible values include:
            • "us-east-1"
            • "us-east-2"
            • "us-west-1"
            • "us-west-2"
            • "ca-central-1"
            • "eu-west-1"
            • "eu-west-2"
            • "eu-central-1"
            • "ap-southeast-1"
            • "ap-southeast-2"
            • "ap-northeast-1"
            • "ap-northeast-2"
            • "sa-east-1"
            • "cn-north-1"
            • "ap-south-1"
          • GeoLocation — (map)

            Geo location resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.

            Note: Creating geolocation and geolocation alias resource record sets in private hosted zones is not supported.

            If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.

            You can't create two geolocation resource record sets that specify the same geographic location.

            The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.

            Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Amazon Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *, which handles both queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Amazon Route 53 returns a "no answer" response for queries from those locations.

            You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.

            • ContinentCode — (String)

              The two-letter code for the continent.

              Valid values: AF | AN | AS | EU | OC | NA | SA

              Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

            • CountryCode — (String)

              The two-letter code for the country.

            • SubdivisionCode — (String)

              The code for the subdivision, for example, a state in the United States or a province in Canada.

          • Failover — (String)

            Failover resource record sets only: 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. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.

            Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:

            • When the primary resource record set is healthy, Amazon Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.

            • When the primary resource record set is unhealthy and the secondary resource record set is healthy, Amazon Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

            • When the secondary resource record set is unhealthy, Amazon Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.

            • If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Amazon Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.

            You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.

            For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.

            For more information about configuring failover for Amazon Route 53, see the following topics in the Amazon Route 53 Developer Guide:

            Possible values include:
            • "PRIMARY"
            • "SECONDARY"
          • TTL — (Integer)

            The resource record cache time to live (TTL), in seconds. Note the following:

            • If you're creating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL for the alias target.

            • If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.

            • All of the resource record sets in a group of weighted resource record sets must have the same value for TTL.

            • If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight.

          • ResourceRecords — (Array<map>)

            Information about the resource records to act upon.

            Note: If you're creating an alias resource record set, omit ResourceRecords.
            • Valuerequired — (String)

              The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, if the current value does not match the actual value, an error is returned. For descriptions about how to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

              You can specify more than one value for all record types except CNAME and SOA.

              Note: If you're creating an alias resource record set, omit Value.
          • AliasTarget — (map)

            Alias resource record sets only: Information about the CloudFront distribution, AWS Elastic Beanstalk environment, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you're redirecting queries. The AWS Elastic Beanstalk environment must have a regionalized subdomain.

            If you're creating resource records sets for a private hosted zone, note the following:

            • You can't create alias resource record sets for CloudFront distributions in a private hosted zone.

            • Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.

            • For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.

            • HostedZoneIdrequired — (String)

              Alias resource records sets only: The value used depends on where you want to route traffic:

              CloudFront distribution

              Specify Z2FDTNDATAQYW2.

              Note: Alias resource record sets for CloudFront can't be created in a private zone.
              Elastic Beanstalk environment

              Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the "AWS Regions and Endpoints" chapter of the Amazon Web Services General Reference.

              ELB load balancer

              Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:

              • Elastic Load Balancing table in the "AWS Regions and Endpoints" chapter of the Amazon Web Services General Reference: Use the value in the "Amazon Route 53 Hosted Zone ID" column that corresponds with the region that you created your load balancer in.

              • AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.

              • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameId. For more information, see the applicable guide:

              • AWS CLI: Use describe-load-balancers to get the value of CanonicalHostedZoneNameID.

              An Amazon S3 bucket configured as a static website

              Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the Amazon Simple Storage Service Website Endpoints table in the "AWS Regions and Endpoints" chapter of the Amazon Web Services General Reference.

              Another Amazon Route 53 resource record set in your hosted zone

              Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)

            • DNSNamerequired — (String)

              Alias resource record sets only: The value that you specify depends on where you want to route queries:

              CloudFront distribution

              Specify the domain name that CloudFront assigned when you created your distribution.

              Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.

              Elastic Beanstalk environment

              Specify the CNAME attribute for the environment. (The environment must have a regionalized domain name.) You can use the following methods to get the value of the CNAME attribute:

              • AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.

              • Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.

              • AWS CLI: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the AWS Command Line Interface Reference.

              ELB load balancer

              Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI.

              • AWS Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field. (If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack.)

              • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide:

              • AWS CLI: Use describe-load-balancers to get the value of DNSName.

              Amazon S3 bucket that is configured as a static website

              Specify the domain name of the Amazon S3 website endpoint in which you created the bucket, for example, s3-website-us-east-2.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.

              Another Amazon Route 53 resource record set

              Specify the value of the Name element for a resource record set in the current hosted zone.

            • EvaluateTargetHealthrequired — (Boolean)

              Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer, or the referenced resource record set.

              Note the following:

              • You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.

              • If the AWS resource that you specify in AliasTarget is a resource record set or a group of resource record sets (for example, a group of weighted resource record sets), but it is not another alias resource record set, we recommend that you associate a health check with all of the resource record sets in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.

              • If you specify an Elastic Beanstalk environment in HostedZoneId and DNSName, and if the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one EC2 instance.) If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Amazon Route 53 routes queries to other available resources that are healthy, if any.

                If the environment contains a single EC2 instance, there are no special requirements.

              • If you specify an ELB load balancer in AliasTarget , ELB routes queries only to the healthy EC2 instances that are registered with the load balancer. If no EC2 instances are healthy or if the load balancer itself is unhealthy, and if EvaluateTargetHealth is true for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources. When you create a load balancer, you configure settings for ELB health checks; they're not Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health checks for the EC2 instances that you register with an ELB load balancer.

                For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developer Guide.

              • We recommend that you set EvaluateTargetHealth to true only when you have enough idle capacity to handle the failure of one or more endpoints.

              For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

          • HealthCheckId — (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.

            Amazon Route 53 determines whether a resource record set is healthy based on one of the following:

            • By periodically sending a request to the endpoint that is specified in the health check

            • By aggregating the status of a specified group of health checks (calculated health checks)

            • By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

            For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy.

            The HealthCheckId element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations:

            • You're checking the health of the resource record sets in a group of weighted, latency, geolocation, or failover resource record sets, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.

            • You set EvaluateTargetHealth to true for the resource record sets in a group of alias, weighted alias, latency alias, geolocation alias, or failover alias resource record sets, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets.

            Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check.

            For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is *), in that order, until it finds a resource record set for which the endpoint is healthy.

            If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (example.com).

            n this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and then associate the health check with those resource record sets, health check results will be unpredictable.

            For more information, see the following topics in the Amazon Route 53 Developer Guide:

          • TrafficPolicyInstanceId — (String)

            When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. TrafficPolicyInstanceId is the ID of the traffic policy instance that Amazon Route 53 created this resource record set for.

            To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Amazon Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Amazon Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ChangeInfo — (map)

        A complex type that contains information about changes made to your hosted zone.

        This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

        • Idrequired — (String)

          The ID of the request.

        • Statusrequired — (String)

          The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

          Possible values include:
          • "PENDING"
          • "INSYNC"
        • SubmittedAtrequired — (Date)

          The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

        • Comment — (String)

          A complex type that describes change information about changes made to your hosted zone.

          This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

changeTagsForResource(params = {}, callback) ⇒ AWS.Request

Adds, edits, or deletes tags for a health check or a hosted zone.

For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Service Reference:

Examples:

To add or remove tags from a hosted zone or health check


/* The following example adds two tags and removes one tag from the hosted zone with ID Z3M3LMPEXAMPLE. */

 var params = {
  AddTags: [
     {
    Key: "apex", 
    Value: "3874"
   }, 
     {
    Key: "acme", 
    Value: "4938"
   }
  ], 
  RemoveTagKeys: [
     "Nadir"
  ], 
  ResourceId: "Z3M3LMPEXAMPLE", 
  ResourceType: "hostedzone"// Valid values are healthcheck and hostedzone.
 };
 route53.changeTagsForResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the changeTagsForResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: healthcheck | hostedzone, /* required */
  AddTags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  RemoveTagKeys: [
    'STRING_VALUE',
    /* more items */
  ]
};
route53.changeTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceType — (String)

      The type of the resource.

      • The resource type for health checks is healthcheck.

      • The resource type for hosted zones is hostedzone.

      Possible values include:
      • "healthcheck"
      • "hostedzone"
    • ResourceId — (String)

      The ID of the resource for which you want to add, change, or delete tags.

    • AddTags — (Array<map>)

      A complex type that contains a list of the tags that you want to add to the specified health check or hosted zone and/or the tags that you want to edit Value for.

      You can add a maximum of 10 tags to a health check or a hosted zone.

      • Key — (String)

        The value of Key depends on the operation that you want to perform:

        • Add a tag to a health check or hosted zone: Key is the name that you want to give the new tag.

        • Edit a tag: Key is the name of the tag that you want to change the Value for.

        • Delete a key: Key is the name of the tag you want to remove.

        • Give a name to a health check: Edit the default Name tag. In the Amazon Route 53 console, the list of your health checks includes a Name column that lets you see the name that you've given to each health check.

      • Value — (String)

        The value of Value depends on the operation that you want to perform:

        • Add a tag to a health check or hosted zone: Value is the value that you want to give the new tag.

        • Edit a tag: Value is the new value that you want to assign the tag.

    • RemoveTagKeys — (Array<String>)

      A complex type that contains a list of the tags that you want to delete from the specified health check or hosted zone. You can specify up to 10 keys.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createHealthCheck(params = {}, callback) ⇒ AWS.Request

Creates a new health check.

For information about adding health checks to resource record sets, see ResourceRecordSet$HealthCheckId in ChangeResourceRecordSets.

ELB Load Balancers

If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to an Amazon Route 53 health check.

Private Hosted Zones

You can associate health checks with failover resource record sets in a private hosted zone. Note the following:

  • Amazon Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.

  • You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.

  • You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide.

Service Reference:

Examples:

Calling the createHealthCheck operation

var params = {
  CallerReference: 'STRING_VALUE', /* required */
  HealthCheckConfig: { /* required */
    Type: HTTP | HTTPS | HTTP_STR_MATCH | HTTPS_STR_MATCH | TCP | CALCULATED | CLOUDWATCH_METRIC, /* required */
    AlarmIdentifier: {
      Name: 'STRING_VALUE', /* required */
      Region: us-east-1 | us-east-2 | us-west-1 | us-west-2 | ca-central-1 | eu-central-1 | eu-west-1 | eu-west-2 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | ap-northeast-2 | sa-east-1 /* required */
    },
    ChildHealthChecks: [
      'STRING_VALUE',
      /* more items */
    ],
    EnableSNI: true || false,
    FailureThreshold: 0,
    FullyQualifiedDomainName: 'STRING_VALUE',
    HealthThreshold: 0,
    IPAddress: 'STRING_VALUE',
    InsufficientDataHealthStatus: Healthy | Unhealthy | LastKnownStatus,
    Inverted: true || false,
    MeasureLatency: true || false,
    Port: 0,
    Regions: [
      us-east-1 | us-west-1 | us-west-2 | eu-west-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | sa-east-1,
      /* more items */
    ],
    RequestInterval: 0,
    ResourcePath: 'STRING_VALUE',
    SearchString: 'STRING_VALUE'
  }
};
route53.createHealthCheck(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CallerReference — (String)

      A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request without the risk of creating two identical health checks:

      • If you send a CreateHealthCheck request with the same CallerReference and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Amazon Route 53 returns the settings for the existing health check.

      • If you send a CreateHealthCheck request with the same CallerReference as a deleted health check, regardless of the settings, Amazon Route 53 returns a HealthCheckAlreadyExists error.

      • If you send a CreateHealthCheck request with the same CallerReference as an existing health check but with different settings, Amazon Route 53 returns a HealthCheckAlreadyExists error.

      • If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Amazon Route 53 creates the health check.

    • HealthCheckConfig — (map)

      A complex type that contains the response to a CreateHealthCheck request.

      • IPAddress — (String)

        The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address returned by DNS, Amazon Route 53 then checks the health of the endpoint.

        Use one of the following formats for the value of IPAddress:

        • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

        • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

        If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

        For more information, see HealthCheckConfig$FullyQualifiedDomainName.

        Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

        When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

      • Port — (Integer)

        The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress.

      • Typerequired — (String)

        The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

        You can't change the value of Type after you create a health check.

        You can create the following types of health checks:

        • HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

        • HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

          If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

        • HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

        • HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

        • TCP: Amazon Route 53 tries to establish a TCP connection.

        • CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.

        • CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

        For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

        Possible values include:
        • "HTTP"
        • "HTTPS"
        • "HTTP_STR_MATCH"
        • "HTTPS_STR_MATCH"
        • "TCP"
        • "CALCULATED"
        • "CLOUDWATCH_METRIC"
      • ResourcePath — (String)

        The path, if any, 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, for example, the file /docs/route53-health-check.html.

      • FullyQualifiedDomainName — (String)

        Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

        If you specify a value for IPAddress:

        Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks.

        When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

        • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

        • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

        • If you specify another value for Port and any value except TCP for Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

        If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases.

        If you don't specify a value for IPAddress :

        Amazon Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint.

        Note: If you don't specify a value for IPAddress, Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

        If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

        In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

        In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a Host header.

      • SearchString — (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. If the string appears in the response body, Amazon Route 53 considers the resource healthy.

        Amazon Route 53 considers case when searching for SearchString in the response body.

      • RequestInterval — (Integer)

        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. Each Amazon Route 53 health checker makes requests at this interval.

        You can't change the value of RequestInterval after you create a health check.

        If you don't specify a value for RequestInterval, the default value is 30 seconds.

      • FailureThreshold — (Integer)

        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. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

        If you don't specify a value for FailureThreshold, the default value is three health checks.

      • MeasureLatency — (Boolean)

        Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.

        You can't change the value of MeasureLatency after you create a health check.

      • Inverted — (Boolean)

        Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

      • HealthThreshold — (Integer)

        The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.

        Note the following:

        • If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.

        • If you specify 0, Amazon Route 53 always considers this health check to be healthy.

      • ChildHealthChecks — (Array<String>)

        (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

      • EnableSNI — (Boolean)

        Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

        Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

        The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

      • Regions — (Array<String>)

        A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.

        If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.

        If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).

      • AlarmIdentifier — (map)

        A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

        • Regionrequired — (String)

          A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

          For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference.

          Possible values include:
          • "us-east-1"
          • "us-east-2"
          • "us-west-1"
          • "us-west-2"
          • "ca-central-1"
          • "eu-central-1"
          • "eu-west-1"
          • "eu-west-2"
          • "ap-south-1"
          • "ap-southeast-1"
          • "ap-southeast-2"
          • "ap-northeast-1"
          • "ap-northeast-2"
          • "sa-east-1"
        • Namerequired — (String)

          The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

      • InsufficientDataHealthStatus — (String)

        When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

        • Healthy: Amazon Route 53 considers the health check to be healthy.

        • Unhealthy: Amazon Route 53 considers the health check to be unhealthy.

        • LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

        Possible values include:
        • "Healthy"
        • "Unhealthy"
        • "LastKnownStatus"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HealthCheck — (map)

        A complex type that contains identifying information about the health check.

        • Idrequired — (String)

          The identifier that Amazon Route 53assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.

        • CallerReferencerequired — (String)

          A unique string that you specified when you created the health check.

        • HealthCheckConfigrequired — (map)

          A complex type that contains detailed information about one health check.

          • IPAddress — (String)

            The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address returned by DNS, Amazon Route 53 then checks the health of the endpoint.

            Use one of the following formats for the value of IPAddress:

            • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

            • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

            If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

            For more information, see HealthCheckConfig$FullyQualifiedDomainName.

            Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

            When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

          • Port — (Integer)

            The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress.

          • Typerequired — (String)

            The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

            You can't change the value of Type after you create a health check.

            You can create the following types of health checks:

            • HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

            • HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

              If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

            • HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

            • HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

            • TCP: Amazon Route 53 tries to establish a TCP connection.

            • CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.

            • CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

            For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

            Possible values include:
            • "HTTP"
            • "HTTPS"
            • "HTTP_STR_MATCH"
            • "HTTPS_STR_MATCH"
            • "TCP"
            • "CALCULATED"
            • "CLOUDWATCH_METRIC"
          • ResourcePath — (String)

            The path, if any, 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, for example, the file /docs/route53-health-check.html.

          • FullyQualifiedDomainName — (String)

            Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

            If you specify a value for IPAddress:

            Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks.

            When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

            • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

            • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

            • If you specify another value for Port and any value except TCP for Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

            If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases.

            If you don't specify a value for IPAddress :

            Amazon Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint.

            Note: If you don't specify a value for IPAddress, Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

            If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

            In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

            In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a Host header.

          • SearchString — (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. If the string appears in the response body, Amazon Route 53 considers the resource healthy.

            Amazon Route 53 considers case when searching for SearchString in the response body.

          • RequestInterval — (Integer)

            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. Each Amazon Route 53 health checker makes requests at this interval.

            You can't change the value of RequestInterval after you create a health check.

            If you don't specify a value for RequestInterval, the default value is 30 seconds.

          • FailureThreshold — (Integer)

            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. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

            If you don't specify a value for FailureThreshold, the default value is three health checks.

          • MeasureLatency — (Boolean)

            Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.

            You can't change the value of MeasureLatency after you create a health check.

          • Inverted — (Boolean)

            Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

          • HealthThreshold — (Integer)

            The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.

            Note the following:

            • If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.

            • If you specify 0, Amazon Route 53 always considers this health check to be healthy.

          • ChildHealthChecks — (Array<String>)

            (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

          • EnableSNI — (Boolean)

            Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

            Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

            The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

          • Regions — (Array<String>)

            A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.

            If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.

            If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).

          • AlarmIdentifier — (map)

            A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

            • Regionrequired — (String)

              A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

              For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference.

              Possible values include:
              • "us-east-1"
              • "us-east-2"
              • "us-west-1"
              • "us-west-2"
              • "ca-central-1"
              • "eu-central-1"
              • "eu-west-1"
              • "eu-west-2"
              • "ap-south-1"
              • "ap-southeast-1"
              • "ap-southeast-2"
              • "ap-northeast-1"
              • "ap-northeast-2"
              • "sa-east-1"
            • Namerequired — (String)

              The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

          • InsufficientDataHealthStatus — (String)

            When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

            • Healthy: Amazon Route 53 considers the health check to be healthy.

            • Unhealthy: Amazon Route 53 considers the health check to be unhealthy.

            • LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

            Possible values include:
            • "Healthy"
            • "Unhealthy"
            • "LastKnownStatus"
        • HealthCheckVersionrequired — (Integer)

          The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.

        • CloudWatchAlarmConfiguration — (map)

          A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.

          • EvaluationPeriodsrequired — (Integer)

            For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.

          • Thresholdrequired — (Float)

            For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.

          • ComparisonOperatorrequired — (String)

            For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.

            Possible values include:
            • "GreaterThanOrEqualToThreshold"
            • "GreaterThanThreshold"
            • "LessThanThreshold"
            • "LessThanOrEqualToThreshold"
          • Periodrequired — (Integer)

            For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.

          • MetricNamerequired — (String)

            The name of the CloudWatch metric that the alarm is associated with.

          • Namespacerequired — (String)

            The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

          • Statisticrequired — (String)

            For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.

            Possible values include:
            • "Average"
            • "Sum"
            • "SampleCount"
            • "Maximum"
            • "Minimum"
          • Dimensions — (Array<map>)

            For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

            • Namerequired — (String)

              For the metric that the CloudWatch alarm is associated with, the name of one dimension.

            • Valuerequired — (String)

              For the metric that the CloudWatch alarm is associated with, the value of one dimension.

      • Location — (String)

        The unique URL representing the new health check.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createHostedZone(params = {}, callback) ⇒ AWS.Request

Creates a new public hosted zone, which you use to specify how the Domain Name System (DNS) routes traffic on the Internet for a domain, such as example.com, and its subdomains.

You can't convert a public hosted zones to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.

For more information about charges for hosted zones, see Amazon Route 53 Pricing.

Note the following:

  • You can't create a hosted zone for a top-level domain (TLD).

  • Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Amazon Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.

    If you want to use the same name servers for multiple hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element.

  • If your domain is registered with a registrar other than Amazon Route 53, you must update the name servers with your registrar to make Amazon Route 53 your DNS service. For more information, see Configuring Amazon Route 53 as your DNS Service in the Amazon Route 53 Developer Guide.

When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. This means that the NS and SOA records are not yet available on all Amazon Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC.

Service Reference:

Examples:

Calling the createHostedZone operation

var params = {
  CallerReference: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  DelegationSetId: 'STRING_VALUE',
  HostedZoneConfig: {
    Comment: 'STRING_VALUE',
    PrivateZone: true || false
  },
  VPC: {
    VPCId: 'STRING_VALUE',
    VPCRegion: us-east-1 | us-east-2 | us-west-1 | us-west-2 | eu-west-1 | eu-west-2 | eu-central-1 | ap-southeast-1 | ap-southeast-2 | ap-south-1 | ap-northeast-1 | ap-northeast-2 | sa-east-1 | ca-central-1 | cn-north-1
  }
};
route53.createHostedZone(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the domain. For resource record types that include a domain name, specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

      If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Amazon Route 53, change the name servers for your domain to the set of NameServers that CreateHostedZone returns in DelegationSet.

    • VPC — (map)

      (Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone.

      You can specify only one Amazon VPC when you create a private hosted zone. To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.

      • VPCRegion — (String)

        (Private hosted zones only) The region in which you created an Amazon VPC.

        Possible values include:
        • "us-east-1"
        • "us-east-2"
        • "us-west-1"
        • "us-west-2"
        • "eu-west-1"
        • "eu-west-2"
        • "eu-central-1"
        • "ap-southeast-1"
        • "ap-southeast-2"
        • "ap-south-1"
        • "ap-northeast-1"
        • "ap-northeast-2"
        • "sa-east-1"
        • "ca-central-1"
        • "cn-north-1"
      • VPCId — (String)

        (Private hosted zones only) The ID of an Amazon VPC.

    • CallerReference — (String)

      A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateHostedZone request. CallerReference can be any unique string, for example, a date/time stamp.

    • HostedZoneConfig — (map)

      (Optional) A complex type that contains the following optional values:

      • For public and private hosted zones, an optional comment

      • For private hosted zones, an optional PrivateZone element

      If you don't specify a comment or the PrivateZone element, omit HostedZoneConfig and the other elements.

      • Comment — (String)

        Any comments that you want to include about the hosted zone.

      • PrivateZone — (Boolean)

        A value that indicates whether this is a private hosted zone.

    • DelegationSetId — (String)

      If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see CreateReusableDelegationSet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HostedZone — (map)

        A complex type that contains general information about the hosted zone.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to the hosted zone when you created it.

        • Namerequired — (String)

          The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.

          For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone.

        • CallerReferencerequired — (String)

          The value that you specified for CallerReference when you created the hosted zone.

        • Config — (map)

          A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response.

          • Comment — (String)

            Any comments that you want to include about the hosted zone.

          • PrivateZone — (Boolean)

            A value that indicates whether this is a private hosted zone.

        • ResourceRecordSetCount — (Integer)

          The number of resource record sets in the hosted zone.

      • ChangeInfo — (map)

        A complex type that contains information about the CreateHostedZone request.

        • Idrequired — (String)

          The ID of the request.

        • Statusrequired — (String)

          The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

          Possible values include:
          • "PENDING"
          • "INSYNC"
        • SubmittedAtrequired — (Date)

          The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

        • Comment — (String)

          A complex type that describes change information about changes made to your hosted zone.

          This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

      • DelegationSet — (map)

        A complex type that describes the name servers for this hosted zone.

        • Id — (String)

          The ID that Amazon Route 53 assigns to a reusable delegation set.

        • CallerReference — (String)

          The value that you specified for CallerReference when you created the reusable delegation set.

        • NameServersrequired — (Array<String>)

          A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.

      • VPC — (map)

        A complex type that contains information about an Amazon VPC that you associated with this hosted zone.

        • VPCRegion — (String)

          (Private hosted zones only) The region in which you created an Amazon VPC.

          Possible values include:
          • "us-east-1"
          • "us-east-2"
          • "us-west-1"
          • "us-west-2"
          • "eu-west-1"
          • "eu-west-2"
          • "eu-central-1"
          • "ap-southeast-1"
          • "ap-southeast-2"
          • "ap-south-1"
          • "ap-northeast-1"
          • "ap-northeast-2"
          • "sa-east-1"
          • "ca-central-1"
          • "cn-north-1"
        • VPCId — (String)

          (Private hosted zones only) The ID of an Amazon VPC.

      • Location — (String)

        The unique URL representing the new hosted zone.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createReusableDelegationSet(params = {}, callback) ⇒ AWS.Request

Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones. If a hosted zoned ID is specified, CreateReusableDelegationSet marks the delegation set associated with that zone as reusable

Note: A reusable delegation set can't be associated with a private hosted zone.

For information on how to use a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers.

Service Reference:

Examples:

Calling the createReusableDelegationSet operation

var params = {
  CallerReference: 'STRING_VALUE', /* required */
  HostedZoneId: 'STRING_VALUE'
};
route53.createReusableDelegationSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CallerReference — (String)

      A unique string that identifies the request, and that allows you to retry failed CreateReusableDelegationSet requests without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateReusableDelegationSet request. CallerReference can be any unique string, for example a date/time stamp.

    • HostedZoneId — (String)

      If you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted zone.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DelegationSet — (map)

        A complex type that contains name server information.

        • Id — (String)

          The ID that Amazon Route 53 assigns to a reusable delegation set.

        • CallerReference — (String)

          The value that you specified for CallerReference when you created the reusable delegation set.

        • NameServersrequired — (Array<String>)

          A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.

      • Location — (String)

        The unique URL representing the new reusable delegation set.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createTrafficPolicy(params = {}, callback) ⇒ AWS.Request

Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).

Service Reference:

Examples:

Calling the createTrafficPolicy operation

var params = {
  Document: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Comment: 'STRING_VALUE'
};
route53.createTrafficPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the traffic policy.

    • Document — (String)

      The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.

    • Comment — (String)

      (Optional) Any comments that you want to include about the traffic policy.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficPolicy — (map)

        A complex type that contains settings for the new traffic policy.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to a traffic policy when you created it.

        • Versionrequired — (Integer)

          The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of Version is always 1.

        • Namerequired — (String)

          The name that you specified when you created the traffic policy.

        • Typerequired — (String)

          The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

          Possible values include:
          • "SOA"
          • "A"
          • "TXT"
          • "NS"
          • "CNAME"
          • "MX"
          • "NAPTR"
          • "PTR"
          • "SRV"
          • "SPF"
          • "AAAA"
        • Documentrequired — (String)

          The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see Traffic Policy Document Format.

        • Comment — (String)

          The comment that you specify in the CreateTrafficPolicy request, if any.

      • Location — (String)

        A unique URL that represents a new traffic policy.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createTrafficPolicyInstance(params = {}, callback) ⇒ AWS.Request

Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created.

Service Reference:

Examples:

Calling the createTrafficPolicyInstance operation

var params = {
  HostedZoneId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  TTL: 0, /* required */
  TrafficPolicyId: 'STRING_VALUE', /* required */
  TrafficPolicyVersion: 0 /* required */
};
route53.createTrafficPolicyInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HostedZoneId — (String)

      The ID of the hosted zone in which you want Amazon Route 53 to create resource record sets by using the configuration in a traffic policy.

    • Name — (String)

      The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Amazon Route 53 creates for this traffic policy instance.

    • TTL — (Integer)

      (Optional) The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone.

    • TrafficPolicyId — (String)

      The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

    • TrafficPolicyVersion — (Integer)

      The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficPolicyInstance — (map)

        A complex type that contains settings for the new traffic policy instance.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to the new traffic policy instance.

        • HostedZoneIdrequired — (String)

          The ID of the hosted zone that Amazon Route 53 created resource record sets in.

        • Namerequired — (String)

          The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance.

        • TTLrequired — (Integer)

          The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.

        • Staterequired — (String)

          The value of State is one of the following values:

          Applied

          Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Amazon Route 53 edge locations.

          Creating

          Amazon Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request completed successfully.

          Failed

          Amazon Route 53 wasn't able to create or update the resource record sets. When the value of State is Failed, see Message for an explanation of what caused the request to fail.

        • Messagerequired — (String)

          If State is Failed, an explanation of the reason for the failure. If State is another value, Message is empty.

        • TrafficPolicyIdrequired — (String)

          The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

        • TrafficPolicyVersionrequired — (Integer)

          The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

        • TrafficPolicyTyperequired — (String)

          The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.

          Possible values include:
          • "SOA"
          • "A"
          • "TXT"
          • "NS"
          • "CNAME"
          • "MX"
          • "NAPTR"
          • "PTR"
          • "SRV"
          • "SPF"
          • "AAAA"
      • Location — (String)

        A unique URL that represents a new traffic policy instance.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createTrafficPolicyVersion(params = {}, callback) ⇒ AWS.Request

Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy.

Service Reference:

Examples:

Calling the createTrafficPolicyVersion operation

var params = {
  Document: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  Comment: 'STRING_VALUE'
};
route53.createTrafficPolicyVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String)

      The ID of the traffic policy for which you want to create a new version.

    • Document — (String)

      The definition of this version of the traffic policy, in JSON format. You specified the JSON in the CreateTrafficPolicyVersion request. For more information about the JSON format, see CreateTrafficPolicy.

    • Comment — (String)

      The comment that you specified in the CreateTrafficPolicyVersion request, if any.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficPolicy — (map)

        A complex type that contains settings for the new version of the traffic policy.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to a traffic policy when you created it.

        • Versionrequired — (Integer)

          The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of Version is always 1.

        • Namerequired — (String)

          The name that you specified when you created the traffic policy.

        • Typerequired — (String)

          The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

          Possible values include:
          • "SOA"
          • "A"
          • "TXT"
          • "NS"
          • "CNAME"
          • "MX"
          • "NAPTR"
          • "PTR"
          • "SRV"
          • "SPF"
          • "AAAA"
        • Documentrequired — (String)

          The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see Traffic Policy Document Format.

        • Comment — (String)

          The comment that you specify in the CreateTrafficPolicy request, if any.

      • Location — (String)

        A unique URL that represents a new traffic policy version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createVPCAssociationAuthorization(params = {}, callback) ⇒ AWS.Request

Authorizes the AWS account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request.

Note: If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC.

Examples:

Calling the createVPCAssociationAuthorization operation

var params = {
  HostedZoneId: 'STRING_VALUE', /* required */
  VPC: { /* required */
    VPCId: 'STRING_VALUE',
    VPCRegion: us-east-1 | us-east-2 | us-west-1 | us-west-2 | eu-west-1 | eu-west-2 | eu-central-1 | ap-southeast-1 | ap-southeast-2 | ap-south-1 | ap-northeast-1 | ap-northeast-2 | sa-east-1 | ca-central-1 | cn-north-1
  }
};
route53.createVPCAssociationAuthorization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HostedZoneId — (String)

      The ID of the private hosted zone that you want to authorize associating a VPC with.

    • VPC — (map)

      A complex type that contains the VPC ID and region for the VPC that you want to authorize associating with your hosted zone.

      • VPCRegion — (String)

        (Private hosted zones only) The region in which you created an Amazon VPC.

        Possible values include:
        • "us-east-1"
        • "us-east-2"
        • "us-west-1"
        • "us-west-2"
        • "eu-west-1"
        • "eu-west-2"
        • "eu-central-1"
        • "ap-southeast-1"
        • "ap-southeast-2"
        • "ap-south-1"
        • "ap-northeast-1"
        • "ap-northeast-2"
        • "sa-east-1"
        • "ca-central-1"
        • "cn-north-1"
      • VPCId — (String)

        (Private hosted zones only) The ID of an Amazon VPC.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HostedZoneId — (String)

        The ID of the hosted zone that you authorized associating a VPC with.

      • VPC — (map)

        The VPC that you authorized associating with a hosted zone.

        • VPCRegion — (String)

          (Private hosted zones only) The region in which you created an Amazon VPC.

          Possible values include:
          • "us-east-1"
          • "us-east-2"
          • "us-west-1"
          • "us-west-2"
          • "eu-west-1"
          • "eu-west-2"
          • "eu-central-1"
          • "ap-southeast-1"
          • "ap-southeast-2"
          • "ap-south-1"
          • "ap-northeast-1"
          • "ap-northeast-2"
          • "sa-east-1"
          • "ca-central-1"
          • "cn-north-1"
        • VPCId — (String)

          (Private hosted zones only) The ID of an Amazon VPC.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteHealthCheck(params = {}, callback) ⇒ AWS.Request

Deletes a health check.

Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide.

Service Reference:

Examples:

Calling the deleteHealthCheck operation

var params = {
  HealthCheckId: 'STRING_VALUE' /* required */
};
route53.deleteHealthCheck(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HealthCheckId — (String)

      The ID of the health check that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteHostedZone(params = {}, callback) ⇒ AWS.Request

Deletes a hosted zone.

If the name servers for the hosted zone are associated with a domain and if you want to make the domain unavailable on the Internet, we recommend that you delete the name servers from the domain to prevent future DNS queries from possibly being misrouted. If the domain is registered with Amazon Route 53, see UpdateDomainNameservers. If the domain is registered with another registrar, use the method provided by the registrar to delete name servers for the domain.

Some domain registries don't allow you to remove all of the name servers for a domain. If the registry for your domain requires one or more name servers, we recommend that you delete the hosted zone only if you transfer DNS service to another service provider, and you replace the name servers for the domain with name servers from the new provider.

You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. If the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. If you try to delete a hosted zone that contains other resource record sets, the request fails, and Amazon Route 53 returns a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets.

To verify that the hosted zone has been deleted, do one of the following:

  • Use the GetHostedZone action to request information about the hosted zone.

  • Use the ListHostedZones action to get a list of the hosted zones associated with the current AWS account.

Service Reference:

Examples:

Calling the deleteHostedZone operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
route53.deleteHostedZone(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String)

      The ID of the hosted zone you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ChangeInfo — (map)

        A complex type that contains the ID, the status, and the date and time of a request to delete a hosted zone.

        • Idrequired — (String)

          The ID of the request.

        • Statusrequired — (String)

          The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

          Possible values include:
          • "PENDING"
          • "INSYNC"
        • SubmittedAtrequired — (Date)

          The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

        • Comment — (String)

          A complex type that describes change information about changes made to your hosted zone.

          This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteReusableDelegationSet(params = {}, callback) ⇒ AWS.Request

Deletes a reusable delegation set.

You can delete a reusable delegation set only if it isn't associated with any hosted zones.

To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete.

Service Reference:

Examples:

Calling the deleteReusableDelegationSet operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
route53.deleteReusableDelegationSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String)

      The ID of the reusable delegation set that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteTrafficPolicy(params = {}, callback) ⇒ AWS.Request

Deletes a traffic policy.

Service Reference:

Examples:

Calling the deleteTrafficPolicy operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Version: 0 /* required */
};
route53.deleteTrafficPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String)

      The ID of the traffic policy that you want to delete.

    • Version — (Integer)

      The version number of the traffic policy that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteTrafficPolicyInstance(params = {}, callback) ⇒ AWS.Request

Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.

Note: In the Amazon Route 53 console, traffic policy instances are known as policy records.

Service Reference:

Examples:

Calling the deleteTrafficPolicyInstance operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
route53.deleteTrafficPolicyInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String)

      The ID of the traffic policy instance that you want to delete.

      When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteVPCAssociationAuthorization(params = {}, callback) ⇒ AWS.Request

Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a DeleteVPCAssociationAuthorization request.

Sending this request only prevents the AWS account that created the VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, DeleteVPCAssociationAuthorization won't disassociate the VPC from the hosted zone. If you want to delete an existing association, use DisassociateVPCFromHostedZone.

Examples:

Calling the deleteVPCAssociationAuthorization operation

var params = {
  HostedZoneId: 'STRING_VALUE', /* required */
  VPC: { /* required */
    VPCId: 'STRING_VALUE',
    VPCRegion: us-east-1 | us-east-2 | us-west-1 | us-west-2 | eu-west-1 | eu-west-2 | eu-central-1 | ap-southeast-1 | ap-southeast-2 | ap-south-1 | ap-northeast-1 | ap-northeast-2 | sa-east-1 | ca-central-1 | cn-north-1
  }
};
route53.deleteVPCAssociationAuthorization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HostedZoneId — (String)

      When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, the ID of the hosted zone.

    • VPC — (map)

      When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, a complex type that includes the ID and region of the VPC.

      • VPCRegion — (String)

        (Private hosted zones only) The region in which you created an Amazon VPC.

        Possible values include:
        • "us-east-1"
        • "us-east-2"
        • "us-west-1"
        • "us-west-2"
        • "eu-west-1"
        • "eu-west-2"
        • "eu-central-1"
        • "ap-southeast-1"
        • "ap-southeast-2"
        • "ap-south-1"
        • "ap-northeast-1"
        • "ap-northeast-2"
        • "sa-east-1"
        • "ca-central-1"
        • "cn-north-1"
      • VPCId — (String)

        (Private hosted zones only) The ID of an Amazon VPC.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateVPCFromHostedZone(params = {}, callback) ⇒ AWS.Request

Disassociates a VPC from a Amazon Route 53 private hosted zone.

Note: You can't disassociate the last VPC from a private hosted zone.

You can't disassociate a VPC from a private hosted zone when only one VPC is associated with the hosted zone. You also can't convert a private hosted zone into a public hosted zone.

Service Reference:

Examples:

Calling the disassociateVPCFromHostedZone operation

var params = {
  HostedZoneId: 'STRING_VALUE', /* required */
  VPC: { /* required */
    VPCId: 'STRING_VALUE',
    VPCRegion: us-east-1 | us-east-2 | us-west-1 | us-west-2 | eu-west-1 | eu-west-2 | eu-central-1 | ap-southeast-1 | ap-southeast-2 | ap-south-1 | ap-northeast-1 | ap-northeast-2 | sa-east-1 | ca-central-1 | cn-north-1
  },
  Comment: 'STRING_VALUE'
};
route53.disassociateVPCFromHostedZone(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HostedZoneId — (String)

      The ID of the private hosted zone that you want to disassociate a VPC from.

    • VPC — (map)

      A complex type that contains information about the VPC that you're disassociating from the specified hosted zone.

      • VPCRegion — (String)

        (Private hosted zones only) The region in which you created an Amazon VPC.

        Possible values include:
        • "us-east-1"
        • "us-east-2"
        • "us-west-1"
        • "us-west-2"
        • "eu-west-1"
        • "eu-west-2"
        • "eu-central-1"
        • "ap-southeast-1"
        • "ap-southeast-2"
        • "ap-south-1"
        • "ap-northeast-1"
        • "ap-northeast-2"
        • "sa-east-1"
        • "ca-central-1"
        • "cn-north-1"
      • VPCId — (String)

        (Private hosted zones only) The ID of an Amazon VPC.

    • Comment — (String)

      Optional: A comment about the disassociation request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ChangeInfo — (map)

        A complex type that describes the changes made to the specified private hosted zone.

        • Idrequired — (String)

          The ID of the request.

        • Statusrequired — (String)

          The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

          Possible values include:
          • "PENDING"
          • "INSYNC"
        • SubmittedAtrequired — (Date)

          The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

        • Comment — (String)

          A complex type that describes change information about changes made to your hosted zone.

          This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getChange(params = {}, callback) ⇒ AWS.Request

Returns the current status of a change batch request. The status is one of the following values:

  • PENDING indicates that the changes in this request have not propagated to all Amazon Route 53 DNS servers. This is the initial status of all change batch requests.

  • INSYNC indicates that the changes have propagated to all Amazon Route 53 DNS servers.

Service Reference:

Examples:

Calling the getChange operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
route53.getChange(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String)

      The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ChangeInfo — (map)

        A complex type that contains information about the specified change batch.

        • Idrequired — (String)

          The ID of the request.

        • Statusrequired — (String)

          The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

          Possible values include:
          • "PENDING"
          • "INSYNC"
        • SubmittedAtrequired — (Date)

          The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

        • Comment — (String)

          A complex type that describes change information about changes made to your hosted zone.

          This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

getCheckerIpRanges(params = {}, callback) ⇒ AWS.Request

GetCheckerIpRanges still works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all AWS services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide.

Service Reference:

Examples:

Calling the getCheckerIpRanges operation

var params = {
};
route53.getCheckerIpRanges(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CheckerIpRanges — (Array<String>)

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getGeoLocation(params = {}, callback) ⇒ AWS.Request

Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.

Use the following syntax to determine whether a continent is supported for geolocation:

GET /2013-04-01/geolocation?ContinentCode=two-letter abbreviation for a continent

Use the following syntax to determine whether a country is supported for geolocation:

GET /2013-04-01/geolocation?CountryCode=two-character country code

Use the following syntax to determine whether a subdivision of a country is supported for geolocation:

GET /2013-04-01/geolocation?CountryCode=two-character country code&SubdivisionCode=subdivision code

Service Reference:

Examples:

Calling the getGeoLocation operation

var params = {
  ContinentCode: 'STRING_VALUE',
  CountryCode: 'STRING_VALUE',
  SubdivisionCode: 'STRING_VALUE'
};
route53.getGeoLocation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ContinentCode — (String)

      Amazon Route 53 supports the following continent codes:

      • AF: Africa

      • AN: Antarctica

      • AS: Asia

      • EU: Europe

      • OC: Oceania

      • NA: North America

      • SA: South America

    • CountryCode — (String)

      Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.

    • SubdivisionCode — (String)

      Amazon Route 53 uses the one- to three-letter subdivision codes that are specified in ISO standard 3166-1 alpha-2. Amazon Route 53 doesn't support subdivision codes for all countries. If you specify SubdivisionCode, you must also specify CountryCode.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GeoLocationDetails — (map)

        A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code.

        • ContinentCode — (String)

          The two-letter code for the continent.

        • ContinentName — (String)

          The full name of the continent.

        • CountryCode — (String)

          The two-letter code for the country.

        • CountryName — (String)

          The name of the country.

        • SubdivisionCode — (String)

          The code for the subdivision, for example, a state in the United States or a province in Canada.

        • SubdivisionName — (String)

          The full name of the subdivision, for example, a state in the United States or a province in Canada.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getHealthCheck(params = {}, callback) ⇒ AWS.Request

Gets information about a specified health check.

Service Reference:

Examples:

Calling the getHealthCheck operation

var params = {
  HealthCheckId: 'STRING_VALUE' /* required */
};
route53.getHealthCheck(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HealthCheckId — (String)

      The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HealthCheck — (map)

        A complex type that contains information about one health check that is associated with the current AWS account.

        • Idrequired — (String)

          The identifier that Amazon Route 53assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.

        • CallerReferencerequired — (String)

          A unique string that you specified when you created the health check.

        • HealthCheckConfigrequired — (map)

          A complex type that contains detailed information about one health check.

          • IPAddress — (String)

            The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address returned by DNS, Amazon Route 53 then checks the health of the endpoint.

            Use one of the following formats for the value of IPAddress:

            • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

            • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

            If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

            For more information, see HealthCheckConfig$FullyQualifiedDomainName.

            Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

            When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

          • Port — (Integer)

            The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress.

          • Typerequired — (String)

            The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

            You can't change the value of Type after you create a health check.

            You can create the following types of health checks:

            • HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

            • HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

              If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

            • HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

            • HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

            • TCP: Amazon Route 53 tries to establish a TCP connection.

            • CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.

            • CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

            For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

            Possible values include:
            • "HTTP"
            • "HTTPS"
            • "HTTP_STR_MATCH"
            • "HTTPS_STR_MATCH"
            • "TCP"
            • "CALCULATED"
            • "CLOUDWATCH_METRIC"
          • ResourcePath — (String)

            The path, if any, 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, for example, the file /docs/route53-health-check.html.

          • FullyQualifiedDomainName — (String)

            Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

            If you specify a value for IPAddress:

            Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks.

            When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

            • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

            • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

            • If you specify another value for Port and any value except TCP for Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

            If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases.

            If you don't specify a value for IPAddress :

            Amazon Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint.

            Note: If you don't specify a value for IPAddress, Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

            If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

            In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

            In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a Host header.

          • SearchString — (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. If the string appears in the response body, Amazon Route 53 considers the resource healthy.

            Amazon Route 53 considers case when searching for SearchString in the response body.

          • RequestInterval — (Integer)

            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. Each Amazon Route 53 health checker makes requests at this interval.

            You can't change the value of RequestInterval after you create a health check.

            If you don't specify a value for RequestInterval, the default value is 30 seconds.

          • FailureThreshold — (Integer)

            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. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

            If you don't specify a value for FailureThreshold, the default value is three health checks.

          • MeasureLatency — (Boolean)

            Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.

            You can't change the value of MeasureLatency after you create a health check.

          • Inverted — (Boolean)

            Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

          • HealthThreshold — (Integer)

            The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.

            Note the following:

            • If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.

            • If you specify 0, Amazon Route 53 always considers this health check to be healthy.

          • ChildHealthChecks — (Array<String>)

            (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

          • EnableSNI — (Boolean)

            Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

            Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

            The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

          • Regions — (Array<String>)

            A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.

            If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.

            If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).

          • AlarmIdentifier — (map)

            A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

            • Regionrequired — (String)

              A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

              For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference.

              Possible values include:
              • "us-east-1"
              • "us-east-2"
              • "us-west-1"
              • "us-west-2"
              • "ca-central-1"
              • "eu-central-1"
              • "eu-west-1"
              • "eu-west-2"
              • "ap-south-1"
              • "ap-southeast-1"
              • "ap-southeast-2"
              • "ap-northeast-1"
              • "ap-northeast-2"
              • "sa-east-1"
            • Namerequired — (String)

              The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

          • InsufficientDataHealthStatus — (String)

            When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

            • Healthy: Amazon Route 53 considers the health check to be healthy.

            • Unhealthy: Amazon Route 53 considers the health check to be unhealthy.

            • LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

            Possible values include:
            • "Healthy"
            • "Unhealthy"
            • "LastKnownStatus"
        • HealthCheckVersionrequired — (Integer)

          The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.

        • CloudWatchAlarmConfiguration — (map)

          A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.

          • EvaluationPeriodsrequired — (Integer)

            For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.

          • Thresholdrequired — (Float)

            For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.

          • ComparisonOperatorrequired — (String)

            For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.

            Possible values include:
            • "GreaterThanOrEqualToThreshold"
            • "GreaterThanThreshold"
            • "LessThanThreshold"
            • "LessThanOrEqualToThreshold"
          • Periodrequired — (Integer)

            For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.

          • MetricNamerequired — (String)

            The name of the CloudWatch metric that the alarm is associated with.

          • Namespacerequired — (String)

            The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

          • Statisticrequired — (String)

            For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.

            Possible values include:
            • "Average"
            • "Sum"
            • "SampleCount"
            • "Maximum"
            • "Minimum"
          • Dimensions — (Array<map>)

            For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

            • Namerequired — (String)

              For the metric that the CloudWatch alarm is associated with, the name of one dimension.

            • Valuerequired — (String)

              For the metric that the CloudWatch alarm is associated with, the value of one dimension.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getHealthCheckCount(params = {}, callback) ⇒ AWS.Request

Retrieves the number of health checks that are associated with the current AWS account.

Service Reference:

Examples:

Calling the getHealthCheckCount operation

var params = {
};
route53.getHealthCheckCount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HealthCheckCount — (Integer)

        The number of health checks associated with the current AWS account.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getHealthCheckLastFailureReason(params = {}, callback) ⇒ AWS.Request

Gets the reason that a specified health check failed most recently.

Service Reference:

Examples:

Calling the getHealthCheckLastFailureReason operation

var params = {
  HealthCheckId: 'STRING_VALUE' /* required */
};
route53.getHealthCheckLastFailureReason(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HealthCheckId — (String)

      The ID for the health check for which you want the last failure reason. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HealthCheckObservations — (Array<map>)

        A list that contains one Observation element for each Amazon Route 53 health checker that is reporting a last failure reason.

        • Region — (String)

          The region of the Amazon Route 53 health checker that provided the status in StatusReport.

          Possible values include:
          • "us-east-1"
          • "us-west-1"
          • "us-west-2"
          • "eu-west-1"
          • "ap-southeast-1"
          • "ap-southeast-2"
          • "ap-northeast-1"
          • "sa-east-1"
        • IPAddress — (String)

          The IP address of the Amazon Route 53 health checker that provided the failure reason in StatusReport.

        • StatusReport — (map)

          A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker and the time of the failed health check.

          • Status — (String)

            A description of the status of the health check endpoint as reported by one of the Amazon Route 53 health checkers.

          • CheckedTime — (Date)

            The date and time that the health checker performed the health check in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getHealthCheckStatus(params = {}, callback) ⇒ AWS.Request

Gets status of a specified health check.

Service Reference:

Examples:

Calling the getHealthCheckStatus operation

var params = {
  HealthCheckId: 'STRING_VALUE' /* required */
};
route53.getHealthCheckStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HealthCheckId — (String)

      The ID for the health check that you want the current status for. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

      Note: If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use GetHealthCheckStatus to get the status of a calculated health check.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HealthCheckObservations — (Array<map>)

        A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker that is reporting a status about the health check endpoint.

        • Region — (String)

          The region of the Amazon Route 53 health checker that provided the status in StatusReport.

          Possible values include:
          • "us-east-1"
          • "us-west-1"
          • "us-west-2"
          • "eu-west-1"
          • "ap-southeast-1"
          • "ap-southeast-2"
          • "ap-northeast-1"
          • "sa-east-1"
        • IPAddress — (String)

          The IP address of the Amazon Route 53 health checker that provided the failure reason in StatusReport.

        • StatusReport — (map)

          A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker and the time of the failed health check.

          • Status — (String)

            A description of the status of the health check endpoint as reported by one of the Amazon Route 53 health checkers.

          • CheckedTime — (Date)

            The date and time that the health checker performed the health check in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getHostedZone(params = {}, callback) ⇒ AWS.Request

Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.

Service Reference:

Examples:

To get information about a hosted zone


/* The following example gets information about the Z3M3LMPEXAMPLE hosted zone. */

 var params = {
  Id: "Z3M3LMPEXAMPLE"
 };
 route53.getHostedZone(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DelegationSet: {
     NameServers: [
        "ns-2048.awsdns-64.com", 
        "ns-2049.awsdns-65.net", 
        "ns-2050.awsdns-66.org", 
        "ns-2051.awsdns-67.co.uk"
     ]
    }, 
    HostedZone: {
     CallerReference: "C741617D-04E4-F8DE-B9D7-0D150FC61C2E", 
     Config: {
      PrivateZone: false
     }, 
     Id: "/hostedzone/Z3M3LMPEXAMPLE", 
     Name: "myawsbucket.com.", 
     ResourceRecordSetCount: 8
    }
   }
   */
 });

Calling the getHostedZone operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
route53.getHostedZone(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String)

      The ID of the hosted zone that you want to get information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HostedZone — (map)

        A complex type that contains general information about the specified hosted zone.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to the hosted zone when you created it.

        • Namerequired — (String)

          The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.

          For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone.

        • CallerReferencerequired — (String)

          The value that you specified for CallerReference when you created the hosted zone.

        • Config — (map)

          A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response.

          • Comment — (String)

            Any comments that you want to include about the hosted zone.

          • PrivateZone — (Boolean)

            A value that indicates whether this is a private hosted zone.

        • ResourceRecordSetCount — (Integer)

          The number of resource record sets in the hosted zone.

      • DelegationSet — (map)

        A complex type that lists the Amazon Route 53 name servers for the specified hosted zone.

        • Id — (String)

          The ID that Amazon Route 53 assigns to a reusable delegation set.

        • CallerReference — (String)

          The value that you specified for CallerReference when you created the reusable delegation set.

        • NameServersrequired — (Array<String>)

          A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.

      • VPCs — (Array<map>)

        A complex type that contains information about the VPCs that are associated with the specified hosted zone.

        • VPCRegion — (String)

          (Private hosted zones only) The region in which you created an Amazon VPC.

          Possible values include:
          • "us-east-1"
          • "us-east-2"
          • "us-west-1"
          • "us-west-2"
          • "eu-west-1"
          • "eu-west-2"
          • "eu-central-1"
          • "ap-southeast-1"
          • "ap-southeast-2"
          • "ap-south-1"
          • "ap-northeast-1"
          • "ap-northeast-2"
          • "sa-east-1"
          • "ca-central-1"
          • "cn-north-1"
        • VPCId — (String)

          (Private hosted zones only) The ID of an Amazon VPC.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getHostedZoneCount(params = {}, callback) ⇒ AWS.Request

Retrieves the number of hosted zones that are associated with the current AWS account.

Service Reference:

Examples:

Calling the getHostedZoneCount operation

var params = {
};
route53.getHostedZoneCount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HostedZoneCount — (Integer)

        The total number of public and private hosted zones that are associated with the current AWS account.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getReusableDelegationSet(params = {}, callback) ⇒ AWS.Request

Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.

Service Reference:

Examples:

Calling the getReusableDelegationSet operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
route53.getReusableDelegationSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String)

      The ID of the reusable delegation set that you want to get a list of name servers for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DelegationSet — (map)

        A complex type that contains information about the reusable delegation set.

        • Id — (String)

          The ID that Amazon Route 53 assigns to a reusable delegation set.

        • CallerReference — (String)

          The value that you specified for CallerReference when you created the reusable delegation set.

        • NameServersrequired — (Array<String>)

          A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getTrafficPolicy(params = {}, callback) ⇒ AWS.Request

Gets information about a specific traffic policy version.

Service Reference:

Examples:

Calling the getTrafficPolicy operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Version: 0 /* required */
};
route53.getTrafficPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String)

      The ID of the traffic policy that you want to get information about.

    • Version — (Integer)

      The version number of the traffic policy that you want to get information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficPolicy — (map)

        A complex type that contains settings for the specified traffic policy.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to a traffic policy when you created it.

        • Versionrequired — (Integer)

          The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of Version is always 1.

        • Namerequired — (String)

          The name that you specified when you created the traffic policy.

        • Typerequired — (String)

          The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

          Possible values include:
          • "SOA"
          • "A"
          • "TXT"
          • "NS"
          • "CNAME"
          • "MX"
          • "NAPTR"
          • "PTR"
          • "SRV"
          • "SPF"
          • "AAAA"
        • Documentrequired — (String)

          The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see Traffic Policy Document Format.

        • Comment — (String)

          The comment that you specify in the CreateTrafficPolicy request, if any.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getTrafficPolicyInstance(params = {}, callback) ⇒ AWS.Request

Gets information about a specified traffic policy instance.

Note: After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.
Note: In the Amazon Route 53 console, traffic policy instances are known as policy records.

Service Reference:

Examples:

Calling the getTrafficPolicyInstance operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
route53.getTrafficPolicyInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String)

      The ID of the traffic policy instance that you want to get information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficPolicyInstance — (map)

        A complex type that contains settings for the traffic policy instance.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to the new traffic policy instance.

        • HostedZoneIdrequired — (String)

          The ID of the hosted zone that Amazon Route 53 created resource record sets in.

        • Namerequired — (String)

          The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance.

        • TTLrequired — (Integer)

          The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.

        • Staterequired — (String)

          The value of State is one of the following values:

          Applied

          Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Amazon Route 53 edge locations.

          Creating

          Amazon Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request completed successfully.

          Failed

          Amazon Route 53 wasn't able to create or update the resource record sets. When the value of State is Failed, see Message for an explanation of what caused the request to fail.

        • Messagerequired — (String)

          If State is Failed, an explanation of the reason for the failure. If State is another value, Message is empty.

        • TrafficPolicyIdrequired — (String)

          The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

        • TrafficPolicyVersionrequired — (Integer)

          The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

        • TrafficPolicyTyperequired — (String)

          The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.

          Possible values include:
          • "SOA"
          • "A"
          • "TXT"
          • "NS"
          • "CNAME"
          • "MX"
          • "NAPTR"
          • "PTR"
          • "SRV"
          • "SPF"
          • "AAAA"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getTrafficPolicyInstanceCount(params = {}, callback) ⇒ AWS.Request

Gets the number of traffic policy instances that are associated with the current AWS account.

Service Reference:

Examples:

Calling the getTrafficPolicyInstanceCount operation

var params = {
};
route53.getTrafficPolicyInstanceCount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficPolicyInstanceCount — (Integer)

        The number of traffic policy instances that are associated with the current AWS account.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listGeoLocations(params = {}, callback) ⇒ AWS.Request

Retrieves a list of supported geo locations.

Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country.

Service Reference:

Examples:

Calling the listGeoLocations operation

var params = {
  MaxItems: 'STRING_VALUE',
  StartContinentCode: 'STRING_VALUE',
  StartCountryCode: 'STRING_VALUE',
  StartSubdivisionCode: 'STRING_VALUE'
};
route53.listGeoLocations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • StartContinentCode — (String)

      The code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextContinentCode from the previous response has a value, enter that value in StartContinentCode to return the next page of results.

      Include StartContinentCode only if you want to list continents. Don't include StartContinentCode when you're listing countries or countries with their subdivisions.

    • StartCountryCode — (String)

      The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextCountryCode from the previous response has a value, enter that value in StartCountryCode to return the next page of results.

      Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.

    • StartSubdivisionCode — (String)

      The code for the subdivision (for example, state or province) with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextSubdivisionCode from the previous response has a value, enter that value in StartSubdivisionCode to return the next page of results.

      To list subdivisions of a country, you must include both StartCountryCode and StartSubdivisionCode.

    • MaxItems — (String)

      (Optional) The maximum number of geolocations to be included in the response body for this request. If more than MaxItems geolocations remain to be listed, then the value of the IsTruncated element in the response is true.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GeoLocationDetailsList — (Array<map>)

        A complex type that contains one GeoLocationDetails element for each location that Amazon Route 53 supports for geolocation.

        • ContinentCode — (String)

          The two-letter code for the continent.

        • ContinentName — (String)

          The full name of the continent.

        • CountryCode — (String)

          The two-letter code for the country.

        • CountryName — (String)

          The name of the country.

        • SubdivisionCode — (String)

          The code for the subdivision, for example, a state in the United States or a province in Canada.

        • SubdivisionName — (String)

          The full name of the subdivision, for example, a state in the United States or a province in Canada.

      • IsTruncated — (Boolean)

        A value that indicates whether more locations remain to be listed after the last location in this response. If so, the value of IsTruncated is true. To get more values, submit another request and include the values of NextContinentCode, NextCountryCode, and NextSubdivisionCode in the StartContinentCode, StartCountryCode, and StartSubdivisionCode, as applicable.

      • NextContinentCode — (String)

        If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextContinentCode in the StartContinentCode parameter in another ListGeoLocations request.

      • NextCountryCode — (String)

        If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextCountryCode in the StartCountryCode parameter in another ListGeoLocations request.

      • NextSubdivisionCode — (String)

        If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextSubdivisionCode in the StartSubdivisionCode parameter in another ListGeoLocations request.

      • MaxItems — (String)

        The value that you specified for MaxItems in the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listHealthChecks(params = {}, callback) ⇒ AWS.Request

Retrieve a list of the health checks that are associated with the current AWS account.

Service Reference:

Examples:

Calling the listHealthChecks operation

var params = {
  Marker: 'STRING_VALUE',
  MaxItems: 'STRING_VALUE'
};
route53.listHealthChecks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Marker — (String)

      If the value of IsTruncated in the previous response was true, you have more health checks. To get another group, submit another ListHealthChecks request.

      For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first health check that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more health checks to get.

    • MaxItems — (String)

      The maximum number of health checks that you want ListHealthChecks to return in response to the current request. Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100 health checks.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HealthChecks — (Array<map>)

        A complex type that contains one HealthCheck element for each health check that is associated with the current AWS account.

        • Idrequired — (String)

          The identifier that Amazon Route 53assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.

        • CallerReferencerequired — (String)

          A unique string that you specified when you created the health check.

        • HealthCheckConfigrequired — (map)

          A complex type that contains detailed information about one health check.

          • IPAddress — (String)

            The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address returned by DNS, Amazon Route 53 then checks the health of the endpoint.

            Use one of the following formats for the value of IPAddress:

            • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

            • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

            If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

            For more information, see HealthCheckConfig$FullyQualifiedDomainName.

            Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

            When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

          • Port — (Integer)

            The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress.

          • Typerequired — (String)

            The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

            You can't change the value of Type after you create a health check.

            You can create the following types of health checks:

            • HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

            • HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

              If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

            • HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

            • HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

            • TCP: Amazon Route 53 tries to establish a TCP connection.

            • CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.

            • CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

            For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

            Possible values include:
            • "HTTP"
            • "HTTPS"
            • "HTTP_STR_MATCH"
            • "HTTPS_STR_MATCH"
            • "TCP"
            • "CALCULATED"
            • "CLOUDWATCH_METRIC"
          • ResourcePath — (String)

            The path, if any, 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, for example, the file /docs/route53-health-check.html.

          • FullyQualifiedDomainName — (String)

            Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

            If you specify a value for IPAddress:

            Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks.

            When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

            • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

            • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

            • If you specify another value for Port and any value except TCP for Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

            If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases.

            If you don't specify a value for IPAddress :

            Amazon Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint.

            Note: If you don't specify a value for IPAddress, Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

            If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

            In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

            In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a Host header.

          • SearchString — (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. If the string appears in the response body, Amazon Route 53 considers the resource healthy.

            Amazon Route 53 considers case when searching for SearchString in the response body.

          • RequestInterval — (Integer)

            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. Each Amazon Route 53 health checker makes requests at this interval.

            You can't change the value of RequestInterval after you create a health check.

            If you don't specify a value for RequestInterval, the default value is 30 seconds.

          • FailureThreshold — (Integer)

            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. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

            If you don't specify a value for FailureThreshold, the default value is three health checks.

          • MeasureLatency — (Boolean)

            Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.

            You can't change the value of MeasureLatency after you create a health check.

          • Inverted — (Boolean)

            Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

          • HealthThreshold — (Integer)

            The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.

            Note the following:

            • If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.

            • If you specify 0, Amazon Route 53 always considers this health check to be healthy.

          • ChildHealthChecks — (Array<String>)

            (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

          • EnableSNI — (Boolean)

            Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

            Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

            The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

          • Regions — (Array<String>)

            A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.

            If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.

            If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).

          • AlarmIdentifier — (map)

            A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

            • Regionrequired — (String)

              A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

              For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference.

              Possible values include:
              • "us-east-1"
              • "us-east-2"
              • "us-west-1"
              • "us-west-2"
              • "ca-central-1"
              • "eu-central-1"
              • "eu-west-1"
              • "eu-west-2"
              • "ap-south-1"
              • "ap-southeast-1"
              • "ap-southeast-2"
              • "ap-northeast-1"
              • "ap-northeast-2"
              • "sa-east-1"
            • Namerequired — (String)

              The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

          • InsufficientDataHealthStatus — (String)

            When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

            • Healthy: Amazon Route 53 considers the health check to be healthy.

            • Unhealthy: Amazon Route 53 considers the health check to be unhealthy.

            • LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

            Possible values include:
            • "Healthy"
            • "Unhealthy"
            • "LastKnownStatus"
        • HealthCheckVersionrequired — (Integer)

          The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.

        • CloudWatchAlarmConfiguration — (map)

          A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.

          • EvaluationPeriodsrequired — (Integer)

            For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.

          • Thresholdrequired — (Float)

            For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.

          • ComparisonOperatorrequired — (String)

            For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.

            Possible values include:
            • "GreaterThanOrEqualToThreshold"
            • "GreaterThanThreshold"
            • "LessThanThreshold"
            • "LessThanOrEqualToThreshold"
          • Periodrequired — (Integer)

            For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.

          • MetricNamerequired — (String)

            The name of the CloudWatch metric that the alarm is associated with.

          • Namespacerequired — (String)

            The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

          • Statisticrequired — (String)

            For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.

            Possible values include:
            • "Average"
            • "Sum"
            • "SampleCount"
            • "Maximum"
            • "Minimum"
          • Dimensions — (Array<map>)

            For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

            • Namerequired — (String)

              For the metric that the CloudWatch alarm is associated with, the name of one dimension.

            • Valuerequired — (String)

              For the metric that the CloudWatch alarm is associated with, the value of one dimension.

      • Marker — (String)

        For the second and subsequent calls to ListHealthChecks, Marker is the value that you specified for the marker parameter in the previous request.

      • IsTruncated — (Boolean)

        A flag that indicates whether there are more health checks to be listed. If the response was truncated, you can get the next group of health checks by submitting another ListHealthChecks request and specifying the value of NextMarker in the marker parameter.

      • NextMarker — (String)

        If IsTruncated is true, the value of NextMarker identifies the first health check that Amazon Route 53 returns if you submit another ListHealthChecks request and specify the value of NextMarker in the marker parameter.

      • MaxItems — (String)

        The value that you specified for the maxitems parameter in the call to ListHealthChecks that produced the current response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listHostedZones(params = {}, callback) ⇒ AWS.Request

Retrieves a list of the public and private hosted zones that are associated with the current AWS account. The response includes a HostedZones child element for each hosted zone.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the maxitems parameter to list them in groups of up to 100.

Service Reference:

Examples:

Calling the listHostedZones operation

var params = {
  DelegationSetId: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxItems: 'STRING_VALUE'
};
route53.listHostedZones(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Marker — (String)

      If the value of IsTruncated in the previous response was true, you have more hosted zones. To get more hosted zones, submit another ListHostedZones request.

      For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more hosted zones to get.

    • MaxItems — (String)

      (Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than maxitems hosted zones, the value of IsTruncated in the response is true, and the value of NextMarker is the hosted zone ID of the first hosted zone that Amazon Route 53 will return if you submit another request.

    • DelegationSetId — (String)

      If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HostedZones — (Array<map>)

        A complex type that contains general information about the hosted zone.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to the hosted zone when you created it.

        • Namerequired — (String)

          The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.

          For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone.

        • CallerReferencerequired — (String)

          The value that you specified for CallerReference when you created the hosted zone.

        • Config — (map)

          A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response.

          • Comment — (String)

            Any comments that you want to include about the hosted zone.

          • PrivateZone — (Boolean)

            A value that indicates whether this is a private hosted zone.

        • ResourceRecordSetCount — (Integer)

          The number of resource record sets in the hosted zone.

      • Marker — (String)

        For the second and subsequent calls to ListHostedZones, Marker is the value that you specified for the marker parameter in the request that produced the current response.

      • IsTruncated — (Boolean)

        A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more hosted zones by submitting another ListHostedZones request and specifying the value of NextMarker in the marker parameter.

      • NextMarker — (String)

        If IsTruncated is true, the value of NextMarker identifies the first hosted zone in the next group of hosted zones. Submit another ListHostedZones request, and specify the value of NextMarker from the response in the marker parameter.

        This element is present only if IsTruncated is true.

      • MaxItems — (String)

        The value that you specified for the maxitems parameter in the call to ListHostedZones that produced the current response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listHostedZonesByName(params = {}, callback) ⇒ AWS.Request

Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element for each hosted zone created by the current AWS account.

ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example:

com.example.www.

Note the trailing dot, which can change the sort order in some circumstances.

If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as:

com.ex\344mple.

The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

Amazon Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next:

  • The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the dnsname and hostedzoneid parameters in the request that produced the current response.

  • The MaxItems element in the response contains the value, if any, that you specified for the maxitems parameter in the request that produced the current response.

  • If the value of IsTruncated in the response is true, there are more hosted zones associated with the current AWS account.

    If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response.

  • The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZonesByName, and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

Service Reference:

Examples:

Calling the listHostedZonesByName operation

var params = {
  DNSName: 'STRING_VALUE',
  HostedZoneId: 'STRING_VALUE',
  MaxItems: 'STRING_VALUE'
};
route53.listHostedZonesByName(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DNSName — (String)

      (Optional) For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the dnsname parameter, Amazon Route 53 returns all of the hosted zones that were created by the current AWS account, in ASCII order. For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response.

    • HostedZoneId — (String)

      (Optional) For your first request to ListHostedZonesByName, do not include the hostedzoneid parameter.

      If you have more hosted zones than the value of maxitems, ListHostedZonesByName returns only the first maxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to ListHostedZonesByName and include both dnsname and hostedzoneid parameters. For the value of hostedzoneid, specify the value of the NextHostedZoneId element from the previous response.

    • MaxItems — (String)

      The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems hosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and NextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HostedZones — (Array<map>)

        A complex type that contains general information about the hosted zone.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to the hosted zone when you created it.

        • Namerequired — (String)

          The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.

          For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone.

        • CallerReferencerequired — (String)

          The value that you specified for CallerReference when you created the hosted zone.

        • Config — (map)

          A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response.

          • Comment — (String)

            Any comments that you want to include about the hosted zone.

          • PrivateZone — (Boolean)

            A value that indicates whether this is a private hosted zone.

        • ResourceRecordSetCount — (Integer)

          The number of resource record sets in the hosted zone.

      • DNSName — (String)

        For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that you specified for the dnsname parameter in the request that produced the current response.

      • HostedZoneId — (String)

        The ID that Amazon Route 53 assigned to the hosted zone when you created it.

      • IsTruncated — (Boolean)

        A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of maxitems hosted zones by calling ListHostedZonesByName again and specifying the values of NextDNSName and NextHostedZoneId elements in the dnsname and hostedzoneid parameters.

      • NextDNSName — (String)

        If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

        This element is present only if IsTruncated is true.

      • NextHostedZoneId — (String)

        If IsTruncated is true, the value of NextHostedZoneId identifies the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

        This element is present only if IsTruncated is true.

      • MaxItems — (String)

        The value that you specified for the maxitems parameter in the call to ListHostedZonesByName that produced the current response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listResourceRecordSets(params = {}, callback) ⇒ AWS.Request

Lists the resource record sets in a specified hosted zone.

ListResourceRecordSets returns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements. The action sorts results first by DNS name with the labels reversed, for example:

com.example.www.

Note the trailing dot, which can change the sort order in some circumstances.

When multiple records have the same DNS name, the action sorts results by the record type.

You can use the name and type elements to adjust the beginning position of the list of resource record sets returned:

If you do not specify Name or Type

The results begin with the first resource record set that the hosted zone contains.

If you specify Name but not Type

The results begin with the first resource record set in the list whose name is greater than or equal to Name.

If you specify Type but not Name

Amazon Route 53 returns the InvalidInput error.

If you specify both Name and Type

The results begin with the first resource record set in the list whose name is greater than or equal to Name, and whose type is greater than or equal to Type.

This action returns the most current version of the records. This includes records that are PENDING, and that are not yet available on all Amazon Route 53 DNS servers.

To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a ChangeResourceRecordSets request while you're paging through the results of a ListResourceRecordSets request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.

Service Reference:

Examples:

Calling the listResourceRecordSets operation

var params = {
  HostedZoneId: 'STRING_VALUE', /* required */
  MaxItems: 'STRING_VALUE',
  StartRecordIdentifier: 'STRING_VALUE',
  StartRecordName: 'STRING_VALUE',
  StartRecordType: SOA | A | TXT | NS | CNAME | MX | NAPTR | PTR | SRV | SPF | AAAA
};
route53.listResourceRecordSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HostedZoneId — (String)

      The ID of the hosted zone that contains the resource record sets that you want to list.

    • StartRecordName — (String)

      The first name in the lexicographic ordering of resource record sets that you want to list.

    • StartRecordType — (String)

      The type of resource record set to begin the record listing from.

      Valid values for basic resource record sets: A | AAAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

      Values for weighted, latency, geo, and failover resource record sets: A | AAAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT

      Values for alias resource record sets:

      • CloudFront distribution: A or AAAA

      • Elastic Beanstalk environment that has a regionalized subdomain: A

      • ELB load balancer: A | AAAA

      • Amazon S3 bucket: A

      Constraint: Specifying type without specifying name returns an InvalidInput error.

      Possible values include:
      • "SOA"
      • "A"
      • "TXT"
      • "NS"
      • "CNAME"
      • "MX"
      • "NAPTR"
      • "PTR"
      • "SRV"
      • "SPF"
      • "AAAA"
    • StartRecordIdentifier — (String)

      Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

    • MaxItems — (String)

      (Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than maxitems resource record sets, the value of the IsTruncated element in the response is true, and the values of the NextRecordName and NextRecordType elements in the response identify the first resource record set in the next group of maxitems resource record sets.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceRecordSets — (Array<map>)

        Information about multiple resource record sets.

        • Namerequired — (String)

          The name of the domain you want to perform the action on.

          Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 still assumes that the domain name that you specify is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

          For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

          You can use the asterisk () wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following:

          • The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com.

          • The * can't replace any of the middle labels, for example, marketing..example.com.

          • If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.

            You can't use the * wildcard for resource records sets that have a type of NS.

          You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * for one of the middle labels, for example, marketing.*.example.com. In addition, the * must replace the entire label; for example, you can't specify prod*.example.com.

        • Typerequired — (String)

          The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

          Valid values for basic resource record sets: A | AAAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

          Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.

          Note: SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, "...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it." In RFC 7208, see section 14.1, The SPF DNS Record Type.

          Values for alias resource record sets:

          • CloudFront distributions: A

            If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA.

          • AWS Elastic Beanstalk environment that has a regionalized subdomain: A

          • ELB load balancers: A | AAAA

          • Amazon S3 buckets: A

          • Another resource record set in this hosted zone: Specify the type of the resource record set for which you're creating the alias. Specify any value except NS or SOA.

          Possible values include:
          • "SOA"
          • "A"
          • "TXT"
          • "NS"
          • "CNAME"
          • "MX"
          • "NAPTR"
          • "PTR"
          • "SRV"
          • "SPF"
          • "AAAA"
        • SetIdentifier — (String)

          Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type. The value of SetIdentifier must be unique for each resource record set that has the same combination of DNS name and type. Omit SetIdentifier for any other types of record sets.

        • Weight — (Integer)

          Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Amazon Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Amazon Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:

          • You must specify a value for the Weight element for every weighted resource record set.

          • You can only specify one ResourceRecord per weighted resource record set.

          • You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.

          • You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements.

          • For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Amazon Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.

            The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Amazon Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.

        • Region — (String)

          Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.

          Note: Creating latency and latency alias resource record sets in private hosted zones is not supported.

          When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Amazon Route 53 then returns the value that is associated with the selected resource record set.

          Note the following:

          • You can only specify one ResourceRecord per latency resource record set.

          • You can only create one latency resource record set for each Amazon EC2 Region.

          • You aren't required to create latency resource record sets for all Amazon EC2 Regions. Amazon Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.

          • You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.

          Possible values include:
          • "us-east-1"
          • "us-east-2"
          • "us-west-1"
          • "us-west-2"
          • "ca-central-1"
          • "eu-west-1"
          • "eu-west-2"
          • "eu-central-1"
          • "ap-southeast-1"
          • "ap-southeast-2"
          • "ap-northeast-1"
          • "ap-northeast-2"
          • "sa-east-1"
          • "cn-north-1"
          • "ap-south-1"
        • GeoLocation — (map)

          Geo location resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.

          Note: Creating geolocation and geolocation alias resource record sets in private hosted zones is not supported.

          If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.

          You can't create two geolocation resource record sets that specify the same geographic location.

          The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.

          Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Amazon Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *, which handles both queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Amazon Route 53 returns a "no answer" response for queries from those locations.

          You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.

          • ContinentCode — (String)

            The two-letter code for the continent.

            Valid values: AF | AN | AS | EU | OC | NA | SA

            Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

          • CountryCode — (String)

            The two-letter code for the country.

          • SubdivisionCode — (String)

            The code for the subdivision, for example, a state in the United States or a province in Canada.

        • Failover — (String)

          Failover resource record sets only: 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. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.

          Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:

          • When the primary resource record set is healthy, Amazon Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.

          • When the primary resource record set is unhealthy and the secondary resource record set is healthy, Amazon Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

          • When the secondary resource record set is unhealthy, Amazon Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.

          • If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Amazon Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.

          You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.

          For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.

          For more information about configuring failover for Amazon Route 53, see the following topics in the Amazon Route 53 Developer Guide:

          Possible values include:
          • "PRIMARY"
          • "SECONDARY"
        • TTL — (Integer)

          The resource record cache time to live (TTL), in seconds. Note the following:

          • If you're creating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL for the alias target.

          • If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.

          • All of the resource record sets in a group of weighted resource record sets must have the same value for TTL.

          • If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight.

        • ResourceRecords — (Array<map>)

          Information about the resource records to act upon.

          Note: If you're creating an alias resource record set, omit ResourceRecords.
          • Valuerequired — (String)

            The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, if the current value does not match the actual value, an error is returned. For descriptions about how to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

            You can specify more than one value for all record types except CNAME and SOA.

            Note: If you're creating an alias resource record set, omit Value.
        • AliasTarget — (map)

          Alias resource record sets only: Information about the CloudFront distribution, AWS Elastic Beanstalk environment, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you're redirecting queries. The AWS Elastic Beanstalk environment must have a regionalized subdomain.

          If you're creating resource records sets for a private hosted zone, note the following:

          • You can't create alias resource record sets for CloudFront distributions in a private hosted zone.

          • Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.

          • For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.

          • HostedZoneIdrequired — (String)

            Alias resource records sets only: The value used depends on where you want to route traffic:

            CloudFront distribution

            Specify Z2FDTNDATAQYW2.

            Note: Alias resource record sets for CloudFront can't be created in a private zone.
            Elastic Beanstalk environment

            Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the "AWS Regions and Endpoints" chapter of the Amazon Web Services General Reference.

            ELB load balancer

            Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:

            • Elastic Load Balancing table in the "AWS Regions and Endpoints" chapter of the Amazon Web Services General Reference: Use the value in the "Amazon Route 53 Hosted Zone ID" column that corresponds with the region that you created your load balancer in.

            • AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.

            • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameId. For more information, see the applicable guide:

            • AWS CLI: Use describe-load-balancers to get the value of CanonicalHostedZoneNameID.

            An Amazon S3 bucket configured as a static website

            Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the Amazon Simple Storage Service Website Endpoints table in the "AWS Regions and Endpoints" chapter of the Amazon Web Services General Reference.

            Another Amazon Route 53 resource record set in your hosted zone

            Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)

          • DNSNamerequired — (String)

            Alias resource record sets only: The value that you specify depends on where you want to route queries:

            CloudFront distribution

            Specify the domain name that CloudFront assigned when you created your distribution.

            Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.

            Elastic Beanstalk environment

            Specify the CNAME attribute for the environment. (The environment must have a regionalized domain name.) You can use the following methods to get the value of the CNAME attribute:

            • AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.

            • Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.

            • AWS CLI: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the AWS Command Line Interface Reference.

            ELB load balancer

            Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI.

            • AWS Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field. (If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack.)

            • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide:

            • AWS CLI: Use describe-load-balancers to get the value of DNSName.

            Amazon S3 bucket that is configured as a static website

            Specify the domain name of the Amazon S3 website endpoint in which you created the bucket, for example, s3-website-us-east-2.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.

            Another Amazon Route 53 resource record set

            Specify the value of the Name element for a resource record set in the current hosted zone.

          • EvaluateTargetHealthrequired — (Boolean)

            Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer, or the referenced resource record set.

            Note the following:

            • You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.

            • If the AWS resource that you specify in AliasTarget is a resource record set or a group of resource record sets (for example, a group of weighted resource record sets), but it is not another alias resource record set, we recommend that you associate a health check with all of the resource record sets in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.

            • If you specify an Elastic Beanstalk environment in HostedZoneId and DNSName, and if the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one EC2 instance.) If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Amazon Route 53 routes queries to other available resources that are healthy, if any.

              If the environment contains a single EC2 instance, there are no special requirements.

            • If you specify an ELB load balancer in AliasTarget , ELB routes queries only to the healthy EC2 instances that are registered with the load balancer. If no EC2 instances are healthy or if the load balancer itself is unhealthy, and if EvaluateTargetHealth is true for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources. When you create a load balancer, you configure settings for ELB health checks; they're not Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health checks for the EC2 instances that you register with an ELB load balancer.

              For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developer Guide.

            • We recommend that you set EvaluateTargetHealth to true only when you have enough idle capacity to handle the failure of one or more endpoints.

            For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

        • HealthCheckId — (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.

          Amazon Route 53 determines whether a resource record set is healthy based on one of the following:

          • By periodically sending a request to the endpoint that is specified in the health check

          • By aggregating the status of a specified group of health checks (calculated health checks)

          • By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

          For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy.

          The HealthCheckId element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations:

          • You're checking the health of the resource record sets in a group of weighted, latency, geolocation, or failover resource record sets, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.

          • You set EvaluateTargetHealth to true for the resource record sets in a group of alias, weighted alias, latency alias, geolocation alias, or failover alias resource record sets, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets.

          Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check.

          For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is *), in that order, until it finds a resource record set for which the endpoint is healthy.

          If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (example.com).

          n this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and then associate the health check with those resource record sets, health check results will be unpredictable.

          For more information, see the following topics in the Amazon Route 53 Developer Guide:

        • TrafficPolicyInstanceId — (String)

          When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. TrafficPolicyInstanceId is the ID of the traffic policy instance that Amazon Route 53 created this resource record set for.

          To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Amazon Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Amazon Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

      • IsTruncated — (Boolean)

        A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can make a follow-up pagination request by using the NextRecordName element.

      • NextRecordName — (String)

        If the results were truncated, the name of the next record in the list.

        This element is present only if IsTruncated is true.

      • NextRecordType — (String)

        If the results were truncated, the type of the next record in the list.

        This element is present only if IsTruncated is true.

        Possible values include:
        • "SOA"
        • "A"
        • "TXT"
        • "NS"
        • "CNAME"
        • "MX"
        • "NAPTR"
        • "PTR"
        • "SRV"
        • "SPF"
        • "AAAA"
      • NextRecordIdentifier — (String)

        Weighted, latency, geolocation, and failover resource record sets only: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.

      • MaxItems — (String)

        The maximum number of records you requested.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listReusableDelegationSets(params = {}, callback) ⇒ AWS.Request

Retrieves a list of the reusable delegation sets that are associated with the current AWS account.

Service Reference:

Examples:

Calling the listReusableDelegationSets operation

var params = {
  Marker: 'STRING_VALUE',
  MaxItems: 'STRING_VALUE'
};
route53.listReusableDelegationSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Marker — (String)

      If the value of IsTruncated in the previous response was true, you have more reusable delegation sets. To get another group, submit another ListReusableDelegationSets request.

      For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first reusable delegation set that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more reusable delegation sets to get.

    • MaxItems — (String)

      The number of reusable delegation sets that you want Amazon Route 53 to return in the response to this request. If you specify a value greater than 100, Amazon Route 53 returns only the first 100 reusable delegation sets.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DelegationSets — (Array<map>)

        A complex type that contains one DelegationSet element for each reusable delegation set that was created by the current AWS account.

        • Id — (String)

          The ID that Amazon Route 53 assigns to a reusable delegation set.

        • CallerReference — (String)

          The value that you specified for CallerReference when you created the reusable delegation set.

        • NameServersrequired — (Array<String>)

          A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.

      • Marker — (String)

        For the second and subsequent calls to ListReusableDelegationSets, Marker is the value that you specified for the marker parameter in the request that produced the current response.

      • IsTruncated — (Boolean)

        A flag that indicates whether there are more reusable delegation sets to be listed.

      • NextMarker — (String)

        If IsTruncated is true, the value of NextMarker identifies the next reusable delegation set that Amazon Route 53 will return if you submit another ListReusableDelegationSets request and specify the value of NextMarker in the marker parameter.

      • MaxItems — (String)

        The value that you specified for the maxitems parameter in the call to ListReusableDelegationSets that produced the current response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists tags for one health check or hosted zone.

For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: healthcheck | hostedzone /* required */
};
route53.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceType — (String)

      The type of the resource.

      • The resource type for health checks is healthcheck.

      • The resource type for hosted zones is hostedzone.

      Possible values include:
      • "healthcheck"
      • "hostedzone"
    • ResourceId — (String)

      The ID of the resource for which you want to retrieve tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceTagSet — (map)

        A ResourceTagSet containing tags associated with the specified resource.

        • ResourceType — (String)

          The type of the resource.

          • The resource type for health checks is healthcheck.

          • The resource type for hosted zones is hostedzone.

          Possible values include:
          • "healthcheck"
          • "hostedzone"
        • ResourceId — (String)

          The ID for the specified resource.

        • Tags — (Array<map>)

          The tags associated with the specified resource.

          • Key — (String)

            The value of Key depends on the operation that you want to perform:

            • Add a tag to a health check or hosted zone: Key is the name that you want to give the new tag.

            • Edit a tag: Key is the name of the tag that you want to change the Value for.

            • Delete a key: Key is the name of the tag you want to remove.

            • Give a name to a health check: Edit the default Name tag. In the Amazon Route 53 console, the list of your health checks includes a Name column that lets you see the name that you've given to each health check.

          • Value — (String)

            The value of Value depends on the operation that you want to perform:

            • Add a tag to a health check or hosted zone: Value is the value that you want to give the new tag.

            • Edit a tag: Value is the new value that you want to assign the tag.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResources(params = {}, callback) ⇒ AWS.Request

Lists tags for up to 10 health checks or hosted zones.

For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Service Reference:

Examples:

Calling the listTagsForResources operation

var params = {
  ResourceIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ResourceType: healthcheck | hostedzone /* required */
};
route53.listTagsForResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceType — (String)

      The type of the resources.

      • The resource type for health checks is healthcheck.

      • The resource type for hosted zones is hostedzone.

      Possible values include:
      • "healthcheck"
      • "hostedzone"
    • ResourceIds — (Array<String>)

      A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceTagSets — (Array<map>)

        A list of ResourceTagSets containing tags associated with the specified resources.

        • ResourceType — (String)

          The type of the resource.

          • The resource type for health checks is healthcheck.

          • The resource type for hosted zones is hostedzone.

          Possible values include:
          • "healthcheck"
          • "hostedzone"
        • ResourceId — (String)

          The ID for the specified resource.

        • Tags — (Array<map>)

          The tags associated with the specified resource.

          • Key — (String)

            The value of Key depends on the operation that you want to perform:

            • Add a tag to a health check or hosted zone: Key is the name that you want to give the new tag.

            • Edit a tag: Key is the name of the tag that you want to change the Value for.

            • Delete a key: Key is the name of the tag you want to remove.

            • Give a name to a health check: Edit the default Name tag. In the Amazon Route 53 console, the list of your health checks includes a Name column that lets you see the name that you've given to each health check.

          • Value — (String)

            The value of Value depends on the operation that you want to perform:

            • Add a tag to a health check or hosted zone: Value is the value that you want to give the new tag.

            • Edit a tag: Value is the new value that you want to assign the tag.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTrafficPolicies(params = {}, callback) ⇒ AWS.Request

Gets information about the latest version for every traffic policy that is associated with the current AWS account. Policies are listed in the order in which they were created.

Service Reference:

Examples:

Calling the listTrafficPolicies operation

var params = {
  MaxItems: 'STRING_VALUE',
  TrafficPolicyIdMarker: 'STRING_VALUE'
};
route53.listTrafficPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TrafficPolicyIdMarker — (String)

      (Conditional) For your first request to ListTrafficPolicies, don't include the TrafficPolicyIdMarker parameter.

      If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic policies. To get the next group of policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of TrafficPolicyIdMarker that was returned in the previous response.

    • MaxItems — (String)

      (Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than MaxItems traffic policies, the value of IsTruncated in the response is true, and the value of TrafficPolicyIdMarker is the ID of the first traffic policy that Amazon Route 53 will return if you submit another request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficPolicySummaries — (Array<map>)

        A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current AWS account.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to the traffic policy when you created it.

        • Namerequired — (String)

          The name that you specified for the traffic policy when you created it.

        • Typerequired — (String)

          The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

          Possible values include:
          • "SOA"
          • "A"
          • "TXT"
          • "NS"
          • "CNAME"
          • "MX"
          • "NAPTR"
          • "PTR"
          • "SRV"
          • "SPF"
          • "AAAA"
        • LatestVersionrequired — (Integer)

          The version number of the latest version of the traffic policy.

        • TrafficPolicyCountrequired — (Integer)

          The number of traffic policies that are associated with the current AWS account.

      • IsTruncated — (Boolean)

        A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another ListTrafficPolicies request and specifying the value of TrafficPolicyIdMarker in the TrafficPolicyIdMarker request parameter.

      • TrafficPolicyIdMarker — (String)

        If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies.

      • MaxItems — (String)

        The value that you specified for the MaxItems parameter in the ListTrafficPolicies request that produced the current response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTrafficPolicyInstances(params = {}, callback) ⇒ AWS.Request

Gets information about the traffic policy instances that you created by using the current AWS account.

Note: After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

Service Reference:

Examples:

Calling the listTrafficPolicyInstances operation

var params = {
  HostedZoneIdMarker: 'STRING_VALUE',
  MaxItems: 'STRING_VALUE',
  TrafficPolicyInstanceNameMarker: 'STRING_VALUE',
  TrafficPolicyInstanceTypeMarker: SOA | A | TXT | NS | CNAME | MX | NAPTR | PTR | SRV | SPF | AAAA
};
route53.listTrafficPolicyInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HostedZoneIdMarker — (String)

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneId, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of traffic policy instances.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    • TrafficPolicyInstanceNameMarker — (String)

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    • TrafficPolicyInstanceTypeMarker — (String)

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

      Possible values include:
      • "SOA"
      • "A"
      • "TXT"
      • "NS"
      • "CNAME"
      • "MX"
      • "NAPTR"
      • "PTR"
      • "SRV"
      • "SPF"
      • "AAAA"
    • MaxItems — (String)

      The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a ListTrafficPolicyInstances request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficPolicyInstances — (Array<map>)

        A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to the new traffic policy instance.

        • HostedZoneIdrequired — (String)

          The ID of the hosted zone that Amazon Route 53 created resource record sets in.

        • Namerequired — (String)

          The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance.

        • TTLrequired — (Integer)

          The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.

        • Staterequired — (String)

          The value of State is one of the following values:

          Applied

          Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Amazon Route 53 edge locations.

          Creating

          Amazon Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request completed successfully.

          Failed

          Amazon Route 53 wasn't able to create or update the resource record sets. When the value of State is Failed, see Message for an explanation of what caused the request to fail.

        • Messagerequired — (String)

          If State is Failed, an explanation of the reason for the failure. If State is another value, Message is empty.

        • TrafficPolicyIdrequired — (String)

          The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

        • TrafficPolicyVersionrequired — (Integer)

          The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

        • TrafficPolicyTyperequired — (String)

          The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.

          Possible values include:
          • "SOA"
          • "A"
          • "TXT"
          • "NS"
          • "CNAME"
          • "MX"
          • "NAPTR"
          • "PTR"
          • "SRV"
          • "SPF"
          • "AAAA"
      • HostedZoneIdMarker — (String)

        If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance that Amazon Route 53 will return if you submit another ListTrafficPolicyInstances request.

      • TrafficPolicyInstanceNameMarker — (String)

        If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another ListTrafficPolicyInstances request.

      • TrafficPolicyInstanceTypeMarker — (String)

        If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance that Amazon Route 53 will return if you submit another ListTrafficPolicyInstances request.

        Possible values include:
        • "SOA"
        • "A"
        • "TXT"
        • "NS"
        • "CNAME"
        • "MX"
        • "NAPTR"
        • "PTR"
        • "SRV"
        • "SPF"
        • "AAAA"
      • IsTruncated — (Boolean)

        A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get more traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.

      • MaxItems — (String)

        The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTrafficPolicyInstancesByHostedZone(params = {}, callback) ⇒ AWS.Request

Gets information about the traffic policy instances that you created in a specified hosted zone.

Note: After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

Examples:

Calling the listTrafficPolicyInstancesByHostedZone operation

var params = {
  HostedZoneId: 'STRING_VALUE', /* required */
  MaxItems: 'STRING_VALUE',
  TrafficPolicyInstanceNameMarker: 'STRING_VALUE',
  TrafficPolicyInstanceTypeMarker: SOA | A | TXT | NS | CNAME | MX | NAPTR | PTR | SRV | SPF | AAAA
};
route53.listTrafficPolicyInstancesByHostedZone(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HostedZoneId — (String)

      The ID of the hosted zone that you want to list traffic policy instances for.

    • TrafficPolicyInstanceNameMarker — (String)

      If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    • TrafficPolicyInstanceTypeMarker — (String)

      If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

      Possible values include:
      • "SOA"
      • "A"
      • "TXT"
      • "NS"
      • "CNAME"
      • "MX"
      • "NAPTR"
      • "PTR"
      • "SRV"
      • "SPF"
      • "AAAA"
    • MaxItems — (String)

      The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficPolicyInstances — (Array<map>)

        A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to the new traffic policy instance.

        • HostedZoneIdrequired — (String)

          The ID of the hosted zone that Amazon Route 53 created resource record sets in.

        • Namerequired — (String)

          The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance.

        • TTLrequired — (Integer)

          The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.

        • Staterequired — (String)

          The value of State is one of the following values:

          Applied

          Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Amazon Route 53 edge locations.

          Creating

          Amazon Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request completed successfully.

          Failed

          Amazon Route 53 wasn't able to create or update the resource record sets. When the value of State is Failed, see Message for an explanation of what caused the request to fail.

        • Messagerequired — (String)

          If State is Failed, an explanation of the reason for the failure. If State is another value, Message is empty.

        • TrafficPolicyIdrequired — (String)

          The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

        • TrafficPolicyVersionrequired — (Integer)

          The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

        • TrafficPolicyTyperequired — (String)

          The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.

          Possible values include:
          • "SOA"
          • "A"
          • "TXT"
          • "NS"
          • "CNAME"
          • "MX"
          • "NAPTR"
          • "PTR"
          • "SRV"
          • "SPF"
          • "AAAA"
      • TrafficPolicyInstanceNameMarker — (String)

        If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of traffic policy instances.

      • TrafficPolicyInstanceTypeMarker — (String)

        If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of traffic policy instances.

        Possible values include:
        • "SOA"
        • "A"
        • "TXT"
        • "NS"
        • "CNAME"
        • "MX"
        • "NAPTR"
        • "PTR"
        • "SRV"
        • "SPF"
        • "AAAA"
      • IsTruncated — (Boolean)

        A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by submitting another ListTrafficPolicyInstancesByHostedZone request and specifying the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.

      • MaxItems — (String)

        The value that you specified for the MaxItems parameter in the ListTrafficPolicyInstancesByHostedZone request that produced the current response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTrafficPolicyInstancesByPolicy(params = {}, callback) ⇒ AWS.Request

Gets information about the traffic policy instances that you created by using a specify traffic policy version.

Note: After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

Examples:

Calling the listTrafficPolicyInstancesByPolicy operation

var params = {
  TrafficPolicyId: 'STRING_VALUE', /* required */
  TrafficPolicyVersion: 0, /* required */
  HostedZoneIdMarker: 'STRING_VALUE',
  MaxItems: 'STRING_VALUE',
  TrafficPolicyInstanceNameMarker: 'STRING_VALUE',
  TrafficPolicyInstanceTypeMarker: SOA | A | TXT | NS | CNAME | MX | NAPTR | PTR | SRV | SPF | AAAA
};
route53.listTrafficPolicyInstancesByPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TrafficPolicyId — (String)

      The ID of the traffic policy for which you want to list traffic policy instances.

    • TrafficPolicyVersion — (Integer)

      The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

    • HostedZoneIdMarker — (String)

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

      For the value of hostedzoneid, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    • TrafficPolicyInstanceNameMarker — (String)

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

      For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    • TrafficPolicyInstanceTypeMarker — (String)

      If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

      For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

      If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

      Possible values include:
      • "SOA"
      • "A"
      • "TXT"
      • "NS"
      • "CNAME"
      • "MX"
      • "NAPTR"
      • "PTR"
      • "SRV"
      • "SPF"
      • "AAAA"
    • MaxItems — (String)

      The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficPolicyInstances — (Array<map>)

        A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to the new traffic policy instance.

        • HostedZoneIdrequired — (String)

          The ID of the hosted zone that Amazon Route 53 created resource record sets in.

        • Namerequired — (String)

          The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance.

        • TTLrequired — (Integer)

          The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.

        • Staterequired — (String)

          The value of State is one of the following values:

          Applied

          Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Amazon Route 53 edge locations.

          Creating

          Amazon Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request completed successfully.

          Failed

          Amazon Route 53 wasn't able to create or update the resource record sets. When the value of State is Failed, see Message for an explanation of what caused the request to fail.

        • Messagerequired — (String)

          If State is Failed, an explanation of the reason for the failure. If State is another value, Message is empty.

        • TrafficPolicyIdrequired — (String)

          The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

        • TrafficPolicyVersionrequired — (Integer)

          The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

        • TrafficPolicyTyperequired — (String)

          The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.

          Possible values include:
          • "SOA"
          • "A"
          • "TXT"
          • "NS"
          • "CNAME"
          • "MX"
          • "NAPTR"
          • "PTR"
          • "SRV"
          • "SPF"
          • "AAAA"
      • HostedZoneIdMarker — (String)

        If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of traffic policy instances.

      • TrafficPolicyInstanceNameMarker — (String)

        If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

      • TrafficPolicyInstanceTypeMarker — (String)

        If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

        Possible values include:
        • "SOA"
        • "A"
        • "TXT"
        • "NS"
        • "CNAME"
        • "MX"
        • "NAPTR"
        • "PTR"
        • "SRV"
        • "SPF"
        • "AAAA"
      • IsTruncated — (Boolean)

        A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by calling ListTrafficPolicyInstancesByPolicy again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

      • MaxItems — (String)

        The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy that produced the current response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTrafficPolicyVersions(params = {}, callback) ⇒ AWS.Request

Gets information about all of the versions for a specified traffic policy.

Traffic policy versions are listed in numerical order by VersionNumber.

Service Reference:

Examples:

Calling the listTrafficPolicyVersions operation

var params = {
  Id: 'STRING_VALUE', /* required */
  MaxItems: 'STRING_VALUE',
  TrafficPolicyVersionMarker: 'STRING_VALUE'
};
route53.listTrafficPolicyVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String)

      Specify the value of Id of the traffic policy for which you want to list all versions.

    • TrafficPolicyVersionMarker — (String)

      For your first request to ListTrafficPolicyVersions, don't include the TrafficPolicyVersionMarker parameter.

      If you have more traffic policy versions than the value of MaxItems, ListTrafficPolicyVersions returns only the first group of MaxItems versions. To get more traffic policy versions, submit another ListTrafficPolicyVersions request. For the value of TrafficPolicyVersionMarker, specify the value of TrafficPolicyVersionMarker in the previous response.

    • MaxItems — (String)

      The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than MaxItems versions, the value of IsTruncated in the response is true, and the value of the TrafficPolicyVersionMarker element is the ID of the first version that Amazon Route 53 will return if you submit another request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficPolicies — (Array<map>)

        A list that contains one TrafficPolicy element for each traffic policy version that is associated with the specified traffic policy.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to a traffic policy when you created it.

        • Versionrequired — (Integer)

          The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of Version is always 1.

        • Namerequired — (String)

          The name that you specified when you created the traffic policy.

        • Typerequired — (String)

          The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

          Possible values include:
          • "SOA"
          • "A"
          • "TXT"
          • "NS"
          • "CNAME"
          • "MX"
          • "NAPTR"
          • "PTR"
          • "SRV"
          • "SPF"
          • "AAAA"
        • Documentrequired — (String)

          The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see Traffic Policy Document Format.

        • Comment — (String)

          The comment that you specify in the CreateTrafficPolicy request, if any.

      • IsTruncated — (Boolean)

        A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another ListTrafficPolicyVersions request and specifying the value of NextMarker in the marker parameter.

      • TrafficPolicyVersionMarker — (String)

        If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the first traffic policy that Amazon Route 53 will return if you submit another request. Call ListTrafficPolicyVersions again and specify the value of TrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter.

        This element is present only if IsTruncated is true.

      • MaxItems — (String)

        The value that you specified for the maxitems parameter in the ListTrafficPolicyVersions request that produced the current response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listVPCAssociationAuthorizations(params = {}, callback) ⇒ AWS.Request

Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more CreateVPCAssociationAuthorization requests.

The response includes a VPCs element with a VPC child element for each VPC that can be associated with the hosted zone.

Examples:

Calling the listVPCAssociationAuthorizations operation

var params = {
  HostedZoneId: 'STRING_VALUE', /* required */
  MaxResults: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
route53.listVPCAssociationAuthorizations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HostedZoneId — (String)

      The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone.

    • NextToken — (String)

      Optional: If a response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of results, submit another request, and include the value of NextToken from the response in the nexttoken parameter in another ListVPCAssociationAuthorizations request.

    • MaxResults — (String)

      Optional: An integer that specifies the maximum number of VPCs that you want Amazon Route 53 to return. If you don't specify a value for MaxResults, Amazon Route 53 returns up to 50 VPCs per page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HostedZoneId — (String)

        The ID of the hosted zone that you can associate the listed VPCs with.

      • NextToken — (String)

        When the response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of VPCs, submit another ListVPCAssociationAuthorizations request, and include the value of the NextToken element from the response in the nexttoken request parameter.

      • VPCs — (Array<map>)

        The list of VPCs that are authorized to be associated with the specified hosted zone.

        • VPCRegion — (String)

          (Private hosted zones only) The region in which you created an Amazon VPC.

          Possible values include:
          • "us-east-1"
          • "us-east-2"
          • "us-west-1"
          • "us-west-2"
          • "eu-west-1"
          • "eu-west-2"
          • "eu-central-1"
          • "ap-southeast-1"
          • "ap-southeast-2"
          • "ap-south-1"
          • "ap-northeast-1"
          • "ap-northeast-2"
          • "sa-east-1"
          • "ca-central-1"
          • "cn-north-1"
        • VPCId — (String)

          (Private hosted zones only) The ID of an Amazon VPC.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

testDNSAnswer(params = {}, callback) ⇒ AWS.Request

Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.

Service Reference:

Examples:

Calling the testDNSAnswer operation

var params = {
  HostedZoneId: 'STRING_VALUE', /* required */
  RecordName: 'STRING_VALUE', /* required */
  RecordType: SOA | A | TXT | NS | CNAME | MX | NAPTR | PTR | SRV | SPF | AAAA, /* required */
  EDNS0ClientSubnetIP: 'STRING_VALUE',
  EDNS0ClientSubnetMask: 'STRING_VALUE',
  ResolverIP: 'STRING_VALUE'
};
route53.testDNSAnswer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HostedZoneId — (String)

      The ID of the hosted zone that you want Amazon Route 53 to simulate a query for.

    • RecordName — (String)

      The name of the resource record set that you want Amazon Route 53 to simulate a query for.

    • RecordType — (String)

      The type of the resource record set.

      Possible values include:
      • "SOA"
      • "A"
      • "TXT"
      • "NS"
      • "CNAME"
      • "MX"
      • "NAPTR"
      • "PTR"
      • "SRV"
      • "SPF"
      • "AAAA"
    • ResolverIP — (String)

      If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. If you omit this value, TestDnsAnswer uses the IP address of a DNS resolver in the AWS US East (N. Virginia) Region (us-east-1).

    • EDNS0ClientSubnetIP — (String)

      If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or IPv6 address of a client in the applicable location, for example, 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.

    • EDNS0ClientSubnetMask — (String)

      If you specify an IP address for edns0clientsubnetip, you can optionally specify the number of bits of the IP address that you want the checking tool to include in the DNS query. For example, if you specify 192.0.2.44 for edns0clientsubnetip and 24 for edns0clientsubnetmask, the checking tool will simulate a request from 192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6 addresses.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Nameserver — (String)

        The Amazon Route 53 name server used to respond to the request.

      • RecordName — (String)

        The name of the resource record set that you submitted a request for.

      • RecordType — (String)

        The type of the resource record set that you submitted a request for.

        Possible values include:
        • "SOA"
        • "A"
        • "TXT"
        • "NS"
        • "CNAME"
        • "MX"
        • "NAPTR"
        • "PTR"
        • "SRV"
        • "SPF"
        • "AAAA"
      • RecordData — (Array<String>)

        A list that contains values that Amazon Route 53 returned for this resource record set.

      • ResponseCode — (String)

        A code that indicates whether the request is valid or not. The most common response code is NOERROR, meaning that the request is valid. If the response is not valid, Amazon Route 53 returns a response code that describes the error. For a list of possible response codes, see DNS RCODES on the IANA website.

      • Protocol — (String)

        The protocol that Amazon Route 53 used to respond to the request, either UDP or TCP.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateHealthCheck(params = {}, callback) ⇒ AWS.Request

Updates an existing health check. Note that some values can't be updated.

For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.

Service Reference:

Examples:

Calling the updateHealthCheck operation

var params = {
  HealthCheckId: 'STRING_VALUE', /* required */
  AlarmIdentifier: {
    Name: 'STRING_VALUE', /* required */
    Region: us-east-1 | us-east-2 | us-west-1 | us-west-2 | ca-central-1 | eu-central-1 | eu-west-1 | eu-west-2 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | ap-northeast-2 | sa-east-1 /* required */
  },
  ChildHealthChecks: [
    'STRING_VALUE',
    /* more items */
  ],
  EnableSNI: true || false,
  FailureThreshold: 0,
  FullyQualifiedDomainName: 'STRING_VALUE',
  HealthCheckVersion: 0,
  HealthThreshold: 0,
  IPAddress: 'STRING_VALUE',
  InsufficientDataHealthStatus: Healthy | Unhealthy | LastKnownStatus,
  Inverted: true || false,
  Port: 0,
  Regions: [
    us-east-1 | us-west-1 | us-west-2 | eu-west-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | sa-east-1,
    /* more items */
  ],
  ResourcePath: 'STRING_VALUE',
  SearchString: 'STRING_VALUE'
};
route53.updateHealthCheck(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HealthCheckId — (String)

      The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

    • HealthCheckVersion — (Integer)

      A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check.

      We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Amazon Route 53 from overwriting an intervening update:

      • If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Amazon Route 53 updates the health check with the new settings.

      • If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Amazon Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

    • IPAddress — (String)

      The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Amazon Route 53 then checks the health of the endpoint.

      Use one of the following formats for the value of IPAddress:

      • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

      • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

      If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

      Note: If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

      For more information, see UpdateHealthCheckRequest$FullyQualifiedDomainName.

      Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

    • Port — (Integer)

      The port on the endpoint on which you want Amazon Route 53 to perform health checks.

    • ResourcePath — (String)

      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, for example the file /docs/route53-health-check.html.

      Specify this value only if you want to change it.

    • FullyQualifiedDomainName — (String)

      Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

      Note: If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

      If you specify a value for IPAddress:

      Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks.

      When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

      • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

      • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

      • If you specify another value for Port and any value except TCP for Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

      If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

      If you don't specify a value for IPAddress:

      If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Amazon Route 53 then checks the health of the endpoint.

      Note: If you don't specify a value for IPAddress, Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

      If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

      In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

      In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a Host header.

    • SearchString — (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. If the string appears in the response body, Amazon Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)

    • FailureThreshold — (Integer)

      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. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

      If you don't specify a value for FailureThreshold, the default value is three health checks.

    • Inverted — (Boolean)

      Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

    • HealthThreshold — (Integer)

      The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements.

      Note the following:

      • If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.

      • If you specify 0, Amazon Route 53 always considers this health check to be healthy.

    • ChildHealthChecks — (Array<String>)

      A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

    • EnableSNI — (Boolean)

      Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

      Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

      The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

    • Regions — (Array<String>)

      A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.

    • AlarmIdentifier — (map)

      A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

      • Regionrequired — (String)

        A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

        For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference.

        Possible values include:
        • "us-east-1"
        • "us-east-2"
        • "us-west-1"
        • "us-west-2"
        • "ca-central-1"
        • "eu-central-1"
        • "eu-west-1"
        • "eu-west-2"
        • "ap-south-1"
        • "ap-southeast-1"
        • "ap-southeast-2"
        • "ap-northeast-1"
        • "ap-northeast-2"
        • "sa-east-1"
      • Namerequired — (String)

        The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

    • InsufficientDataHealthStatus — (String)

      When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

      • Healthy: Amazon Route 53 considers the health check to be healthy.

      • Unhealthy: Amazon Route 53 considers the health check to be unhealthy.

      • LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

      Possible values include:
      • "Healthy"
      • "Unhealthy"
      • "LastKnownStatus"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HealthCheck — (map)

        A complex type that contains information about one health check that is associated with the current AWS account.

        • Idrequired — (String)

          The identifier that Amazon Route 53assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.

        • CallerReferencerequired — (String)

          A unique string that you specified when you created the health check.

        • HealthCheckConfigrequired — (map)

          A complex type that contains detailed information about one health check.

          • IPAddress — (String)

            The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address returned by DNS, Amazon Route 53 then checks the health of the endpoint.

            Use one of the following formats for the value of IPAddress:

            • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

            • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

            If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

            For more information, see HealthCheckConfig$FullyQualifiedDomainName.

            Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

            When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

          • Port — (Integer)

            The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress.

          • Typerequired — (String)

            The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

            You can't change the value of Type after you create a health check.

            You can create the following types of health checks:

            • HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

            • HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

              If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

            • HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

            • HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

            • TCP: Amazon Route 53 tries to establish a TCP connection.

            • CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.

            • CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

            For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

            Possible values include:
            • "HTTP"
            • "HTTPS"
            • "HTTP_STR_MATCH"
            • "HTTPS_STR_MATCH"
            • "TCP"
            • "CALCULATED"
            • "CLOUDWATCH_METRIC"
          • ResourcePath — (String)

            The path, if any, 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, for example, the file /docs/route53-health-check.html.

          • FullyQualifiedDomainName — (String)

            Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

            If you specify a value for IPAddress:

            Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks.

            When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

            • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

            • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

            • If you specify another value for Port and any value except TCP for Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

            If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases.

            If you don't specify a value for IPAddress :

            Amazon Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint.

            Note: If you don't specify a value for IPAddress, Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

            If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

            In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

            In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a Host header.

          • SearchString — (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. If the string appears in the response body, Amazon Route 53 considers the resource healthy.

            Amazon Route 53 considers case when searching for SearchString in the response body.

          • RequestInterval — (Integer)

            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. Each Amazon Route 53 health checker makes requests at this interval.

            You can't change the value of RequestInterval after you create a health check.

            If you don't specify a value for RequestInterval, the default value is 30 seconds.

          • FailureThreshold — (Integer)

            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. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

            If you don't specify a value for FailureThreshold, the default value is three health checks.

          • MeasureLatency — (Boolean)

            Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.

            You can't change the value of MeasureLatency after you create a health check.

          • Inverted — (Boolean)

            Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

          • HealthThreshold — (Integer)

            The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.

            Note the following:

            • If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.

            • If you specify 0, Amazon Route 53 always considers this health check to be healthy.

          • ChildHealthChecks — (Array<String>)

            (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

          • EnableSNI — (Boolean)

            Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

            Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

            The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

          • Regions — (Array<String>)

            A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.

            If you don't specify any regions, Amazon Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.

            If you update a health check to remove a region that has been performing health checks, Amazon Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).

          • AlarmIdentifier — (map)

            A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

            • Regionrequired — (String)

              A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

              For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference.

              Possible values include:
              • "us-east-1"
              • "us-east-2"
              • "us-west-1"
              • "us-west-2"
              • "ca-central-1"
              • "eu-central-1"
              • "eu-west-1"
              • "eu-west-2"
              • "ap-south-1"
              • "ap-southeast-1"
              • "ap-southeast-2"
              • "ap-northeast-1"
              • "ap-northeast-2"
              • "sa-east-1"
            • Namerequired — (String)

              The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

          • InsufficientDataHealthStatus — (String)

            When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

            • Healthy: Amazon Route 53 considers the health check to be healthy.

            • Unhealthy: Amazon Route 53 considers the health check to be unhealthy.

            • LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

            Possible values include:
            • "Healthy"
            • "Unhealthy"
            • "LastKnownStatus"
        • HealthCheckVersionrequired — (Integer)

          The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.

        • CloudWatchAlarmConfiguration — (map)

          A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.

          • EvaluationPeriodsrequired — (Integer)

            For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.

          • Thresholdrequired — (Float)

            For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.

          • ComparisonOperatorrequired — (String)

            For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.

            Possible values include:
            • "GreaterThanOrEqualToThreshold"
            • "GreaterThanThreshold"
            • "LessThanThreshold"
            • "LessThanOrEqualToThreshold"
          • Periodrequired — (Integer)

            For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.

          • MetricNamerequired — (String)

            The name of the CloudWatch metric that the alarm is associated with.

          • Namespacerequired — (String)

            The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

          • Statisticrequired — (String)

            For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.

            Possible values include:
            • "Average"
            • "Sum"
            • "SampleCount"
            • "Maximum"
            • "Minimum"
          • Dimensions — (Array<map>)

            For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

            • Namerequired — (String)

              For the metric that the CloudWatch alarm is associated with, the name of one dimension.

            • Valuerequired — (String)

              For the metric that the CloudWatch alarm is associated with, the value of one dimension.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateHostedZoneComment(params = {}, callback) ⇒ AWS.Request

Updates the comment for a specified hosted zone.

Service Reference:

Examples:

Calling the updateHostedZoneComment operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Comment: 'STRING_VALUE'
};
route53.updateHostedZoneComment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String)

      The ID for the hosted zone that you want to update the comment for.

    • Comment — (String)

      The new comment for the hosted zone. If you don't specify a value for Comment, Amazon Route 53 deletes the existing value of the Comment element, if any.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HostedZone — (map)

        A complex type that contains general information about the hosted zone.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to the hosted zone when you created it.

        • Namerequired — (String)

          The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.

          For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone.

        • CallerReferencerequired — (String)

          The value that you specified for CallerReference when you created the hosted zone.

        • Config — (map)

          A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response.

          • Comment — (String)

            Any comments that you want to include about the hosted zone.

          • PrivateZone — (Boolean)

            A value that indicates whether this is a private hosted zone.

        • ResourceRecordSetCount — (Integer)

          The number of resource record sets in the hosted zone.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateTrafficPolicyComment(params = {}, callback) ⇒ AWS.Request

Updates the comment for a specified traffic policy version.

Service Reference:

Examples:

Calling the updateTrafficPolicyComment operation

var params = {
  Comment: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  Version: 0 /* required */
};
route53.updateTrafficPolicyComment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String)

      The value of Id for the traffic policy that you want to update the comment for.

    • Version — (Integer)

      The value of Version for the traffic policy that you want to update the comment for.

    • Comment — (String)

      The new comment for the specified traffic policy and version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficPolicy — (map)

        A complex type that contains settings for the specified traffic policy.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to a traffic policy when you created it.

        • Versionrequired — (Integer)

          The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of Version is always 1.

        • Namerequired — (String)

          The name that you specified when you created the traffic policy.

        • Typerequired — (String)

          The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

          Possible values include:
          • "SOA"
          • "A"
          • "TXT"
          • "NS"
          • "CNAME"
          • "MX"
          • "NAPTR"
          • "PTR"
          • "SRV"
          • "SPF"
          • "AAAA"
        • Documentrequired — (String)

          The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see Traffic Policy Document Format.

        • Comment — (String)

          The comment that you specify in the CreateTrafficPolicy request, if any.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateTrafficPolicyInstance(params = {}, callback) ⇒ AWS.Request

Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.

When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Amazon Route 53 performs the following operations:

  1. Amazon Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets.

  2. When all of the new resource record sets have been created, Amazon Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.

  3. Amazon Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.

Service Reference:

Examples:

Calling the updateTrafficPolicyInstance operation

var params = {
  Id: 'STRING_VALUE', /* required */
  TTL: 0, /* required */
  TrafficPolicyId: 'STRING_VALUE', /* required */
  TrafficPolicyVersion: 0 /* required */
};
route53.updateTrafficPolicyInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String)

      The ID of the traffic policy instance that you want to update.

    • TTL — (Integer)

      The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets.

    • TrafficPolicyId — (String)

      The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

    • TrafficPolicyVersion — (Integer)

      The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TrafficPolicyInstance — (map)

        A complex type that contains settings for the updated traffic policy instance.

        • Idrequired — (String)

          The ID that Amazon Route 53 assigned to the new traffic policy instance.

        • HostedZoneIdrequired — (String)

          The ID of the hosted zone that Amazon Route 53 created resource record sets in.

        • Namerequired — (String)

          The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance.

        • TTLrequired — (Integer)

          The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.

        • Staterequired — (String)

          The value of State is one of the following values:

          Applied

          Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Amazon Route 53 edge locations.

          Creating

          Amazon Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request completed successfully.

          Failed

          Amazon Route 53 wasn't able to create or update the resource record sets. When the value of State is Failed, see Message for an explanation of what caused the request to fail.

        • Messagerequired — (String)

          If State is Failed, an explanation of the reason for the failure. If State is another value, Message is empty.

        • TrafficPolicyIdrequired — (String)

          The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

        • TrafficPolicyVersionrequired — (Integer)

          The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

        • TrafficPolicyTyperequired — (String)

          The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.

          Possible values include:
          • "SOA"
          • "A"
          • "TXT"
          • "NS"
          • "CNAME"
          • "MX"
          • "NAPTR"
          • "PTR"
          • "SRV"
          • "SPF"
          • "AAAA"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Route53 resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the resourceRecordSetsChanged state

var params = {
  Id: 'STRING_VALUE' /* required */
};
route53.waitFor('resourceRecordSetsChanged', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String)

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {})

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

route53.waitFor('resourceRecordSetsChanged', params = {}, [callback]) ⇒ AWS.Request

Waits for the resourceRecordSetsChanged state by periodically calling the underlying Route53.getChange() operation every 30 seconds (at most 60 times).

Examples:

Waiting for the resourceRecordSetsChanged state

var params = {
  Id: 'STRING_VALUE' /* required */
};
route53.waitFor('resourceRecordSetsChanged', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object)
    • Id — (String)

      The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ChangeInfo — (map)

        A complex type that contains information about the specified change batch.

        • Idrequired — (String)

          The ID of the request.

        • Statusrequired — (String)

          The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

          Possible values include:
          • "PENDING"
          • "INSYNC"
        • SubmittedAtrequired — (Date)

          The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

        • Comment — (String)

          A complex type that describes change information about changes made to your hosted zone.

          This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

See Also: