Route 53 code examples for the SDK for Kotlin

Overview

This README discusses how to run and test the AWS SDK for Kotlin examples for Amazon Route 53.

Route 53 is a highly available and scalable Domain Name System (DNS) web service. Route 53 connects user requests to internet applications running on AWS or on-premises.

⚠️ Important

• Running this code might result in charges to your AWS account. See AWS Pricing.
• Running the tests might result in charges to your AWS account.
• We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
• This code is not tested in every AWS Region. For more information, see AWS Regional Services.

Code examples

Get started

• Hello Route 53 domain registration (listPrices command)

Single action

Code excerpts that show you how to call individual service functions.

• Check domain availability (checkDomainAvailability command)
• Check domain transferability (checkDomainTransferability command)
• Create a health check (createHealthCheck command)
• Create a hosted zone (createHostedZone command)
• Delete a health check (deleteHealthCheck command)
• Delete a hosted zone (deleteHostedZone command)
• Get domain details (getDomainDetail command)
• Get domain name suggestions. (getDomainSuggestions command)
• Get operation details (getOperationDetail command)
• Get status of a specific health check (getHealthCheckStatus command)
• List current domains (listDomainsPaginated command)
• List domain prices (listPricesPaginated command)
• List current domains (listDomainsPaginated command)
• List health checks (listHealthChecks command)
• List hosted zones (listHostedZones command)
• List operations (listOperationsPaginated command)
• Request a domain registration (registerDomain command)
• Update a health check (updateHealthCheck command)
• View billing (viewBillingPaginated command)

Scenario

Code examples that show you how to accomplish a specific task by calling multiple functions within the same service.

• Get started with domains (various commands)

Run the examples

IMPORTANT

The Kotlin examples perform AWS operations for the account and AWS Region for which you've specified credentials, and you might incur AWS service charges by running them. For details about the charges you can expect for a given service and operation, see the AWS Pricing page.

Some of these examples perform destructive operations on AWS resources, such as deleting a hosted zone. Be very careful when running an operation that deletes or modifies AWS resources in your account. It's best to create separate test-only resources when experimenting with these examples.

Prerequisites

To run these examples, set up your development environment to use Gradle to configure and build AWS SDK for Kotlin projects. For more information, see Get started with the AWS SDK for Kotlin.

Test the examples

⚠️ Running the tests might result in charges to your AWS account.

You can test the Kotlin code example for Amazon Route 53 by running a test file named Route53Test. This file uses JUnit 5 to run the JUnit tests and is located in the src/test/kotlin folder. For more information, see https://junit.org/junit5/.

You can run the JUnit tests from an IDE, such as IntelliJ, or from the command line. As each test runs, you can view messages that inform you if the various tests succeed or fail. For example, the following message informs you that Test 3 passed.

Test 3 passed

WARNING: Running these JUnit tests manipulates real AWS resources and might incur charges on your account.

Properties file

Before running the JUnit tests, you must define values in the config.properties file located in the resources folder. This file contains values that are required to run the JUnit tests. If you do not define all values, the JUnit tests fail.

Define the following values to successfully run the JUnit tests:

• domainName - The fully qualified domain name.
• domainSuggestionSc - The domain suggestion (for example, findmy.example).
• domainTypeSc - The domain type (for example, com).
• phoneNumerSc - The phone number to use (for example, +1.2065550100).
• emailSc - The email address to use.
• firstNameSc - The first name to use.
• lastNameSc - The first name to use.
• citySc - The city to use.

Additional resources

• Developer Guide - AWS SDK for Kotlin.
• Developer Guide - Amazon Route 53.
• route53domains

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0