Skip to content

Commit be6229e

Browse files
author
AWS
committed
Amazon DynamoDB Accelerator (DAX) Update: Documentation updates for dax
1 parent 879d14c commit be6229e

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon DynamoDB Accelerator (DAX)",
4+
"description": "Documentation updates for dax"
5+
}

services/dax/src/main/resources/codegen-resources/service-2.json

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@
185185
{"shape":"InvalidParameterValueException"},
186186
{"shape":"InvalidParameterCombinationException"}
187187
],
188-
"documentation":"<p>Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.</p> <p>By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.</p>"
188+
"documentation":"<p>Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.</p> <p>By default, only the events occurring within the last 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary.</p>"
189189
},
190190
"DescribeParameterGroups":{
191191
"name":"DescribeParameterGroups",
@@ -288,7 +288,7 @@
288288
{"shape":"InvalidParameterValueException"},
289289
{"shape":"InvalidParameterCombinationException"}
290290
],
291-
"documentation":"<p>Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING.</p>"
291+
"documentation":"<p>Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING.</p> <note> <p> <code>RebootNode</code> restarts the DAX engine process and does not remove the contents of the cache. </p> </note>"
292292
},
293293
"TagResource":{
294294
"name":"TagResource",
@@ -521,11 +521,11 @@
521521
},
522522
"ReplicationFactor":{
523523
"shape":"Integer",
524-
"documentation":"<p>The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set <i>ReplicationFactor</i> to 2 or more.</p> <note> <p>AWS recommends that you have at least two read replicas per cluster.</p> </note>"
524+
"documentation":"<p>The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set <code>ReplicationFactor</code> to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). <code>If the AvailabilityZones</code> parameter is provided, its length must equal the <code>ReplicationFactor</code>.</p> <note> <p>AWS recommends that you have at least two read replicas per cluster.</p> </note>"
525525
},
526526
"AvailabilityZones":{
527527
"shape":"AvailabilityZoneList",
528-
"documentation":"<p>The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.</p>"
528+
"documentation":"<p>The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the <code>ReplicationFactor</code> parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.</p>"
529529
},
530530
"SubnetGroupName":{
531531
"shape":"String",
@@ -1392,6 +1392,7 @@
13921392
"type":"structure",
13931393
"members":{
13941394
},
1395+
"documentation":"<p>The specified service linked role (SLR) was not found.</p>",
13951396
"exception":true
13961397
},
13971398
"SourceType":{
@@ -1412,7 +1413,7 @@
14121413
},
14131414
"SubnetAvailabilityZone":{
14141415
"shape":"String",
1415-
"documentation":"<p>The Availability Zone (AZ) for subnet subnet.</p>"
1416+
"documentation":"<p>The Availability Zone (AZ) for the subnet.</p>"
14161417
}
14171418
},
14181419
"documentation":"<p>Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.</p>"

0 commit comments

Comments
 (0)