Class: AWS.Route53

/* 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>
    }
   }
   */
 });

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-west-3 | eu-central-1 | eu-central-2 | ap-east-1 | me-south-1 | us-gov-west-1 | us-gov-east-1 | us-iso-east-1 | us-iso-west-1 | us-isob-east-1 | me-central-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-south-1 | ap-south-2 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | eu-north-1 | sa-east-1 | ca-central-1 | cn-north-1 | af-south-1 | eu-south-1 | eu-south-2 | ap-southeast-4 | il-central-1 | ca-west-1 | ap-southeast-5
  },
  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 that an Amazon VPC was created in.

      Possible values include:
      • "us-east-1"
      • "us-east-2"
      • "us-west-1"
      • "us-west-2"
      • "eu-west-1"
      • "eu-west-2"
      • "eu-west-3"
      • "eu-central-1"
      • "eu-central-2"
      • "ap-east-1"
      • "me-south-1"
      • "us-gov-west-1"
      • "us-gov-east-1"
      • "us-iso-east-1"
      • "us-iso-west-1"
      • "us-isob-east-1"
      • "me-central-1"
      • "ap-southeast-1"
      • "ap-southeast-2"
      • "ap-southeast-3"
      • "ap-south-1"
      • "ap-south-2"
      • "ap-northeast-1"
      • "ap-northeast-2"
      • "ap-northeast-3"
      • "eu-north-1"
      • "sa-east-1"
      • "ca-central-1"
      • "cn-north-1"
      • "af-south-1"
      • "eu-south-1"
      • "eu-south-2"
      • "ap-southeast-4"
      • "il-central-1"
      • "ca-west-1"
      • "ap-southeast-5"
    • 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.

      • Id — required — (String)

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

      • Status — required — (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"
      • SubmittedAt — required — (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 comment you can provide.

Returns:

• (AWS.Request) —

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

var params = {
  Changes: [ /* required */
    {
      Action: PUT | DELETE_IF_EXISTS, /* required */
      CidrList: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      LocationName: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Id: 'STRING_VALUE', /* required */
  CollectionVersion: 'NUMBER_VALUE'
};
route53.changeCidrCollection(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 UUID of the CIDR collection to update.

  • CollectionVersion — (Integer)

    A sequential counter that Amazon Route 53 sets to 1 when you create a collection and increments it by 1 each time you update the collection.

    We recommend that you use ListCidrCollection to get the current value of CollectionVersion for the collection that you want to update, and then include that value with the change request. This prevents Route 53 from overwriting an intervening update:

    • If the value in the request matches the value of CollectionVersion in the collection, Route 53 updates the collection.

    • If the value of CollectionVersion in the collection is greater than the value in the request, the collection was changed after you got the version number. Route 53 does not update the collection, and it returns a CidrCollectionVersionMismatch error.

  • Changes — (Array<map>)

    Information about changes to a CIDR collection.

    • LocationName — required — (String)

      Name of the location that is associated with the CIDR collection.

    • Action — required — (String)

      CIDR collection change action.

      Possible values include:
      • "PUT"
      • "DELETE_IF_EXISTS"
    • CidrList — required — (Array<String>)

      List of CIDR blocks.

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:

    • Id — (String)

      The ID that is returned by ChangeCidrCollection. You can use it as input to GetChange to see if a CIDR collection change has propagated or not.

Returns:

• (AWS.Request) —

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

/* 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>
    }
   }
   */
 });

/* 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>
    }
   }
   */
 });

/* 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>
    }
   }
   */
 });

/* 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>
    }
   }
   */
 });

/* 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>
    }
   }
   */
 });

/* 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>
    }
   }
   */
 });

/* 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>
    }
   }
   */
 });

/* 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>
    }
   }
   */
 });

/* 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>
    }
   }
   */
 });

