feat(client-dax): This release adds support for IPv6-only, DUAL_STACK DAX instances

Author: awstools

clients/client-dax/README.md

@@ -6,11 +6,11 @@
 
 AWS SDK for JavaScript DAX Client for Node.js, Browser and React Native.
 
-<p>DAX is a managed caching service engineered for Amazon DynamoDB. DAX
-dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so
-applications can access that data with sub-millisecond latency. You can create a DAX
-cluster easily, using the AWS Management Console. With a few simple modifications to
-your code, your application can begin taking advantage of the DAX cluster and realize
+<p>DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching
+frequently-accessed data from DynamoDB, so applications can access that data
+with sub-millisecond latency. You can create a DAX cluster easily, using
+the Amazon Web Services Management Console. With a few simple modifications to your code, your
+application can begin taking advantage of the DAX cluster and realize
 significant improvements in read performance.</p>
 
 ## Installing

clients/client-dax/src/DAX.ts

@@ -441,11 +441,11 @@ export interface DAX {
 }
 
 /**
- * <p>DAX is a managed caching service engineered for Amazon DynamoDB. DAX
- *             dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so
- *             applications can access that data with sub-millisecond latency. You can create a DAX
- *             cluster easily, using the AWS Management Console. With a few simple modifications to
- *             your code, your application can begin taking advantage of the DAX cluster and realize
+ * <p>DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching
+ *             frequently-accessed data from DynamoDB, so applications can access that data
+ *             with sub-millisecond latency. You can create a DAX cluster easily, using
+ *             the Amazon Web Services Management Console. With a few simple modifications to your code, your
+ *             application can begin taking advantage of the DAX cluster and realize
  *             significant improvements in read performance.</p>
  * @public
  */

clients/client-dax/src/DAXClient.ts

@@ -352,11 +352,11 @@ export type DAXClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHa
 export interface DAXClientResolvedConfig extends DAXClientResolvedConfigType {}
 
 /**
- * <p>DAX is a managed caching service engineered for Amazon DynamoDB. DAX
- *             dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so
- *             applications can access that data with sub-millisecond latency. You can create a DAX
- *             cluster easily, using the AWS Management Console. With a few simple modifications to
- *             your code, your application can begin taking advantage of the DAX cluster and realize
+ * <p>DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching
+ *             frequently-accessed data from DynamoDB, so applications can access that data
+ *             with sub-millisecond latency. You can create a DAX cluster easily, using
+ *             the Amazon Web Services Management Console. With a few simple modifications to your code, your
+ *             application can begin taking advantage of the DAX cluster and realize
  *             significant improvements in read performance.</p>
  * @public
  */

clients/client-dax/src/commands/CreateClusterCommand.ts

@@ -63,6 +63,7 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
  *     Enabled: true || false, // required
  *   },
  *   ClusterEndpointEncryptionType: "NONE" || "TLS",
+ *   NetworkType: "ipv4" || "ipv6" || "dual_stack",
  * };
  * const command = new CreateClusterCommand(input);
  * const response = await client.send(command);
@@ -121,6 +122,7 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
  * //       Status: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED",
  * //     },
  * //     ClusterEndpointEncryptionType: "NONE" || "TLS",
+ * //     NetworkType: "ipv4" || "ipv6" || "dual_stack",
  * //   },
  * // };
  *
@@ -136,16 +138,16 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
  *  <p>You already have a DAX cluster with the given identifier.</p>
  *
  * @throws {@link ClusterQuotaForCustomerExceededFault} (client fault)
- *  <p>You have attempted to exceed the maximum number of DAX clusters for your AWS
- *             account.</p>
+ *  <p>You have attempted to exceed the maximum number of DAX clusters for
+ *             your Amazon Web Services account.</p>
  *
  * @throws {@link InsufficientClusterCapacityFault} (client fault)
  *  <p>There are not enough system resources to create the cluster you requested (or to
  *             resize an already-existing cluster). </p>
  *
  * @throws {@link InvalidClusterStateFault} (client fault)
- *  <p>The requested DAX cluster is not in the <i>available</i>
- *             state.</p>
+ *  <p>The requested DAX cluster is not in the
+ *                 <i>available</i> state.</p>
  *
  * @throws {@link InvalidParameterCombinationException} (client fault)
  *  <p>Two or more incompatible parameters were specified.</p>
@@ -164,8 +166,7 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
  *             cluster.</p>
  *
  * @throws {@link NodeQuotaForCustomerExceededFault} (client fault)
