@aws-sdk/client-route-53

What is @aws-sdk/client-route-53?

@aws-sdk/client-route-53 is an AWS SDK for JavaScript package that allows you to interact with Amazon Route 53, a scalable Domain Name System (DNS) web service. This package provides a variety of functionalities to manage DNS records, hosted zones, and health checks.

What are @aws-sdk/client-route-53's main functionalities?

Create Hosted Zone

This feature allows you to create a new hosted zone in Amazon Route 53. A hosted zone is a container for DNS records for a specific domain.

const { Route53Client, CreateHostedZoneCommand } = require('@aws-sdk/client-route-53');

const client = new Route53Client({ region: 'us-east-1' });

const params = {
  Name: 'example.com',
  CallerReference: 'unique-string',
};

const run = async () => {
  try {
    const data = await client.send(new CreateHostedZoneCommand(params));
    console.log(data);
  } catch (err) {
    console.error(err);
  }
};

run();

List Hosted Zones

This feature allows you to list all the hosted zones in your AWS account. It retrieves information about each hosted zone, such as the zone ID and name.

const { Route53Client, ListHostedZonesCommand } = require('@aws-sdk/client-route-53');

const client = new Route53Client({ region: 'us-east-1' });

const run = async () => {
  try {
    const data = await client.send(new ListHostedZonesCommand({}));
    console.log(data.HostedZones);
  } catch (err) {
    console.error(err);
  }
};

run();

Create Record Set

This feature allows you to create a new DNS record set within a hosted zone. You can specify the record type, TTL, and the value for the DNS record.

const { Route53Client, ChangeResourceRecordSetsCommand } = require('@aws-sdk/client-route-53');

const client = new Route53Client({ region: 'us-east-1' });

const params = {
  HostedZoneId: 'Z3M3LMPEXAMPLE',
  ChangeBatch: {
    Changes: [
      {
        Action: 'CREATE',
        ResourceRecordSet: {
          Name: 'www.example.com',
          Type: 'A',
          TTL: 300,
          ResourceRecords: [{ Value: '192.0.2.44' }],
        },
      },
    ],
  },
};

const run = async () => {
  try {
    const data = await client.send(new ChangeResourceRecordSetsCommand(params));
    console.log(data);
  } catch (err) {
    console.error(err);
  }
};

run();

Delete Hosted Zone

This feature allows you to delete a hosted zone from your AWS account. You need to provide the ID of the hosted zone you want to delete.

const { Route53Client, DeleteHostedZoneCommand } = require('@aws-sdk/client-route-53');

const client = new Route53Client({ region: 'us-east-1' });

const params = {
  Id: 'Z3M3LMPEXAMPLE',
};

const run = async () => {
  try {
    const data = await client.send(new DeleteHostedZoneCommand(params));
    console.log(data);
  } catch (err) {
    console.error(err);
  }
};

run();

Other packages similar to @aws-sdk/client-route-53

aws-sdk

The 'aws-sdk' package is the older version of the AWS SDK for JavaScript. It also provides functionalities to interact with Amazon Route 53, among other AWS services. However, '@aws-sdk/client-route-53' is part of the modular AWS SDK v3, which offers better performance and smaller bundle sizes.

dnsimple

The 'dnsimple' package is a Node.js client for the DNSimple API. It allows you to manage DNS records, domains, and other DNS-related functionalities. DNSimple is a third-party DNS service provider, unlike AWS Route 53, which is part of the AWS ecosystem.

README

@aws-sdk/client-route-53

Description

AWS SDK for JavaScript Route53 Client for Node.js, Browser and React Native.

Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.

Installing

To install the this package, simply type add or install @aws-sdk/client-route-53 using your favorite package manager:

• npm install @aws-sdk/client-route-53
• yarn add @aws-sdk/client-route-53
• pnpm add @aws-sdk/client-route-53

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the Route53Client and the commands you need, for example ActivateKeySigningKeyCommand:

// ES5 example
const { Route53Client, ActivateKeySigningKeyCommand } = require("@aws-sdk/client-route-53");

// ES6+ example
import { Route53Client, ActivateKeySigningKeyCommand } from "@aws-sdk/client-route-53";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region).
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by different commands.
const client = new Route53Client({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ActivateKeySigningKeyCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // proccess err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-route-53";
const client = new AWS.Route53({ region: "REGION" });

// async/await.
try {
  const data = await client.activateKeySigningKey(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .activateKeySigningKey(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.activateKeySigningKey(params, (err, data) => {
  // proccess err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-route-53 package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.