/* 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>
    }
   }
   */
 });

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 | CAA | DS, /* required */
          AliasTarget: {
            DNSName: 'STRING_VALUE', /* required */
            EvaluateTargetHealth: true || false, /* required */
            HostedZoneId: 'STRING_VALUE' /* required */
          },
          CidrRoutingConfig: {
            CollectionId: 'STRING_VALUE', /* required */
            LocationName: 'STRING_VALUE' /* required */
          },
          Failover: PRIMARY | SECONDARY,
          GeoLocation: {
            ContinentCode: 'STRING_VALUE',
            CountryCode: 'STRING_VALUE',
            SubdivisionCode: 'STRING_VALUE'
          },
          GeoProximityLocation: {
            AWSRegion: 'STRING_VALUE',
            Bias: 'NUMBER_VALUE',
            Coordinates: {
              Latitude: 'STRING_VALUE', /* required */
              Longitude: 'STRING_VALUE' /* required */
            },
            LocalZoneGroup: 'STRING_VALUE'
          },
          HealthCheckId: 'STRING_VALUE',
          MultiValueAnswer: true || false,
          Region: us-east-1 | us-east-2 | us-west-1 | us-west-2 | ca-central-1 | eu-west-1 | eu-west-2 | eu-west-3 | eu-central-1 | eu-central-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | eu-north-1 | sa-east-1 | cn-north-1 | cn-northwest-1 | ap-east-1 | me-south-1 | me-central-1 | ap-south-1 | ap-south-2 | af-south-1 | eu-south-1 | eu-south-2 | ap-southeast-4 | il-central-1 | ca-west-1 | ap-southeast-5,
          ResourceRecords: [
            {
              Value: 'STRING_VALUE' /* required */
            },
            /* more items */
          ],
          SetIdentifier: 'STRING_VALUE',
          TTL: 'NUMBER_VALUE',
          TrafficPolicyInstanceId: 'STRING_VALUE',
          Weight: 'NUMBER_VALUE'
        }
      },
      /* 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.

    • Changes — required — (Array<map>)

      Information about the changes to make to the record sets.

      • Action — required — (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, 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, Route 53 creates it. If a resource record set does exist, Route 53 updates it with the values in the request.

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

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

        • Name — required — (String)

          For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone.

          ChangeResourceRecordSets Only

          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 assumes that the domain name that you specify is fully qualified. This means that 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.

        • Type — required — (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 | CAA | CNAME | DS |MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

          Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | 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.

          Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT

          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:

          • Amazon API Gateway custom regional APIs and edge-optimized APIs: A

          • 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.

          • Amazon API Gateway environment that has a regionalized subdomain: A

          • ELB load balancers: A | AAAA

          • Amazon S3 buckets: A

          • Amazon Virtual Private Cloud interface VPC endpoints A

          • Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except NS and SOA.

            Note: If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
          Possible values include:
          • "SOA"
          • "A"
          • "TXT"
          • "NS"
          • "CNAME"
          • "MX"
          • "NAPTR"
          • "PTR"
          • "SRV"
          • "SPF"
          • "AAAA"
          • "CAA"
          • "DS"
        • SetIdentifier — (String)

          Resource record sets that have a routing policy other than simple: An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set.

          For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.

        • 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. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. 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, 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 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 Amazon Web Services 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.

          When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. 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. 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-west-3"
          • "eu-central-1"
          • "eu-central-2"
          • "ap-southeast-1"
          • "ap-southeast-2"
          • "ap-southeast-3"
          • "ap-northeast-1"
          • "ap-northeast-2"
          • "ap-northeast-3"
          • "eu-north-1"
          • "sa-east-1"
          • "cn-north-1"
          • "cn-northwest-1"
          • "ap-east-1"
          • "me-south-1"
          • "me-central-1"
          • "ap-south-1"
          • "ap-south-2"
          • "af-south-1"
          • "eu-south-1"
          • "eu-south-2"
          • "ap-southeast-4"
          • "il-central-1"
          • "ca-west-1"
          • "ap-southeast-5"
        • GeoLocation — (map)

          Geolocation 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.

          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, 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 *. Two groups of queries are routed to the resource that you specify in this record: 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, 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.

            Amazon Route 53 supports the following continent codes:

            • AF: Africa

            • AN: Antarctica

            • AS: Asia

            • EU: Europe

            • OC: Oceania

            • NA: North America

            • SA: South America

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

          • CountryCode — (String)

            For geolocation resource record sets, the two-letter code for a country.

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

            Route 53 also supports the country code UA for Ukraine.

          • SubdivisionCode — (String)

            For geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn't support any other values for SubdivisionCode. For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website.

            If you specify subdivisioncode, you must also specify US for CountryCode.

        • 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, 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, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

          • When the secondary resource record set is unhealthy, 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, 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 Route 53, see the following topics in the Amazon Route 53 Developer Guide:

          • Route 53 Health Checks and DNS Failover

          • Configuring Failover in a Private Hosted Zone

          Possible values include:
          • "PRIMARY"
          • "SECONDARY"
        • MultiValueAnswer — (Boolean)

          Multivalue answer resource record sets only: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. Note the following:

          • If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.

          • If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.

          • Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.

          • If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.

          • When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.

          • If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.

          You can't create multivalue answer alias records.

        • TTL — (Integer)

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

          • If you're creating or updating 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.
          • Value — required — (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 Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.

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

          • You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.

          • 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.

          • HostedZoneId — required — (String)

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

            Amazon API Gateway custom regional APIs and edge-optimized APIs

            Specify the hosted zone ID for your API. You can get the applicable value using the CLI command get-domain-names:

            • For regional APIs, specify the value of regionalHostedZoneId.

            • For edge-optimized APIs, specify the value of distributionHostedZoneId.

            Amazon Virtual Private Cloud interface VPC endpoint

            Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the CLI command describe-vpc-endpoints.

            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 that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas in 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 endpoints and quotas topic in the Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.

            • Amazon Web Services Management Console: Go to the Amazon EC2 page, choose 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 applicable value. For more information, see the applicable guide:

              • Classic Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameId.

              • Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneId.

            • CLI: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:

              • Classic Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneNameId.

              • Application and Network Load Balancers: Use describe-load-balancers to get the value of CanonicalHostedZoneId.

            Global Accelerator accelerator

            Specify Z2BJ6XQ5FK7U4H.

            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 table Amazon S3 Website Endpoints in the Amazon Web Services General Reference.

            Another 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.)

          • DNSName — required — (String)

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

            Amazon API Gateway custom regional APIs and edge-optimized APIs

            Specify the applicable domain name for your API. You can get the applicable value using the CLI command get-domain-names:

            • For regional APIs, specify the value of regionalDomainName.

            • For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.

            Note: The name of the record that you're creating must match a custom domain name for your API, such as api.example.com.

            Amazon Virtual Private Cloud interface VPC endpoint

            Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the CLI command describe-vpc-endpoints.

            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.

            You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.

            Note: For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.

            Elastic Beanstalk environment

            If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.

            For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.

            For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute:

            • Amazon Web Services Management Console: For information about how to get the value by using the console, see Using Custom Domains with Elastic Beanstalk in the 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 Elastic Beanstalk API Reference.

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

            ELB load balancer

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

            • Amazon Web Services 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. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.

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

              • Classic Load Balancers: DescribeLoadBalancers

              • Application and Network Load Balancers: DescribeLoadBalancers

            • CLI: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide:

              • Classic Load Balancers: describe-load-balancers

              • Application and Network Load Balancers: describe-load-balancers

            Global Accelerator accelerator

            Specify the DNS name for your accelerator:

            • Global Accelerator API: To get the DNS name, use DescribeAccelerator.

            • CLI: To get the DNS name, use describe-accelerator.

            Amazon S3 bucket that is configured as a static website

            Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon 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 Route 53 resource record set

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

            Note: If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.

          • EvaluateTargetHealth — required — (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 Amazon Web Services resource, such as an ELB load balancer or another resource record set in the hosted zone.

            Note the following:

            CloudFront distributions

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

            Elastic Beanstalk environments that have regionalized subdomains

            If you specify an Elastic Beanstalk environment in DNSName and 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 Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.

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

            ELB load balancers

            Health checking behavior depends on the type of load balancer:

            • Classic Load Balancers: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.

            • Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:

              • For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.

              • A target group that has no registered targets is considered unhealthy.

            Note: When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.

            S3 buckets

            There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket.

            Other records in the same hosted zone

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

            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 the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.

          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)

          Route 53 doesn't check the health of the endpoint that is 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, Route 53 checks the health of the endpoint that you specified in the health check.

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

          • How Amazon Route 53 Determines Whether an Endpoint Is Healthy

          • Route 53 Health Checks and DNS Failover

          • Configuring Failover in a Private Hosted Zone

          When to Specify HealthCheckId

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

          • Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets.

            If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.

            If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.

            If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.

          • Alias resource record sets: You specify the following settings:

            • You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).

            • You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.

            • You specify a health check ID for the non-alias resource record set.

            If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.

            If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.

            Note: The alias resource record set can also route traffic to a group of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.

          Geolocation Routing

          For geolocation resource record sets, if an endpoint is unhealthy, 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 entire United States, for North America, and a resource record set that has * for CountryCode is *, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:

          • The United States

          • North America

          • The default resource record set

          Specifying the Health Check Endpoint by Domain Name

          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 (www.example.com).

          Health check results will be unpredictable if you do the following:

          • Create a health check that has the same value for FullyQualifiedDomainName as the name of a resource record set.

          • Associate that health check with the resource record set.

        • 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 Route 53 created this resource record set for.

          To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, 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.

        • CidrRoutingConfig — (map)

          The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.

          A LocationName with an asterisk “*” can be used to create a default CIDR record. CollectionId is still required for default record.

          • CollectionId — required — (String)

            The CIDR collection ID.

          • LocationName — required — (String)

            The CIDR collection location name.

        • GeoProximityLocation — (map)

          GeoproximityLocation resource record sets only: A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources.

          • AWSRegion — (String)

            The Amazon Web Services Region the resource you are directing DNS traffic to, is in.

          • LocalZoneGroup — (String)

            Specifies an Amazon Web Services Local Zone Group.

            A local Zone Group is usually the Local Zone code without the ending character. For example, if the Local Zone is us-east-1-bue-1a the Local Zone Group is us-east-1-bue-1.

            You can identify the Local Zones Group for a specific Local Zone by using the describe-availability-zones CLI command:

            This command returns: "GroupName": "us-west-2-den-1", specifying that the Local Zone us-west-2-den-1a belongs to the Local Zone Group us-west-2-den-1.

          • Coordinates — (map)

            Contains the longitude and latitude for a geographic region.

            • Latitude — required — (String)

              Specifies a coordinate of the north–south position of a geographic point on the surface of the Earth (-90 - 90).

            • Longitude — required — (String)

              Specifies a coordinate of the east–west position of a geographic point on the surface of the Earth (-180 - 180).

          • Bias — (Integer)

            The bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource.

            To use Bias to change the size of the geographic region, specify the applicable value for the bias:

            • To expand the size of the geographic region from which Route 53 routes traffic to a resource, specify a positive integer from 1 to 99 for the bias. Route 53 shrinks the size of adjacent regions.

            • To shrink the size of the geographic region from which Route 53 routes traffic to a resource, specify a negative bias of -1 to -99. Route 53 expands the size of adjacent regions.

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.

      • Id — required — (String)

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

      • Status — required — (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"
      • SubmittedAt — required — (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 comment you can provide.

Returns:

• (AWS.Request) —

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

/* 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 = {
   }
   */
 });

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.

