Skip to content

Commit da66ee3

Browse files
author
awstools
committed
docs(client-route-53): Documentation updates for Amazon Route 53.
1 parent 065eb7f commit da66ee3

File tree

7 files changed

+62
-31
lines changed

7 files changed

+62
-31
lines changed

clients/client-route-53/README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,23 @@
99

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

12-
<p>Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web
12+
<p>Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web
1313
service.</p>
14+
<p>You can use Route 53 to:</p>
15+
<ul>
16+
<li>
17+
<p>Register domain names.</p>
18+
<p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-domain-registration.html">How domain registration works</a>.</p>
19+
</li>
20+
<li>
21+
<p>Route internet traffic to the resources for your domain</p>
22+
<p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html">How internet traffic is routed to your website or web application</a>.</p>
23+
</li>
24+
<li>
25+
<p>Check the health of your resources.</p>
26+
<p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-health-checks.html">How Route 53 checks the health of your resources</a>.</p>
27+
</li>
28+
</ul>
1429

1530
## Installing
1631

clients/client-route-53/src/Route53.ts

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -346,8 +346,23 @@ import {
346346
import { Route53Client } from "./Route53Client";
347347

348348
/**
349-
* <p>Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web
349+
* <p>Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web
350350
* service.</p>
351+
* <p>You can use Route 53 to:</p>
352+
* <ul>
353+
* <li>
354+
* <p>Register domain names.</p>
355+
* <p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-domain-registration.html">How domain registration works</a>.</p>
356+
* </li>
357+
* <li>
358+
* <p>Route internet traffic to the resources for your domain</p>
359+
* <p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html">How internet traffic is routed to your website or web application</a>.</p>
360+
* </li>
361+
* <li>
362+
* <p>Check the health of your resources.</p>
363+
* <p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-health-checks.html">How Route 53 checks the health of your resources</a>.</p>
364+
* </li>
365+
* </ul>
351366
*/
352367
export class Route53 extends Route53Client {
353368
/**
@@ -457,9 +472,8 @@ export class Route53 extends Route53Client {
457472
* <p>
458473
* <b>Limits</b>
459474
* </p>
460-
* <p>The max number of CIDR blocks included in the request is
461-
* 1000.
462-
* As a result, big updates require multiple API calls.</p>
475+
* <p>The max number of CIDR blocks included in the request is 1000. As a result, big updates
476+
* require multiple API calls.</p>
463477
* <p>
464478
* <b> PUT and DELETE_IF_EXISTS</b>
465479
* </p>
@@ -663,9 +677,7 @@ export class Route53 extends Route53Client {
663677
}
664678

665679
/**
666-
* <p>Creates a CIDR collection in the
667-
* current
668-
* Amazon Web Services account.</p>
680+
* <p>Creates a CIDR collection in the current Amazon Web Services account.</p>
669681
*/
670682
public createCidrCollection(
671683
args: CreateCidrCollectionCommandInput,

clients/client-route-53/src/Route53Client.ts

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -570,8 +570,23 @@ type Route53ClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandl
570570
export interface Route53ClientResolvedConfig extends Route53ClientResolvedConfigType {}
571571

572572
/**
573-
* <p>Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web
573+
* <p>Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web
574574
* service.</p>
575+
* <p>You can use Route 53 to:</p>
576+
* <ul>
577+
* <li>
578+
* <p>Register domain names.</p>
579+
* <p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-domain-registration.html">How domain registration works</a>.</p>
580+
* </li>
581+
* <li>
582+
* <p>Route internet traffic to the resources for your domain</p>
583+
* <p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html">How internet traffic is routed to your website or web application</a>.</p>
584+
* </li>
585+
* <li>
586+
* <p>Check the health of your resources.</p>
587+
* <p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-health-checks.html">How Route 53 checks the health of your resources</a>.</p>
588+
* </li>
589+
* </ul>
575590
*/
576591
export class Route53Client extends __Client<
577592
__HttpHandlerOptions,

clients/client-route-53/src/commands/ChangeCidrCollectionCommand.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,8 @@ export interface ChangeCidrCollectionCommandOutput extends ChangeCidrCollectionR
3737
* <p>
3838
* <b>Limits</b>
3939
* </p>
40-
* <p>The max number of CIDR blocks included in the request is
41-
* 1000.
42-
* As a result, big updates require multiple API calls.</p>
40+
* <p>The max number of CIDR blocks included in the request is 1000. As a result, big updates
41+
* require multiple API calls.</p>
4342
* <p>
4443
* <b> PUT and DELETE_IF_EXISTS</b>
4544
* </p>

clients/client-route-53/src/commands/CreateCidrCollectionCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface CreateCidrCollectionCommandInput extends CreateCidrCollectionRe
2828
export interface CreateCidrCollectionCommandOutput extends CreateCidrCollectionResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a CIDR collection in the
32-
* current
33-
* Amazon Web Services account.</p>
31+
* <p>Creates a CIDR collection in the current Amazon Web Services account.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript

clients/client-route-53/src/models/models_0.ts

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -303,10 +303,6 @@ export interface AlarmIdentifier {
303303
* following:</p>
304304
* <ul>
305305
* <li>
306-
* <p>Creating geolocation alias resource record sets or latency alias resource
307-
* record sets in a private hosted zone is unsupported.</p>
308-
* </li>
309-
* <li>
310306
* <p>For information about creating failover resource record sets in a private
311307
* hosted zone, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html">Configuring Failover in a Private Hosted Zone</a>.</p>
312308
* </li>
@@ -1680,10 +1676,6 @@ export interface ResourceRecordSet {
16801676
* route traffic to a CloudFront distribution.</p>
16811677
* </li>
16821678
* <li>
1683-
* <p>Creating geolocation alias resource record sets or latency alias resource
1684-
* record sets in a private hosted zone is unsupported.</p>
1685-
* </li>
1686-
* <li>
16871679
* <p>For information about creating failover resource record sets in a private
16881680
* hosted zone, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html">Configuring Failover in a Private Hosted Zone</a> in the
16891681
* <i>Amazon Route 53 Developer Guide</i>.</p>
@@ -5708,8 +5700,8 @@ export interface LocationSummary {
57085700

57095701
export interface ListCidrLocationsResponse {
57105702
/**
5711-
* <p>An opaque
5712-
* pagination token to indicate where the service is to begin enumerating results.</p>
5703+
* <p>An opaque pagination token to indicate where the service is to begin enumerating
5704+
* results.</p>
57135705
* <p>If no value is provided, the listing of results starts from the beginning.</p>
57145706
*/
57155707
NextToken?: string;

codegen/sdk-codegen/aws-models/route-53.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
"name": "route53"
5757
},
5858
"aws.protocols#restXml": {},
59-
"smithy.api#documentation": "<p>Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web\n\t\t\tservice.</p>",
59+
"smithy.api#documentation": "<p>Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web\n\t\t\tservice.</p>\n\t\t <p>You can use Route 53 to:</p>\n\t\t <ul>\n <li>\n <p>Register domain names.</p>\n\t\t\t\t <p>For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-domain-registration.html\">How domain registration works</a>.</p>\n </li>\n <li>\n <p>Route internet traffic to the resources for your domain</p>\n\t\t\t\t <p>For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html\">How internet traffic is routed to your website or web application</a>.</p>\n </li>\n <li>\n <p>Check the health of your resources.</p>\n\t\t\t\t <p>For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-health-checks.html\">How Route 53 checks the health of your resources</a>.</p>\n </li>\n </ul>",
6060
"smithy.api#title": "Amazon Route 53",
6161
"smithy.api#xmlNamespace": {
6262
"uri": "https://route53.amazonaws.com/doc/2013-04-01/"
@@ -454,7 +454,7 @@
454454
}
455455
},
456456
"traits": {
457-
"smithy.api#documentation": "<p>\n <i>Alias resource record sets only:</i> Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.</p>\n\t\t <p>When creating resource record sets for a private hosted zone, note the\n\t\t\tfollowing:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>Creating geolocation alias resource record sets or latency alias resource\n\t\t\t\t\trecord sets in a private hosted zone is unsupported.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>For information about creating failover resource record sets in a private\n\t\t\t\t\thosted zone, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html\">Configuring Failover in a Private Hosted Zone</a>.</p>\n\t\t\t </li>\n </ul>"
457+
"smithy.api#documentation": "<p>\n <i>Alias resource record sets only:</i> Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.</p>\n\t\t <p>When creating resource record sets for a private hosted zone, note the\n\t\t\tfollowing:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>For information about creating failover resource record sets in a private\n\t\t\t\t\thosted zone, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html\">Configuring Failover in a Private Hosted Zone</a>.</p>\n\t\t\t </li>\n </ul>"
458458
}
459459
},
460460
"com.amazonaws.route53#AssociateVPCComment": {
@@ -638,7 +638,7 @@
638638
}
639639
],
640640
"traits": {
641-
"smithy.api#documentation": "<p>Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative\n\t\t\tIP information mapping blocks to one or multiple locations.</p>\n\t\t <p>A change request can update multiple locations in a collection at a time, which is\n\t\t\thelpful if you want to move one or more CIDR blocks from one location to another in one\n\t\t\ttransaction, without downtime. </p>\n\t\t <p>\n <b>Limits</b>\n </p>\n\t\t <p>The max number of CIDR blocks included in the request is\n\t\t\t1000.\n\t\t\tAs a result, big updates require multiple API calls.</p>\n\t\t <p>\n <b> PUT and DELETE_IF_EXISTS</b>\n </p>\n\t\t <p>Use <code>ChangeCidrCollection</code> to perform the following actions:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <code>PUT</code>: Create a CIDR block within the specified collection.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code> DELETE_IF_EXISTS</code>: Delete an existing CIDR block from the\n\t\t\t\t\tcollection.</p>\n\t\t\t </li>\n </ul>",
641+
"smithy.api#documentation": "<p>Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative\n\t\t\tIP information mapping blocks to one or multiple locations.</p>\n\t\t <p>A change request can update multiple locations in a collection at a time, which is\n\t\t\thelpful if you want to move one or more CIDR blocks from one location to another in one\n\t\t\ttransaction, without downtime. </p>\n\t\t <p>\n <b>Limits</b>\n </p>\n\t\t <p>The max number of CIDR blocks included in the request is 1000. As a result, big updates\n\t\t\trequire multiple API calls.</p>\n\t\t <p>\n <b> PUT and DELETE_IF_EXISTS</b>\n </p>\n\t\t <p>Use <code>ChangeCidrCollection</code> to perform the following actions:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <code>PUT</code>: Create a CIDR block within the specified collection.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <code> DELETE_IF_EXISTS</code>: Delete an existing CIDR block from the\n\t\t\t\t\tcollection.</p>\n\t\t\t </li>\n </ul>",
642642
"smithy.api#http": {
643643
"method": "POST",
644644
"uri": "/2013-04-01/cidrcollection/{Id}",
@@ -1509,7 +1509,7 @@
15091509
}
15101510
],
15111511
"traits": {
1512-
"smithy.api#documentation": "<p>Creates a CIDR collection in the\n\t\t\tcurrent\n\t\t\t\tAmazon Web Services account.</p>",
1512+
"smithy.api#documentation": "<p>Creates a CIDR collection in the current Amazon Web Services account.</p>",
15131513
"smithy.api#http": {
15141514
"method": "POST",
15151515
"uri": "/2013-04-01/cidrcollection",
@@ -5928,7 +5928,7 @@
59285928
"NextToken": {
59295929
"target": "com.amazonaws.route53#PaginationToken",
59305930
"traits": {
5931-
"smithy.api#documentation": "<p>An opaque\n\t\t\tpagination token to indicate where the service is to begin enumerating results.</p>\n\t\t <p>If no value is provided, the listing of results starts from the beginning.</p>"
5931+
"smithy.api#documentation": "<p>An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.</p>\n\t\t <p>If no value is provided, the listing of results starts from the beginning.</p>"
59325932
}
59335933
},
59345934
"CidrLocations": {
@@ -8097,7 +8097,7 @@
80978097
"AliasTarget": {
80988098
"target": "com.amazonaws.route53#AliasTarget",
80998099
"traits": {
8100-
"smithy.api#documentation": "<p>\n <i>Alias resource record sets only:</i> Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to. </p>\n\t\t <p>If you're creating resource records sets for a private hosted zone, note the\n\t\t\tfollowing:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>You can't create an alias resource record set in a private hosted zone to\n\t\t\t\t\troute traffic to a CloudFront distribution.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>Creating geolocation alias resource record sets or latency alias resource\n\t\t\t\t\trecord sets in a private hosted zone is unsupported.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>For information about creating failover resource record sets in a private\n\t\t\t\t\thosted zone, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html\">Configuring Failover in a Private Hosted Zone</a> in the\n\t\t\t\t\t\t<i>Amazon Route 53 Developer Guide</i>.</p>\n\t\t\t </li>\n </ul>"
8100+
"smithy.api#documentation": "<p>\n <i>Alias resource record sets only:</i> Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to. </p>\n\t\t <p>If you're creating resource records sets for a private hosted zone, note the\n\t\t\tfollowing:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>You can't create an alias resource record set in a private hosted zone to\n\t\t\t\t\troute traffic to a CloudFront distribution.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>For information about creating failover resource record sets in a private\n\t\t\t\t\thosted zone, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html\">Configuring Failover in a Private Hosted Zone</a> in the\n\t\t\t\t\t\t<i>Amazon Route 53 Developer Guide</i>.</p>\n\t\t\t </li>\n </ul>"
81018101
}
81028102
},
81038103
"HealthCheckId": {

0 commit comments

Comments
 (0)