- *  <p>You have attempted to exceed the maximum number of nodes for your AWS
- *             account.</p>
+ *  <p>You have attempted to exceed the maximum number of nodes for your Amazon Web Services account.</p>
  *
  * @throws {@link ParameterGroupNotFoundFault} (client fault)
  *  <p>The specified parameter group does not exist.</p>
@@ -175,8 +176,8 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
  *  <p>You have reached the maximum number of x509 certificates that can be created for
- *             encrypted clusters in a 30 day period. Contact AWS customer support to discuss options
- *             for continuing to create encrypted clusters.</p>
+ *             encrypted clusters in a 30 day period. Contact Amazon Web Services customer support to
+ *             discuss options for continuing to create encrypted clusters.</p>
  *
  * @throws {@link SubnetGroupNotFoundFault} (client fault)
  *  <p>The requested subnet group name does not refer to an existing subnet

clients/client-dax/src/commands/CreateSubnetGroupCommand.ts

@@ -55,8 +55,14 @@ export interface CreateSubnetGroupCommandOutput extends CreateSubnetGroupRespons
  * //       { // Subnet
  * //         SubnetIdentifier: "STRING_VALUE",
  * //         SubnetAvailabilityZone: "STRING_VALUE",
+ * //         SupportedNetworkTypes: [ // NetworkTypeList
+ * //           "ipv4" || "ipv6" || "dual_stack",
+ * //         ],
  * //       },
  * //     ],
+ * //     SupportedNetworkTypes: [
+ * //       "ipv4" || "ipv6" || "dual_stack",
+ * //     ],
  * //   },
  * // };
  *
@@ -81,6 +87,13 @@ export interface CreateSubnetGroupCommandOutput extends CreateSubnetGroupRespons
  *  <p>The request cannot be processed because it would exceed the allowed number of
  *             subnets in a subnet group.</p>
  *
+ * @throws {@link SubnetNotAllowedFault} (client fault)
+ *  <p>The specified subnet can't be used for the requested network type. This error
+ *             occurs when either there aren't enough subnets of the required network type to create
+ *             the cluster, or when you try to use a subnet that doesn't support the requested network
+ *             type (for example, trying to create a dual-stack cluster with a subnet that doesn't have
+ *             IPv6 CIDR). </p>
+ *
  * @throws {@link SubnetQuotaExceededFault} (client fault)
  *  <p>The request cannot be processed because it would exceed the allowed number of
  *             subnets in a subnet group.</p>

clients/client-dax/src/commands/DecreaseReplicationFactorCommand.ts