var params = {
  CallerReference: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
route53.createCidrCollection(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)

    A unique identifier for the account that can be used to reference the collection from other API calls.

  • CallerReference — (String)

    A client-specific token that allows requests to be securely retried so that the intended outcome will only occur once, retries receive a similar response, and there are no additional edge cases to handle.

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:

    • Collection — (map)

      A complex type that contains information about the CIDR collection.

      • Arn — (String)

        The ARN of the collection. Can be used to reference the collection in IAM policy or in another Amazon Web Services account.

      • Id — (String)

        The unique ID of the CIDR collection.

      • Name — (String)

        The name of a CIDR collection.

      • Version — (Integer)

        A sequential counter that Route 53 sets to 1 when you create a CIDR collection and increments by 1 each time you update settings for the CIDR collection.

    • Location — (String)

      A unique URL that represents the location for the CIDR collection.

Returns:

• (AWS.Request) —

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

var params = {
  CallerReference: 'STRING_VALUE', /* required */
  HealthCheckConfig: { /* required */
    Type: HTTP | HTTPS | HTTP_STR_MATCH | HTTPS_STR_MATCH | TCP | CALCULATED | CLOUDWATCH_METRIC | RECOVERY_CONTROL, /* 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-central-2 | eu-west-1 | eu-west-2 | eu-west-3 | ap-east-1 | me-south-1 | me-central-1 | ap-south-1 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | eu-north-1 | sa-east-1 | cn-northwest-1 | cn-north-1 | af-south-1 | eu-south-1 | eu-south-2 | us-gov-west-1 | us-gov-east-1 | us-iso-east-1 | us-iso-west-1 | us-isob-east-1 | ap-southeast-4 | il-central-1 | ca-west-1 | ap-southeast-5 /* required */
    },
    ChildHealthChecks: [
      'STRING_VALUE',
      /* more items */
    ],
    Disabled: true || false,
    EnableSNI: true || false,
    FailureThreshold: 'NUMBER_VALUE',
    FullyQualifiedDomainName: 'STRING_VALUE',
    HealthThreshold: 'NUMBER_VALUE',
    IPAddress: 'STRING_VALUE',
    InsufficientDataHealthStatus: Healthy | Unhealthy | LastKnownStatus,
    Inverted: true || false,
    MeasureLatency: true || false,
    Port: 'NUMBER_VALUE',
    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: 'NUMBER_VALUE',
    ResourcePath: 'STRING_VALUE',
    RoutingControlArn: '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, 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, 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, Route 53 returns a HealthCheckAlreadyExists error.

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

    Route 53 does not store the CallerReference for a deleted health check indefinitely. The CallerReference for a deleted health check will be deleted after a number of days.

  • HealthCheckConfig — (map)

    A complex type that contains settings for a new 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, 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, 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 FullyQualifiedDomainName.

      Constraints: 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:

      • RFC 5735, Special Use IPv4 Addresses

      • RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space

      • RFC 5156, Special-Use IPv6 Addresses

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

    • Port — (Integer)

      The port on the endpoint that you want Amazon Route 53 to perform health checks on.

      Note: Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.
    • Type — required — (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: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

      • HTTPS: Route 53 tries to establish a TCP connection. If successful, 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: Route 53 tries to establish a TCP connection. If successful, 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: Route 53 tries to establish a TCP connection. If successful, 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: 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, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

      • RECOVERY_CONTROL: The health check is associated with a Route53 Application Recovery Controller routing control. If the routing control state is ON, the health check is considered healthy. If the state is OFF, the health check is considered unhealthy.

      For more information, see How 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"
      • "RECOVERY_CONTROL"
    • 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. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

    • 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 Route 53 to perform health checks.

      When 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, 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, 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, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

      If you don't specify a value for FullyQualifiedDomainName, 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:

      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, Route 53 then checks the health of the endpoint.

      Note: If you don't specify a value for IPAddress, 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, 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, Route 53 doesn't pass a Host header.

    • SearchString — (String)

      If the value of Type is HTTP_STR_MATCH or HTTPS_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, Route 53 considers the resource healthy.

      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 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 Amazon Web Services regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the 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.

    • Disabled — (Boolean)

      Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

      • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

      • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

      • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

      After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

      Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

    • HealthThreshold — (Integer)

      The number of child health checks that are associated with a CALCULATED health check 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 element.

      Note the following:

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

      • If you specify 0, 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, 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, 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 the specified health check is healthy.

      • Region — required — (String)

        For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.

        For the current list of CloudWatch regions, see Amazon CloudWatch endpoints and quotas in 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-central-2"
        • "eu-west-1"
        • "eu-west-2"
        • "eu-west-3"
        • "ap-east-1"
        • "me-south-1"
        • "me-central-1"
        • "ap-south-1"
        • "ap-south-2"
        • "ap-southeast-1"
        • "ap-southeast-2"
        • "ap-southeast-3"
        • "ap-northeast-1"
        • "ap-northeast-2"
        • "ap-northeast-3"
        • "eu-north-1"
        • "sa-east-1"
        • "cn-northwest-1"
        • "cn-north-1"
        • "af-south-1"
        • "eu-south-1"
        • "eu-south-2"
        • "us-gov-west-1"
        • "us-gov-east-1"
        • "us-iso-east-1"
        • "us-iso-west-1"
        • "us-isob-east-1"
        • "ap-southeast-4"
        • "il-central-1"
        • "ca-west-1"
        • "ap-southeast-5"
      • Name — required — (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.

        Note: Route 53 supports CloudWatch alarms with the following features:

        • Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide.
        • Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.
    • 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: Route 53 considers the health check to be healthy.

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

      • LastKnownStatus: 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"
    • RoutingControlArn — (String)

      The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.

      For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..

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.

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

      • CallerReference — required — (String)

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

      • LinkedService — (map)

        If the health check was created by another service, the service that created the health check. When a health check is created by another service, you can't edit or delete it using Amazon Route 53.

        • ServicePrincipal — (String)

          If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.

        • Description — (String)

          If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.

      • HealthCheckConfig — required — (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, 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, 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 FullyQualifiedDomainName.

          Constraints: 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:

          • RFC 5735, Special Use IPv4 Addresses

          • RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space

          • RFC 5156, Special-Use IPv6 Addresses

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

        • Port — (Integer)

          The port on the endpoint that you want Amazon Route 53 to perform health checks on.

          Note: Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.
        • Type — required — (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: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

          • HTTPS: Route 53 tries to establish a TCP connection. If successful, 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: Route 53 tries to establish a TCP connection. If successful, 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: Route 53 tries to establish a TCP connection. If successful, 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: 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, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

          • RECOVERY_CONTROL: The health check is associated with a Route53 Application Recovery Controller routing control. If the routing control state is ON, the health check is considered healthy. If the state is OFF, the health check is considered unhealthy.

          For more information, see How 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"
          • "RECOVERY_CONTROL"
        • 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. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

        • 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 Route 53 to perform health checks.

          When 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, 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, 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, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

          If you don't specify a value for FullyQualifiedDomainName, 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:

          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, Route 53 then checks the health of the endpoint.

          Note: If you don't specify a value for IPAddress, 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, 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, Route 53 doesn't pass a Host header.

        • SearchString — (String)

          If the value of Type is HTTP_STR_MATCH or HTTPS_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, Route 53 considers the resource healthy.

          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 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 Amazon Web Services regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the 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.

        • Disabled — (Boolean)

          Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

          • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

          • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

          • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

          After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

          Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

        • HealthThreshold — (Integer)

          The number of child health checks that are associated with a CALCULATED health check 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 element.

          Note the following:

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

          • If you specify 0, 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, 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, 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 the specified health check is healthy.

          • Region — required — (String)

            For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.

            For the current list of CloudWatch regions, see Amazon CloudWatch endpoints and quotas in 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-central-2"
            • "eu-west-1"
            • "eu-west-2"
            • "eu-west-3"
            • "ap-east-1"
            • "me-south-1"
            • "me-central-1"
            • "ap-south-1"
            • "ap-south-2"
            • "ap-southeast-1"
            • "ap-southeast-2"
            • "ap-southeast-3"
            • "ap-northeast-1"
            • "ap-northeast-2"
            • "ap-northeast-3"
            • "eu-north-1"
            • "sa-east-1"
            • "cn-northwest-1"
            • "cn-north-1"
            • "af-south-1"
            • "eu-south-1"
            • "eu-south-2"
            • "us-gov-west-1"
            • "us-gov-east-1"
            • "us-iso-east-1"
            • "us-iso-west-1"
            • "us-isob-east-1"
            • "ap-southeast-4"
            • "il-central-1"
            • "ca-west-1"
            • "ap-southeast-5"
          • Name — required — (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.

            Note: Route 53 supports CloudWatch alarms with the following features:

            • Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide.
            • Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.
        • 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: Route 53 considers the health check to be healthy.

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

          • LastKnownStatus: 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"
        • RoutingControlArn — (String)

          The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.

          For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..

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

        • EvaluationPeriods — required — (Integer)

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

        • Threshold — required — (Float)

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

        • ComparisonOperator — required — (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"
        • Period — required — (Integer)

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

        • MetricName — required — (String)

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

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

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

          • Name — required — (String)

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

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

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-west-3 | eu-central-1 | eu-central-2 | ap-east-1 | me-south-1 | us-gov-west-1 | us-gov-east-1 | us-iso-east-1 | us-iso-west-1 | us-isob-east-1 | me-central-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-south-1 | ap-south-2 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | eu-north-1 | sa-east-1 | ca-central-1 | cn-north-1 | af-south-1 | eu-south-1 | eu-south-2 | ap-southeast-4 | il-central-1 | ca-west-1 | ap-southeast-5
  }
};
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. 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 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 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. If you are associating a VPC with a hosted zone with this request, the paramaters VPCId and VPCRegion are also required.

    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 that an Amazon VPC was created in.

      Possible values include:
      • "us-east-1"
      • "us-east-2"
      • "us-west-1"
      • "us-west-2"
      • "eu-west-1"
      • "eu-west-2"
      • "eu-west-3"
      • "eu-central-1"
      • "eu-central-2"
      • "ap-east-1"
      • "me-south-1"
      • "us-gov-west-1"
      • "us-gov-east-1"
      • "us-iso-east-1"
      • "us-iso-west-1"
      • "us-isob-east-1"
      • "me-central-1"
      • "ap-southeast-1"
      • "ap-southeast-2"
      • "ap-southeast-3"
      • "ap-south-1"
      • "ap-south-2"
      • "ap-northeast-1"
      • "ap-northeast-2"
      • "ap-northeast-3"
      • "eu-north-1"
      • "sa-east-1"
      • "ca-central-1"
      • "cn-north-1"
      • "af-south-1"
      • "eu-south-1"
      • "eu-south-2"
      • "ap-southeast-4"
      • "il-central-1"
      • "ca-west-1"
      • "ap-southeast-5"
    • 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.

    If you are using a reusable delegation set to create a public hosted zone for a subdomain, make sure that the parent hosted zone doesn't use one or more of the same name servers. If you have overlapping nameservers, the operation will cause a ConflictingDomainsExist error.

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.

      • Id — required — (String)

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

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

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

      • LinkedService — (map)

        If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created by another service, you can't edit or delete it using Route 53.

        • ServicePrincipal — (String)

          If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.

        • Description — (String)

          If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.

    • ChangeInfo — (map)

      A complex type that contains information about the CreateHostedZone request.

      • Id — required — (String)

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

      • Status — required — (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"
      • SubmittedAt — required — (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 comment you can provide.

    • 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.

      • NameServers — required — (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 that an Amazon VPC was created in.

        Possible values include:
        • "us-east-1"
        • "us-east-2"
        • "us-west-1"
        • "us-west-2"
        • "eu-west-1"
        • "eu-west-2"
        • "eu-west-3"
        • "eu-central-1"
        • "eu-central-2"
        • "ap-east-1"
        • "me-south-1"
        • "us-gov-west-1"
        • "us-gov-east-1"
        • "us-iso-east-1"
        • "us-iso-west-1"
        • "us-isob-east-1"
        • "me-central-1"
        • "ap-southeast-1"
        • "ap-southeast-2"
        • "ap-southeast-3"
        • "ap-south-1"
        • "ap-south-2"
        • "ap-northeast-1"
        • "ap-northeast-2"
        • "ap-northeast-3"
        • "eu-north-1"
        • "sa-east-1"
        • "ca-central-1"
        • "cn-north-1"
        • "af-south-1"
        • "eu-south-1"
        • "eu-south-2"
        • "ap-southeast-4"
        • "il-central-1"
        • "ca-west-1"
        • "ap-southeast-5"
      • 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.

var params = {
  CallerReference: 'STRING_VALUE', /* required */
  HostedZoneId: 'STRING_VALUE', /* required */
  KeyManagementServiceArn: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Status: 'STRING_VALUE' /* required */
};
route53.createKeySigningKey(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.

  • HostedZoneId — (String)

    The unique string (ID) used to identify a hosted zone.

  • KeyManagementServiceArn — (String)

    The Amazon resource name (ARN) for a customer managed key in Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key-signing key (KSK) in a single hosted zone. To see an example of KeyManagementServiceArn that grants the correct permissions for DNSSEC, scroll down to Example.

    You must configure the customer managed customer managed key as follows:

    Status

    Enabled

    Key spec

    ECC_NIST_P256

    Key usage

    Sign and verify

    Key policy

    The key policy must give permission for the following actions:

    • DescribeKey

    • GetPublicKey

    • Sign

    The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:

    • "Service": "dnssec-route53.amazonaws.com"

    For more information about working with a customer managed key in KMS, see Key Management Service concepts.

  • Name — (String)

    A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same hosted zone.

  • Status — (String)

    A string specifying the initial status of the key-signing key (KSK). You can set the value to ACTIVE or INACTIVE.

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 change information about changes made to your hosted zone.

      • Id — required — (String)

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

      • Status — required — (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"
      • SubmittedAt — required — (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 comment you can provide.

    • KeySigningKey — (map)

      The key-signing key (KSK) that the request creates.

      • Name — (String)

        A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same hosted zone.

      • KmsArn — (String)

        The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The KmsArn must be unique for each key-signing key (KSK) in a single hosted zone.

        You must configure the customer managed key as follows:

        Status

        Enabled

        Key spec

        ECC_NIST_P256

        Key usage

        Sign and verify

        Key policy

        The key policy must give permission for the following actions:

        • DescribeKey

        • GetPublicKey

        • Sign

        The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:

        • "Service": "dnssec-route53.amazonaws.com"

        For more information about working with the customer managed key in KMS, see Key Management Service concepts.

      • Flag — (Integer)

        An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.

      • SigningAlgorithmMnemonic — (String)

        A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.

      • SigningAlgorithmType — (Integer)

        An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.

      • DigestAlgorithmMnemonic — (String)

        A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.

      • DigestAlgorithmType — (Integer)

        An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.

      • KeyTag — (Integer)

        An integer used to identify the DNSSEC record for the domain name. The process used to calculate the value is described in RFC-4034 Appendix B.

      • DigestValue — (String)

        A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to publish the public key that resolvers can use to verify DNSSEC signatures that are used to secure certain kinds of information provided by the DNS system.

      • PublicKey — (String)

        The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.

      • DSRecord — (String)

        A string that represents a delegation signer (DS) record.

      • DNSKEYRecord — (String)

        A string that represents a DNSKEY record.

      • Status — (String)

        A string that represents the current key-signing key (KSK) status.

        Status can have one of the following values:

        ACTIVE

        The KSK is being used for signing.

        INACTIVE

        The KSK is not being used for signing.

        DELETING

        The KSK is in the process of being deleted.

        ACTION_NEEDED

        There is a problem with the KSK that requires you to take action to resolve. For example, the customer managed key might have been deleted, or the permissions for the customer managed key might have been changed.

        INTERNAL_FAILURE

        There was an error during a request. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem. For example, you may need to activate or deactivate the KSK.

      • StatusMessage — (String)

        The status message provided for the following key-signing key (KSK) statuses: ACTION_NEEDED or INTERNAL_FAILURE. The status message includes information about what the problem might be and steps that you can take to correct the issue.

      • CreatedDate — (Date)

        The date when the key-signing key (KSK) was created.

      • LastModifiedDate — (Date)

        The last time that the key-signing key (KSK) was changed.

    • Location — (String)

      The unique URL representing the new key-signing key (KSK).

Returns:

• (AWS.Request) —

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

var params = {
  CloudWatchLogsLogGroupArn: 'STRING_VALUE', /* required */
  HostedZoneId: 'STRING_VALUE' /* required */
};
route53.createQueryLoggingConfig(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 log queries for. You can log queries only for public hosted zones.

  • CloudWatchLogsLogGroupArn — (String)

    The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN:

    arn:aws:logs:region:account-id:log-group:log_group_name

    To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command, or the applicable command in one of the Amazon Web Services SDKs.

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:

    • QueryLoggingConfig — (map)

      A complex type that contains the ID for a query logging configuration, the ID of the hosted zone that you want to log queries for, and the ARN for the log group that you want Amazon Route 53 to send query logs to.

      • Id — required — (String)

        The ID for a configuration for DNS query logging.

      • HostedZoneId — required — (String)

        The ID of the hosted zone that CloudWatch Logs is logging queries for.

      • CloudWatchLogsLogGroupArn — required — (String)

        The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.

    • Location — (String)

      The unique URL representing the new query logging configuration.

Returns:

• (AWS.Request) —

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

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.

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

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.

      • Id — required — (String)

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

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

      • Name — required — (String)

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

      • Type — required — (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"
        • "CAA"
        • "DS"
      • Document — required — (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.

var params = {
  HostedZoneId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  TTL: 'NUMBER_VALUE', /* required */
  TrafficPolicyId: 'STRING_VALUE', /* required */
  TrafficPolicyVersion: 'NUMBER_VALUE' /* 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 that you want Amazon Route 53 to create resource record sets in 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 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.

      • Id — required — (String)

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

      • HostedZoneId — required — (String)

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

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

      • TTL — required — (Integer)

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

      • State — required — (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 Route 53 edge locations.

        Creating

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

        Failed

        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.

      • Message — required — (String)

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

      • TrafficPolicyId — required — (String)

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

      • TrafficPolicyVersion — required — (Integer)

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

      • TrafficPolicyType — required — (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"
        • "CAA"
        • "DS"
    • 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.

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.

      • Id — required — (String)

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

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

      • Name — required — (String)

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

      • Type — required — (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"
        • "CAA"
        • "DS"
      • Document — required — (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.

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-west-3 | eu-central-1 | eu-central-2 | ap-east-1 | me-south-1 | us-gov-west-1 | us-gov-east-1 | us-iso-east-1 | us-iso-west-1 | us-isob-east-1 | me-central-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-south-1 | ap-south-2 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | eu-north-1 | sa-east-1 | ca-central-1 | cn-north-1 | af-south-1 | eu-south-1 | eu-south-2 | ap-southeast-4 | il-central-1 | ca-west-1 | ap-southeast-5
  }
};
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 that an Amazon VPC was created in.

      Possible values include:
      • "us-east-1"
      • "us-east-2"
      • "us-west-1"
      • "us-west-2"
      • "eu-west-1"
      • "eu-west-2"
      • "eu-west-3"
      • "eu-central-1"
      • "eu-central-2"
      • "ap-east-1"
      • "me-south-1"
      • "us-gov-west-1"
      • "us-gov-east-1"
      • "us-iso-east-1"
      • "us-iso-west-1"
      • "us-isob-east-1"
      • "me-central-1"
      • "ap-southeast-1"
      • "ap-southeast-2"
      • "ap-southeast-3"
      • "ap-south-1"
      • "ap-south-2"
      • "ap-northeast-1"
      • "ap-northeast-2"
      • "ap-northeast-3"
      • "eu-north-1"
      • "sa-east-1"
      • "ca-central-1"
      • "cn-north-1"
      • "af-south-1"
      • "eu-south-1"
      • "eu-south-2"
      • "ap-southeast-4"
      • "il-central-1"
      • "ca-west-1"
      • "ap-southeast-5"
    • 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 that an Amazon VPC was created in.

        Possible values include:
        • "us-east-1"
        • "us-east-2"
        • "us-west-1"
        • "us-west-2"
        • "eu-west-1"
        • "eu-west-2"
        • "eu-west-3"
        • "eu-central-1"
        • "eu-central-2"
        • "ap-east-1"
        • "me-south-1"
        • "us-gov-west-1"
        • "us-gov-east-1"
        • "us-iso-east-1"
        • "us-iso-west-1"
        • "us-isob-east-1"
        • "me-central-1"
        • "ap-southeast-1"
        • "ap-southeast-2"
        • "ap-southeast-3"
        • "ap-south-1"
        • "ap-south-2"
        • "ap-northeast-1"
        • "ap-northeast-2"
        • "ap-northeast-3"
        • "eu-north-1"
        • "sa-east-1"
        • "ca-central-1"
        • "cn-north-1"
        • "af-south-1"
        • "eu-south-1"
        • "eu-south-2"
        • "ap-southeast-4"
        • "il-central-1"
        • "ca-west-1"
        • "ap-southeast-5"
      • 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.

var params = {
  HostedZoneId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
route53.deactivateKeySigningKey(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)

    A unique string used to identify a hosted zone.

  • Name — (String)

    A string used to identify a key-signing key (KSK).

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 change information about changes made to your hosted zone.

      • Id — required — (String)

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

      • Status — required — (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"
      • SubmittedAt — required — (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 comment you can provide.

Returns:

• (AWS.Request) —

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

var params = {
  Id: 'STRING_VALUE' /* required */
};
route53.deleteCidrCollection(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 UUID of the collection 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.

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.

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.

      • Id — required — (String)

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

      • Status — required — (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"
      • SubmittedAt — required — (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 comment you can provide.

Returns:

• (AWS.Request) —

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

var params = {
  HostedZoneId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
route53.deleteKeySigningKey(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)

    A unique string used to identify a hosted zone.

  • Name — (String)

    A string used to identify a key-signing key (KSK).

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 change information about changes made to your hosted zone.

      • Id — required — (String)

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

      • Status — required — (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"
      • SubmittedAt — required — (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 comment you can provide.

Returns:

• (AWS.Request) —

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

var params = {
  Id: 'STRING_VALUE' /* required */
};
route53.deleteQueryLoggingConfig(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 configuration 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.

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.

var params = {
  Id: 'STRING_VALUE', /* required */
  Version: 'NUMBER_VALUE' /* 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.

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.

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-west-3 | eu-central-1 | eu-central-2 | ap-east-1 | me-south-1 | us-gov-west-1 | us-gov-east-1 | us-iso-east-1 | us-iso-west-1 | us-isob-east-1 | me-central-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-south-1 | ap-south-2 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | eu-north-1 | sa-east-1 | ca-central-1 | cn-north-1 | af-south-1 | eu-south-1 | eu-south-2 | ap-southeast-4 | il-central-1 | ca-west-1 | ap-southeast-5
  }
};
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 Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, the ID of the hosted zone.

  • VPC — (map)

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

    • VPCRegion — (String)

      (Private hosted zones only) The region that an Amazon VPC was created in.

      Possible values include:
      • "us-east-1"
      • "us-east-2"
      • "us-west-1"
      • "us-west-2"
      • "eu-west-1"
      • "eu-west-2"
      • "eu-west-3"
      • "eu-central-1"
      • "eu-central-2"
      • "ap-east-1"
      • "me-south-1"
      • "us-gov-west-1"
      • "us-gov-east-1"
      • "us-iso-east-1"
      • "us-iso-west-1"
      • "us-isob-east-1"
      • "me-central-1"
      • "ap-southeast-1"
      • "ap-southeast-2"
      • "ap-southeast-3"
      • "ap-south-1"
      • "ap-south-2"
      • "ap-northeast-1"
      • "ap-northeast-2"
      • "ap-northeast-3"
      • "eu-north-1"
      • "sa-east-1"
      • "ca-central-1"
      • "cn-north-1"
      • "af-south-1"
      • "eu-south-1"
      • "eu-south-2"
      • "ap-southeast-4"
      • "il-central-1"
      • "ca-west-1"
      • "ap-southeast-5"
    • 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.

var params = {
  HostedZoneId: 'STRING_VALUE' /* required */
};
route53.disableHostedZoneDNSSEC(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)

    A unique string used to identify a 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:

    • ChangeInfo — (map)

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

      • Id — required — (String)

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

      • Status — required — (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"
      • SubmittedAt — required — (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 comment you can provide.

Returns:

• (AWS.Request) —

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

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-west-3 | eu-central-1 | eu-central-2 | ap-east-1 | me-south-1 | us-gov-west-1 | us-gov-east-1 | us-iso-east-1 | us-iso-west-1 | us-isob-east-1 | me-central-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-south-1 | ap-south-2 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | eu-north-1 | sa-east-1 | ca-central-1 | cn-north-1 | af-south-1 | eu-south-1 | eu-south-2 | ap-southeast-4 | il-central-1 | ca-west-1 | ap-southeast-5
  },
  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 that an Amazon VPC was created in.

      Possible values include:
      • "us-east-1"
      • "us-east-2"
      • "us-west-1"
      • "us-west-2"
      • "eu-west-1"
      • "eu-west-2"
      • "eu-west-3"
      • "eu-central-1"
      • "eu-central-2"
      • "ap-east-1"
      • "me-south-1"
      • "us-gov-west-1"
      • "us-gov-east-1"
      • "us-iso-east-1"
      • "us-iso-west-1"
      • "us-isob-east-1"
      • "me-central-1"
      • "ap-southeast-1"
      • "ap-southeast-2"
      • "ap-southeast-3"
      • "ap-south-1"
      • "ap-south-2"
      • "ap-northeast-1"
      • "ap-northeast-2"
      • "ap-northeast-3"
      • "eu-north-1"
      • "sa-east-1"
      • "ca-central-1"
      • "cn-north-1"
      • "af-south-1"
      • "eu-south-1"
      • "eu-south-2"
      • "ap-southeast-4"
      • "il-central-1"
      • "ca-west-1"
      • "ap-southeast-5"
    • 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.

      • Id — required — (String)

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

      • Status — required — (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"
      • SubmittedAt — required — (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 comment you can provide.

Returns:

• (AWS.Request) —

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

var params = {
  HostedZoneId: 'STRING_VALUE' /* required */
};
route53.enableHostedZoneDNSSEC(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)

    A unique string used to identify a 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:

    • ChangeInfo — (map)

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

      • Id — required — (String)

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

      • Status — required — (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"
      • SubmittedAt — required — (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 comment you can provide.

Returns:

• (AWS.Request) —

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