Class: AWS.Route53
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.Route53
- Identifier:
- route53
- API Version:
- 2013-04-01
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.
You can use Route 53 to:
-
Register domain names.
For more information, see How domain registration works.
-
Route internet traffic to the resources for your domain
For more information, see How internet traffic is routed to your website or web application.
-
Check the health of your resources.
For more information, see How Route 53 checks the health of your resources.
Sending a Request Using Route53
var route53 = new AWS.Route53();
route53.activateKeySigningKey(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the Route53 object uses this specific API, you can
construct the object by passing the apiVersion option to the constructor:
var route53 = new AWS.Route53({apiVersion: '2013-04-01'});
You can also set the API version globally in AWS.config.apiVersions using
the route53 service identifier:
AWS.config.apiVersions = {
route53: '2013-04-01',
// other service API versions
};
var route53 = new AWS.Route53();
Waiter Resource States
This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:
Constructor Summary collapse
-
new AWS.Route53(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
activateKeySigningKey(params = {}, callback) ⇒ AWS.Request
Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC.
-
associateVPCWithHostedZone(params = {}, callback) ⇒ AWS.Request
Associates an Amazon VPC with a private hosted zone.
-
changeCidrCollection(params = {}, callback) ⇒ AWS.Request
Creates, changes, or deletes CIDR blocks within a collection.
-
changeResourceRecordSets(params = {}, callback) ⇒ AWS.Request
Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name.
-
changeTagsForResource(params = {}, callback) ⇒ AWS.Request
Adds, edits, or deletes tags for a health check or a hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.
. -
createCidrCollection(params = {}, callback) ⇒ AWS.Request
Creates a CIDR collection in the current Amazon Web Services account.
.
-
createHealthCheck(params = {}, callback) ⇒ AWS.Request
Creates a new health check.
For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.
-
createHostedZone(params = {}, callback) ⇒ AWS.Request
Creates a new public or private hosted zone.
-
createKeySigningKey(params = {}, callback) ⇒ AWS.Request
Creates a new key-signing key (KSK) associated with a hosted zone.
-
createQueryLoggingConfig(params = {}, callback) ⇒ AWS.Request
Creates a configuration for DNS query logging.
-
createReusableDelegationSet(params = {}, callback) ⇒ AWS.Request
Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account.
-
createTrafficPolicy(params = {}, callback) ⇒ AWS.Request
Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).
.
-
createTrafficPolicyInstance(params = {}, callback) ⇒ AWS.Request
Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version.
-
createTrafficPolicyVersion(params = {}, callback) ⇒ AWS.Request
Creates a new version of an existing traffic policy.
-
createVPCAssociationAuthorization(params = {}, callback) ⇒ AWS.Request
Authorizes the Amazon Web Services account that created a specified VPC to submit an
AssociateVPCWithHostedZonerequest to associate the VPC with a specified hosted zone that was created by a different account. -
deactivateKeySigningKey(params = {}, callback) ⇒ AWS.Request
Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC.
-
deleteCidrCollection(params = {}, callback) ⇒ AWS.Request
Deletes a CIDR collection in the current Amazon Web Services account.
-
deleteHealthCheck(params = {}, callback) ⇒ AWS.Request
Deletes a health check.
Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets.
-
deleteHostedZone(params = {}, callback) ⇒ AWS.Request
Deletes a hosted zone.
If the hosted zone was created by another service, such as Cloud Map, see Deleting Public Hosted Zones That Were Created by Another Service in the Amazon Route 53 Developer Guide for information about how to delete it.
-
deleteKeySigningKey(params = {}, callback) ⇒ AWS.Request
Deletes a key-signing key (KSK).
-
deleteQueryLoggingConfig(params = {}, callback) ⇒ AWS.Request
Deletes a configuration for DNS query logging.
-
deleteReusableDelegationSet(params = {}, callback) ⇒ AWS.Request
Deletes a reusable delegation set.
You can delete a reusable delegation set only if it isn't associated with any hosted zones.
To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete.
. -
deleteTrafficPolicy(params = {}, callback) ⇒ AWS.Request
Deletes a traffic policy.
When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that it has been deleted.
-
deleteTrafficPolicyInstance(params = {}, callback) ⇒ AWS.Request
Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.
Note: In the Route 53 console, traffic policy instances are known as policy records.- deleteVPCAssociationAuthorization(params = {}, callback) ⇒ AWS.Request
Removes authorization to submit an
AssociateVPCWithHostedZonerequest to associate a specified VPC with a hosted zone that was created by a different account.- disableHostedZoneDNSSEC(params = {}, callback) ⇒ AWS.Request
Disables DNSSEC signing in a specific hosted zone.
- disassociateVPCFromHostedZone(params = {}, callback) ⇒ AWS.Request
Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone.
- enableHostedZoneDNSSEC(params = {}, callback) ⇒ AWS.Request
Enables DNSSEC signing in a specific hosted zone.
.
- getAccountLimit(params = {}, callback) ⇒ AWS.Request
Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account.
For the default limit, see Limits in the Amazon Route 53 Developer Guide.
- getChange(params = {}, callback) ⇒ AWS.Request
Returns the current status of a change batch request.
- getCheckerIpRanges(params = {}, callback) ⇒ AWS.Request
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
GetCheckerIpRangesstill works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all Amazon Web Services services.- getDNSSEC(params = {}, callback) ⇒ AWS.Request
Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone.
.
- getGeoLocation(params = {}, callback) ⇒ AWS.Request
Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
Use the following syntax to determine whether a continent is supported for geolocation:
GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for a continentUse the following syntax to determine whether a country is supported for geolocation:
GET /2013-04-01/geolocation?countrycode=two-character country codeUse the following syntax to determine whether a subdivision of a country is supported for geolocation:
.GET /2013-04-01/geolocation?countrycode=two-character country code&subdivisioncode=subdivision code- getHealthCheck(params = {}, callback) ⇒ AWS.Request
Gets information about a specified health check.
.
- getHealthCheckCount(params = {}, callback) ⇒ AWS.Request
Retrieves the number of health checks that are associated with the current Amazon Web Services account.
.
- getHealthCheckLastFailureReason(params = {}, callback) ⇒ AWS.Request
Gets the reason that a specified health check failed most recently.
.
- getHealthCheckStatus(params = {}, callback) ⇒ AWS.Request
Gets status of a specified health check.
- getHostedZone(params = {}, callback) ⇒ AWS.Request
Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.
.
- getHostedZoneCount(params = {}, callback) ⇒ AWS.Request
Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.
.
- getHostedZoneLimit(params = {}, callback) ⇒ AWS.Request
Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone.
- getQueryLoggingConfig(params = {}, callback) ⇒ AWS.Request
Gets information about a specified configuration for DNS query logging.
For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries.
.- getReusableDelegationSet(params = {}, callback) ⇒ AWS.Request
Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.
.
- getReusableDelegationSetLimit(params = {}, callback) ⇒ AWS.Request
Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.
For the default limit, see Limits in the Amazon Route 53 Developer Guide.
- getTrafficPolicy(params = {}, callback) ⇒ AWS.Request
Gets information about a specific traffic policy version.
For information about how of deleting a traffic policy affects the response from
GetTrafficPolicy, see DeleteTrafficPolicy.- getTrafficPolicyInstance(params = {}, callback) ⇒ AWS.Request
Gets information about a specified traffic policy instance.
Note: UseGetTrafficPolicyInstancewith theidof new traffic policy instance to confirm that theCreateTrafficPolicyInstanceor anUpdateTrafficPolicyInstancerequest completed successfully.- getTrafficPolicyInstanceCount(params = {}, callback) ⇒ AWS.Request
Gets the number of traffic policy instances that are associated with the current Amazon Web Services account.
.
- listCidrBlocks(params = {}, callback) ⇒ AWS.Request
Returns a paginated list of location objects and their CIDR blocks.
.
- listCidrCollections(params = {}, callback) ⇒ AWS.Request
Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only).
.
- listCidrLocations(params = {}, callback) ⇒ AWS.Request
Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks).
.
- listGeoLocations(params = {}, callback) ⇒ AWS.Request
Retrieves a list of supported geographic locations.
Countries are listed first, and continents are listed last.
- listHealthChecks(params = {}, callback) ⇒ AWS.Request
Retrieve a list of the health checks that are associated with the current Amazon Web Services account.
- listHostedZones(params = {}, callback) ⇒ AWS.Request
Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account.
- listHostedZonesByName(params = {}, callback) ⇒ AWS.Request
Retrieves a list of your hosted zones in lexicographic order.
- listHostedZonesByVPC(params = {}, callback) ⇒ AWS.Request
Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones.
- listQueryLoggingConfigs(params = {}, callback) ⇒ AWS.Request
Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with a specified hosted zone.
For more information about DNS query logs, see CreateQueryLoggingConfig.
- listResourceRecordSets(params = {}, callback) ⇒ AWS.Request
Lists the resource record sets in a specified hosted zone.
ListResourceRecordSetsreturns up to 300 resource record sets at a time in ASCII order, beginning at a position specified by thenameandtypeelements.Sort order
ListResourceRecordSetssorts results first by DNS name with the labels reversed, for example:com.example.www.Note the trailing dot, which can change the sort order when the record name contains characters that appear before
.(decimal 46) in the ASCII table.- listReusableDelegationSets(params = {}, callback) ⇒ AWS.Request
Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.
.
- listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists tags for one health check or hosted zone.
- listTagsForResources(params = {}, callback) ⇒ AWS.Request
Lists tags for up to 10 health checks or hosted zones.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.
.- listTrafficPolicies(params = {}, callback) ⇒ AWS.Request
Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account.
- listTrafficPolicyInstances(params = {}, callback) ⇒ AWS.Request
Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.
Note: After you submit anUpdateTrafficPolicyInstancerequest, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition.- listTrafficPolicyInstancesByHostedZone(params = {}, callback) ⇒ AWS.Request
Gets information about the traffic policy instances that you created in a specified hosted zone.
Note: After you submit aCreateTrafficPolicyInstanceor anUpdateTrafficPolicyInstancerequest, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition.- listTrafficPolicyInstancesByPolicy(params = {}, callback) ⇒ AWS.Request
Gets information about the traffic policy instances that you created by using a specify traffic policy version.
Note: After you submit aCreateTrafficPolicyInstanceor anUpdateTrafficPolicyInstancerequest, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition.- listTrafficPolicyVersions(params = {}, callback) ⇒ AWS.Request
Gets information about all of the versions for a specified traffic policy.
Traffic policy versions are listed in numerical order by
.VersionNumber.- listVPCAssociationAuthorizations(params = {}, callback) ⇒ AWS.Request
Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more
CreateVPCAssociationAuthorizationrequests.- testDNSAnswer(params = {}, callback) ⇒ AWS.Request
Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type.
- updateHealthCheck(params = {}, callback) ⇒ AWS.Request
Updates an existing health check.
- updateHostedZoneComment(params = {}, callback) ⇒ AWS.Request
Updates the comment for a specified hosted zone.
.
- updateTrafficPolicyComment(params = {}, callback) ⇒ AWS.Request
Updates the comment for a specified traffic policy version.
.
- updateTrafficPolicyInstance(params = {}, callback) ⇒ AWS.Request
Note: After you submit aUpdateTrafficPolicyInstancerequest, there's a brief delay while Route 53 creates the resource record sets that are specified in the traffic policy definition.- waitFor(state, params = {}, callback) ⇒ AWS.Request
Waits for a given Route53 resource.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, defineService
Constructor Details
new AWS.Route53(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
activateKeySigningKey(params = {}, callback) ⇒ AWS.Request
Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the KSK status to
ACTIVE.associateVPCWithHostedZone(params = {}, callback) ⇒ AWS.Request
Associates an Amazon VPC with a private hosted zone.
To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.
Note: If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a different account, the Amazon Web Services account that created the private hosted zone must first submit aCreateVPCAssociationAuthorizationrequest. Then the account that created the VPC must submit anAssociateVPCWithHostedZonerequest.Note: When granting access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition. The following are the supported partitions:-
aws- Amazon Web Services Regions -
aws-cn- China Regions -
aws-us-gov- Amazon Web Services GovCloud (US) Region
changeCidrCollection(params = {}, callback) ⇒ AWS.Request
Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative IP information mapping blocks to one or multiple locations.
A change request can update multiple locations in a collection at a time, which is helpful if you want to move one or more CIDR blocks from one location to another in one transaction, without downtime.
Limits
The max number of CIDR blocks included in the request is 1000. As a result, big updates require multiple API calls.
PUT and DELETE_IF_EXISTS
Use
ChangeCidrCollectionto perform the following actions:-
PUT: Create a CIDR block within the specified collection. -
DELETE_IF_EXISTS: Delete an existing CIDR block from the collection.
changeResourceRecordSets(params = {}, callback) ⇒ AWS.Request
Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use
ChangeResourceRecordSetsto create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.Deleting Resource Record Sets
To delete a resource record set, you must specify all the same values that you specified when you created it.
Change Batches and Transactional Changes
The request body must include a document with a
ChangeResourceRecordSetsRequestelement. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. Route 53 validates the changes in the request and then either makes all or none of the changes in the change batch request. This ensures that DNS routing isn't adversely affected by partial changes to the resource record sets in a hosted zone.For example, suppose a change batch request contains two changes: it deletes the
CNAMEresource record set for www.example.com and creates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If validation for either theDELETEor theCREATEaction fails, then the request is canceled, and the originalCNAMErecord continues to exist.Note: If you try to delete the same resource record set more than once in a single change batch, Route 53 returns anInvalidChangeBatcherror.Traffic Flow
To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide.
Create, Delete, and Upsert
Use
ChangeResourceRecordsSetsRequestto perform the following actions:-
CREATE: Creates a resource record set that has the specified values. -
DELETE: Deletes an existing resource record set that has the specified values. -
UPSERT: If a resource set doesn't exist, Route 53 creates it. If a resource set exists Route 53 updates it with the values in the request.
Syntaxes for Creating, Updating, and Deleting Resource Record Sets
The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.
For an example for each type of resource record set, see "Examples."
Don't refer to the syntax in the "Parameter Syntax" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using
ChangeResourceRecordSets.Change Propagation to Route 53 DNS Servers
When you submit a
ChangeResourceRecordSetsrequest, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers managing the hosted zone. While your changes are propagating,GetChangereturns a status ofPENDING. When propagation is complete,GetChangereturns a status ofINSYNC. Changes generally propagate to all Route 53 name servers managing the hosted zone within 60 seconds. For more information, see GetChange.Limits on ChangeResourceRecordSets Requests
For information about the limits on a
ChangeResourceRecordSetsrequest, see Limits in the Amazon Route 53 Developer Guide. - deleteVPCAssociationAuthorization(params = {}, callback) ⇒ AWS.Request