@@ -29,8 +29,10 @@ export interface DecreaseReplicationFactorCommandOutput extends DecreaseReplicat
 
 /**
  * <p>Removes one or more nodes from a DAX cluster.</p>
- *         <note>
- *             <p>You cannot use <code>DecreaseReplicationFactor</code> to remove the last node in a DAX cluster. If you need to do this, use <code>DeleteCluster</code> instead.</p>
+ *          <note>
+ *             <p>You cannot use <code>DecreaseReplicationFactor</code> to remove the last node
+ *                 in a DAX cluster. If you need to do this, use
+ *                     <code>DeleteCluster</code> instead.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -107,6 +109,7 @@ export interface DecreaseReplicationFactorCommandOutput extends DecreaseReplicat
  * //       Status: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED",
  * //     },
  * //     ClusterEndpointEncryptionType: "NONE" || "TLS",
+ * //     NetworkType: "ipv4" || "ipv6" || "dual_stack",
  * //   },
  * // };
  *
@@ -119,11 +122,12 @@ export interface DecreaseReplicationFactorCommandOutput extends DecreaseReplicat
  * @see {@link DAXClientResolvedConfig | config} for DAXClient's `config` shape.
  *
  * @throws {@link ClusterNotFoundFault} (client fault)
- *  <p>The requested cluster ID does not refer to an existing DAX cluster.</p>
+ *  <p>The requested cluster ID does not refer to an existing DAX
+ *             cluster.</p>
  *
  * @throws {@link InvalidClusterStateFault} (client fault)
- *  <p>The requested DAX cluster is not in the <i>available</i>
- *             state.</p>
+ *  <p>The requested DAX cluster is not in the
+ *                 <i>available</i> state.</p>
  *
  * @throws {@link InvalidParameterCombinationException} (client fault)
  *  <p>Two or more incompatible parameters were specified.</p>

clients/client-dax/src/commands/DeleteClusterCommand.ts

@@ -29,10 +29,10 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
 
 /**
  * <p>Deletes a previously provisioned DAX cluster.
- *                 <i>DeleteCluster</i> deletes all associated nodes, node endpoints
- *             and the DAX cluster itself. When you receive a successful response from this action,
- *             DAX immediately begins deleting the cluster; you cannot cancel or revert this
- *             action.</p>
+ *                 <i>DeleteCluster</i> deletes all associated nodes, node endpoints and
+ *             the DAX cluster itself. When you receive a successful response from this
+ *             action, DAX immediately begins deleting the cluster; you cannot cancel or
+ *             revert this action.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -101,6 +101,7 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
  * //       Status: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED",
  * //     },
  * //     ClusterEndpointEncryptionType: "NONE" || "TLS",
+ * //     NetworkType: "ipv4" || "ipv6" || "dual_stack",
  * //   },
  * // };
  *
@@ -113,11 +114,12 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
  * @see {@link DAXClientResolvedConfig | config} for DAXClient's `config` shape.
  *
  * @throws {@link ClusterNotFoundFault} (client fault)
- *  <p>The requested cluster ID does not refer to an existing DAX cluster.</p>
+ *  <p>The requested cluster ID does not refer to an existing DAX
+ *             cluster.</p>
  *
  * @throws {@link InvalidClusterStateFault} (client fault)
- *  <p>The requested DAX cluster is not in the <i>available</i>
- *             state.</p>
+ *  <p>The requested DAX cluster is not in the
+ *                 <i>available</i> state.</p>
  *
  * @throws {@link InvalidParameterCombinationException} (client fault)
  *  <p>Two or more incompatible parameters were specified.</p>

clients/client-dax/src/commands/DeleteSubnetGroupCommand.ts

@@ -29,10 +29,10 @@ export interface DeleteSubnetGroupCommandOutput extends DeleteSubnetGroupRespons
 
 /**
  * <p>Deletes a subnet group.</p>
- *         <note>
+ *          <note>
  *             <p>You cannot delete a subnet group if it is associated with any DAX
  *                 clusters.</p>
- *         </note>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-dax/src/commands/DescribeClustersCommand.ts

@@ -28,19 +28,19 @@ export interface DescribeClustersCommandInput extends DescribeClustersRequest {}
 export interface DescribeClustersCommandOutput extends DescribeClustersResponse, __MetadataBearer {}
 
 /**
- * <p>Returns information about all provisioned DAX clusters if no cluster identifier
- *             is specified, or about a specific DAX cluster if a cluster identifier is
+ * <p>Returns information about all provisioned DAX clusters if no cluster identifier is
+ *             specified, or about a specific DAX cluster if a cluster identifier is
  *             supplied.</p>
- *         <p>If the cluster is in the CREATING state, only cluster level information will be
+ *          <p>If the cluster is in the CREATING state, only cluster level information will be
  *             displayed until all of the nodes are successfully provisioned.</p>
- *         <p>If the cluster is in the DELETING state, only cluster level information will be
+ *          <p>If the cluster is in the DELETING state, only cluster level information will be
  *             displayed.</p>
- *         <p>If nodes are currently being added to the DAX cluster, node endpoint information
+ *          <p>If nodes are currently being added to the DAX cluster, node endpoint information
  *             and creation time for the additional nodes will not be displayed until they are
- *             completely provisioned. When the DAX cluster state is <i>available</i>,
- *             the cluster is ready for use.</p>
- *         <p>If nodes are currently being removed from the DAX cluster, no endpoint
- *             information for the removed nodes is displayed.</p>
+ *             completely provisioned. When the DAX cluster state is
+ *                 <i>available</i>, the cluster is ready for use.</p>
+ *          <p>If nodes are currently being removed from the DAX cluster, no
+ *             endpoint information for the removed nodes is displayed.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -115,6 +115,7 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse,
  * //         Status: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED",
  * //       },
  * //       ClusterEndpointEncryptionType: "NONE" || "TLS",
+ * //       NetworkType: "ipv4" || "ipv6" || "dual_stack",
  * //     },
  * //   ],
  * // };
@@ -128,7 +129,8 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse,
  * @see {@link DAXClientResolvedConfig | config} for DAXClient's `config` shape.
  *
  * @throws {@link ClusterNotFoundFault} (client fault)
- *  <p>The requested cluster ID does not refer to an existing DAX cluster.</p>
+ *  <p>The requested cluster ID does not refer to an existing DAX
+ *             cluster.</p>
  *
  * @throws {@link InvalidParameterCombinationException} (client fault)
  *  <p>Two or more incompatible parameters were specified.</p>

clients/client-dax/src/commands/DescribeEventsCommand.ts

@@ -28,11 +28,11 @@ export interface DescribeEventsCommandInput extends DescribeEventsRequest {}
 export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __MetadataBearer {}
 
 /**
- * <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>
+ * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript