@aws-sdk/client-dax 3.895.0 → 3.896.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -13,8 +13,8 @@ export declare class ClusterAlreadyExistsFault extends __BaseException {
13
13
  constructor(opts: __ExceptionOptionType<ClusterAlreadyExistsFault, __BaseException>);
14
14
  }
15
15
  /**
16
- * <p>You have attempted to exceed the maximum number of DAX clusters for your AWS
17
- * account.</p>
16
+ * <p>You have attempted to exceed the maximum number of DAX clusters for
17
+ * your Amazon Web Services account.</p>
18
18
  * @public
19
19
  */
20
20
  export declare class ClusterQuotaForCustomerExceededFault extends __BaseException {
@@ -37,36 +37,51 @@ export declare const ClusterEndpointEncryptionType: {
37
37
  * @public
38
38
  */
39
39
  export type ClusterEndpointEncryptionType = (typeof ClusterEndpointEncryptionType)[keyof typeof ClusterEndpointEncryptionType];
40
+ /**
41
+ * @public
42
+ * @enum
43
+ */
44
+ export declare const NetworkType: {
45
+ readonly DUAL_STACK: "dual_stack";
46
+ readonly IPV4: "ipv4";
47
+ readonly IPV6: "ipv6";
48
+ };
49
+ /**
50
+ * @public
51
+ */
52
+ export type NetworkType = (typeof NetworkType)[keyof typeof NetworkType];
40
53
  /**
41
54
  * <p>Represents the settings used to enable server-side encryption.</p>
42
55
  * @public
43
56
  */
44
57
  export interface SSESpecification {
45
58
  /**
46
- * <p>Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.</p>
59
+ * <p>Indicates whether server-side encryption is enabled (true) or disabled (false) on
60
+ * the cluster.</p>
47
61
  * @public
48
62
  */
49
63
  Enabled: boolean | undefined;
50
64
  }
51
65
  /**
52
- * <p>A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single
53
- * DAX cluster.</p>
54
- * <p>AWS-assigned tag names and values are automatically assigned the <code>aws:</code>
55
- * prefix, which the user cannot assign. AWS-assigned tag names do not count towards the
56
- * tag limit of 50. User-assigned tag names have the prefix <code>user:</code>.</p>
57
- * <p>You cannot backdate the application of a tag.</p>
66
+ * <p>A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to
67
+ * a single DAX cluster.</p>
68
+ * <p>Amazon Web Services-assigned tag names and values are automatically assigned the
69
+ * <code>aws:</code> prefix, which the user cannot assign. Amazon Web Services-assigned
70
+ * tag names do not count towards the tag limit of 50. User-assigned tag names have the
71
+ * prefix <code>user:</code>.</p>
72
+ * <p>You cannot backdate the application of a tag.</p>
58
73
  * @public
59
74
  */
60
75
  export interface Tag {
61
76
  /**
62
- * <p>The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have
63
- * one tag with the same key. If you try to add an existing tag (same key), the
64
- * existing tag value will be updated to the new value.</p>
77
+ * <p>The key for the tag. Tag keys are case sensitive. Every DAX cluster
78
+ * can only have one tag with the same key. If you try to add an existing tag (same key),
79
+ * the existing tag value will be updated to the new value.</p>
65
80
  * @public
66
81
  */
67
82
  Key?: string | undefined;
68
83
  /**
69
- * <p>The value of the tag. Tag values are case-sensitive and can be null. </p>
84
+ * <p>The value of the tag. Tag values are case-sensitive and can be null.</p>
70
85
  * @public
71
86
  */
72
87
  Value?: string | undefined;
@@ -76,21 +91,20 @@ export interface Tag {
76
91
  */
77
92
  export interface CreateClusterRequest {
78
93
  /**
79
- * <p>The cluster identifier. This parameter is stored as a lowercase
80
- * string.</p>
81
- * <p>
94
+ * <p>The cluster identifier. This parameter is stored as a lowercase string.</p>
95
+ * <p>
82
96
  * <b>Constraints:</b>
83
- * </p>
84
- * <ul>
97
+ * </p>
98
+ * <ul>
85
99
  * <li>
86
- * <p>A name must contain from 1 to 20 alphanumeric characters or
100
+ * <p>A name must contain from 1 to 20 alphanumeric characters or
87
101
  * hyphens.</p>
88
102
  * </li>
89
103
  * <li>
90
- * <p>The first character must be a letter.</p>
104
+ * <p>The first character must be a letter.</p>
91
105
  * </li>
92
106
  * <li>
93
- * <p>A name cannot end with a hyphen or contain two consecutive
107
+ * <p>A name cannot end with a hyphen or contain two consecutive
94
108
  * hyphens.</p>
95
109
  * </li>
96
110
  * </ul>
@@ -108,38 +122,43 @@ export interface CreateClusterRequest {
108
122
  */
109
123
  Description?: string | undefined;
110
124
  /**
111
- * <p>The number of nodes in the DAX cluster. A replication factor of 1 will
112
- * create a single-node cluster, without any read replicas. For additional fault tolerance,
113
- * you can create a multiple node cluster with one or more read replicas. To do this, set
114
- * <code>ReplicationFactor</code> to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas).
115
- * <code>If the AvailabilityZones</code> parameter is provided, its length must equal the <code>ReplicationFactor</code>.</p>
116
- * <note>
117
- * <p>AWS recommends that you have at least two read replicas per cluster.</p>
125
+ * <p>The number of nodes in the DAX cluster. A replication factor of 1
126
+ * will create a single-node cluster, without any read replicas. For additional fault
127
+ * tolerance, you can create a multiple node cluster with one or more read replicas. To do
128
+ * this, set <code>ReplicationFactor</code> to a number between 3 (one primary and two read
129
+ * replicas) and 10 (one primary and nine read replicas). <code>If the
130
+ * AvailabilityZones</code> parameter is provided, its length must equal the
131
+ * <code>ReplicationFactor</code>.</p>
132
+ * <note>
133
+ * <p>Amazon Web Services recommends that you have at least two read replicas per
134
+ * cluster.</p>
118
135
  * </note>
119
136
  * @public
120
137
  */
121
138
  ReplicationFactor: number | undefined;
122
139
  /**
123
- * <p>The Availability Zones (AZs) in which the cluster nodes will reside after the cluster
124
- * has been created or updated. If provided, the length of this list must equal the <code>ReplicationFactor</code> parameter.
125
- * If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.</p>
140
+ * <p>The Availability Zones (AZs) in which the cluster nodes will reside after the
141
+ * cluster has been created or updated. If provided, the length of this list must equal the
142
+ * <code>ReplicationFactor</code> parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest
143
+ * availability.</p>
126
144
  * @public
127
145
  */
128
146
  AvailabilityZones?: string[] | undefined;
129
147
  /**
130
148
  * <p>The name of the subnet group to be used for the replication group.</p>
131
- * <important>
132
- * <p>DAX clusters can only run in an Amazon VPC environment. All of the subnets
133
- * that you specify in a subnet group must exist in the same VPC.</p>
134
- * </important>
149
+ * <important>
150
+ * <p>DAX clusters can only run in an Amazon VPC environment.
151
+ * All of the subnets that you specify in a subnet group must exist in the same
152
+ * VPC.</p>
153
+ * </important>
135
154
  * @public
136
155
  */
137
156
  SubnetGroupName?: string | undefined;
138
157
  /**
139
- * <p>A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the
140
- * security group ID is system-generated.)</p>
141
- * <p>If this parameter is not specified, DAX assigns the default VPC security group to
142
- * each node.</p>
158
+ * <p>A list of security group IDs to be assigned to each node in the DAX
159
+ * cluster. (Each of the security group ID is system-generated.)</p>
160
+ * <p>If this parameter is not specified, DAX assigns the default VPC
161
+ * security group to each node.</p>
143
162
  * @public
144
163
  */
145
164
  SecurityGroupIds?: string[] | undefined;
@@ -148,66 +167,67 @@ export interface CreateClusterRequest {
148
167
  * performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock
149
168
  * UTC). The minimum maintenance window is a 60 minute period. Valid values for
150
169
  * <code>ddd</code> are:</p>
151
- * <ul>
170
+ * <ul>
152
171
  * <li>
153
- * <p>
154
- * <code>sun</code>
155
- * </p>
172
+ * <p>
173
+ * <code>sun</code>
174
+ * </p>
156
175
  * </li>
157
176
  * <li>
158
- * <p>
159
- * <code>mon</code>
160
- * </p>
177
+ * <p>
178
+ * <code>mon</code>
179
+ * </p>
161
180
  * </li>
162
181
  * <li>
163
- * <p>
164
- * <code>tue</code>
165
- * </p>
182
+ * <p>
183
+ * <code>tue</code>
184
+ * </p>
166
185
  * </li>
167
186
  * <li>
168
- * <p>
169
- * <code>wed</code>
170
- * </p>
187
+ * <p>
188
+ * <code>wed</code>
189
+ * </p>
171
190
  * </li>
172
191
  * <li>
173
- * <p>
174
- * <code>thu</code>
175
- * </p>
192
+ * <p>
193
+ * <code>thu</code>
194
+ * </p>
176
195
  * </li>
177
196
  * <li>
178
- * <p>
179
- * <code>fri</code>
180
- * </p>
197
+ * <p>
198
+ * <code>fri</code>
199
+ * </p>
181
200
  * </li>
182
201
  * <li>
183
- * <p>
184
- * <code>sat</code>
185
- * </p>
202
+ * <p>
203
+ * <code>sat</code>
204
+ * </p>
186
205
  * </li>
187
206
  * </ul>
188
- * <p>Example: <code>sun:05:00-sun:09:00</code>
189
- * </p>
190
- * <note>
207
+ * <p>Example: <code>sun:05:00-sun:09:00</code>
208
+ * </p>
209
+ * <note>
191
210
  * <p>If you don't specify a preferred maintenance window when you create or modify a
192
- * cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day
193
- * of the week.</p>
211
+ * cache cluster, DAX assigns a 60-minute maintenance window on a
212
+ * randomly selected day of the week.</p>
194
213
  * </note>
195
214
  * @public
196
215
  */
197
216
  PreferredMaintenanceWindow?: string | undefined;
198
217
  /**
199
- * <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will
200
- * be sent.</p>
201
- * <note>
202
- * <p>The Amazon SNS topic owner must be same as the DAX cluster owner.</p>
203
- * </note>
218
+ * <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which
219
+ * notifications will be sent.</p>
220
+ * <note>
221
+ * <p>The Amazon SNS topic owner must be same as the DAX
222
+ * cluster owner.</p>
223
+ * </note>
204
224
  * @public
205
225
  */
206
226
  NotificationTopicArn?: string | undefined;
207
227
  /**
208
- * <p>A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX
209
- * will assume this role and use the role's permissions to access DynamoDB on your
210
- * behalf.</p>
228
+ * <p>A valid Amazon Resource Name (ARN) that identifies an IAM role. At
229
+ * runtime, DAX will assume this role and use the role's permissions to
230
+ * access DynamoDB on your behalf.</p>
211
231
  * @public
212
232
  */
213
233
  IamRoleArn: string | undefined;
@@ -217,34 +237,63 @@ export interface CreateClusterRequest {
217
237
  */
218
238
  ParameterGroupName?: string | undefined;
219
239
  /**
220
- * <p>A set of tags to associate with the DAX cluster. </p>
240
+ * <p>A set of tags to associate with the DAX cluster.
241
+ * </p>
221
242
  * @public
222
243
  */
223
244
  Tags?: Tag[] | undefined;
224
245
  /**
225
- * <p>Represents the settings used to enable server-side encryption on the cluster.</p>
246
+ * <p>Represents the settings used to enable server-side encryption on the
247
+ * cluster.</p>
226
248
  * @public
227
249
  */
228
250
  SSESpecification?: SSESpecification | undefined;
229
251
  /**
230
252
  * <p>The type of encryption the cluster's endpoint should support. Values are:</p>
231
- * <ul>
253
+ * <ul>
232
254
  * <li>
233
- * <p>
255
+ * <p>
234
256
  * <code>NONE</code> for no encryption</p>
235
257
  * </li>
236
258
  * <li>
237
- * <p>
259
+ * <p>
238
260
  * <code>TLS</code> for Transport Layer Security</p>
239
261
  * </li>
240
262
  * </ul>
241
263
  * @public
242
264
  */
243
265
  ClusterEndpointEncryptionType?: ClusterEndpointEncryptionType | undefined;
266
+ /**
267
+ * <p>Specifies the IP protocol(s) the cluster uses for network communications. Values
268
+ * are:</p>
269
+ * <ul>
270
+ * <li>
271
+ * <p>
272
+ * <code>ipv4</code> - The cluster is accessible only through IPv4
273
+ * addresses</p>
274
+ * </li>
275
+ * <li>
276
+ * <p>
277
+ * <code>ipv6</code> - The cluster is accessible only through IPv6
278
+ * addresses</p>
279
+ * </li>
280
+ * <li>
281
+ * <p>
282
+ * <code>dual_stack</code> - The cluster is accessible through both IPv4 and
283
+ * IPv6 addresses.</p>
284
+ * </li>
285
+ * </ul>
286
+ * <note>
287
+ * <p>If no explicit <code>NetworkType</code> is provided, the network type is
288
+ * derived based on the subnet group's configuration.</p>
289
+ * </note>
290
+ * @public
291
+ */
292
+ NetworkType?: NetworkType | undefined;
244
293
  }
245
294
  /**
246
- * <p>Represents the information required for client programs to connect to the
247
- * endpoint for a DAX cluster.</p>
295
+ * <p>Represents the information required for client programs to connect to the endpoint
296
+ * for a DAX cluster.</p>
248
297
  * @public
249
298
  */
250
299
  export interface Endpoint {
@@ -259,8 +308,8 @@ export interface Endpoint {
259
308
  */
260
309
  Port?: number | undefined;
261
310
  /**
262
- * <p>The URL that applications should use to connect to the endpoint. The default
263
- * ports are 8111 for the "dax" protocol and 9111 for the "daxs" protocol.</p>
311
+ * <p>The URL that applications should use to connect to the endpoint. The default ports
312
+ * are 8111 for the "dax" protocol and 9111 for the "daxs" protocol.</p>
264
313
  * @public
265
314
  */
266
315
  URL?: string | undefined;
@@ -278,8 +327,8 @@ export interface Node {
278
327
  /**
279
328
  * <p>The endpoint for the node, consisting of a DNS name and a port number. Client
280
329
  * applications can connect directly to a node endpoint, if desired (as an alternative to
281
- * allowing DAX client software to intelligently route requests and responses to nodes in
282
- * the DAX cluster.</p>
330
+ * allowing DAX client software to intelligently route requests and
331
+ * responses to nodes in the DAX cluster.</p>
283
332
  * @public
284
333
  */
285
334
  Endpoint?: Endpoint | undefined;
@@ -313,14 +362,14 @@ export interface Node {
313
362
  */
314
363
  export interface NotificationConfiguration {
315
364
  /**
316
- * <p>The Amazon Resource Name (ARN) that identifies the topic. </p>
365
+ * <p>The Amazon Resource Name (ARN) that identifies the topic.</p>
317
366
  * @public
318
367
  */
319
368
  TopicArn?: string | undefined;
320
369
  /**
321
370
  * <p>The current state of the topic. A value of “active” means that notifications will
322
- * be sent to the topic. A value of “inactive” means that notifications will not be sent to the
323
- * topic.</p>
371
+ * be sent to the topic. A value of “inactive” means that notifications will not be sent to
372
+ * the topic.</p>
324
373
  * @public
325
374
  */
326
375
  TopicStatus?: string | undefined;
@@ -377,7 +426,8 @@ export declare const SSEStatus: {
377
426
  */
378
427
  export type SSEStatus = (typeof SSEStatus)[keyof typeof SSEStatus];
379
428
  /**
380
- * <p>The description of the server-side encryption status on the specified DAX cluster.</p>
429
+ * <p>The description of the server-side encryption status on the specified DAX
430
+ * cluster.</p>
381
431
  * @public
382
432
  */
383
433
  export interface SSEDescription {
@@ -421,8 +471,7 @@ export interface Cluster {
421
471
  */
422
472
  Description?: string | undefined;
423
473
  /**
424
- * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.
425
- * </p>
474
+ * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster. </p>
426
475
  * @public
427
476
  */
428
477
  ClusterArn?: string | undefined;
@@ -438,8 +487,8 @@ export interface Cluster {
438
487
  */
439
488
  ActiveNodes?: number | undefined;
440
489
  /**
441
- * <p>The node type for the nodes in the cluster. (All nodes in a DAX cluster are of
442
- * the same type.)</p>
490
+ * <p>The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the
491
+ * same type.)</p>
443
492
  * @public
444
493
  */
445
494
  NodeType?: string | undefined;
@@ -449,9 +498,9 @@ export interface Cluster {
449
498
  */
450
499
  Status?: string | undefined;
451
500
  /**
452
- * <p>The endpoint for this DAX cluster, consisting of a DNS name, a port number,
453
- * and a URL. Applications should use the URL to configure the DAX client to find
454
- * their cluster.</p>
501
+ * <p>The endpoint for this DAX cluster, consisting of a DNS name, a port
502
+ * number, and a URL. Applications should use the URL to configure the DAX
503
+ * client to find their cluster.</p>
455
504
  * @public
456
505
  */
457
506
  ClusterDiscoveryEndpoint?: Endpoint | undefined;
@@ -485,14 +534,15 @@ export interface Cluster {
485
534
  */
486
535
  SubnetGroup?: string | undefined;
487
536
  /**
488
- * <p>A list of security groups, and the status of each, for the nodes in the cluster.</p>
537
+ * <p>A list of security groups, and the status of each, for the nodes in the
538
+ * cluster.</p>
489
539
  * @public
490
540
  */
491
541
  SecurityGroups?: SecurityGroupMembership[] | undefined;
492
542
  /**
493
- * <p>A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX
494
- * will assume this role and use the role's permissions to access DynamoDB on your
495
- * behalf.</p>
543
+ * <p>A valid Amazon Resource Name (ARN) that identifies an IAM role. At
544
+ * runtime, DAX will assume this role and use the role's permissions to
545
+ * access DynamoDB on your behalf.</p>
496
546
  * @public
497
547
  */
498
548
  IamRoleArn?: string | undefined;
@@ -508,17 +558,36 @@ export interface Cluster {
508
558
  SSEDescription?: SSEDescription | undefined;
509
559
  /**
510
560
  * <p>The type of encryption supported by the cluster's endpoint. Values are:</p>
511
- * <ul>
561
+ * <ul>
512
562
  * <li>
513
- * <p>
563
+ * <p>
514
564
  * <code>NONE</code> for no encryption</p>
515
- * <p>
565
+ * <p>
516
566
  * <code>TLS</code> for Transport Layer Security</p>
517
567
  * </li>
518
568
  * </ul>
519
569
  * @public
520
570
  */
521
571
  ClusterEndpointEncryptionType?: ClusterEndpointEncryptionType | undefined;
572
+ /**
573
+ * <p>The IP address type of the cluster. Values are:</p>
574
+ * <ul>
575
+ * <li>
576
+ * <p>
577
+ * <code>ipv4</code> - IPv4 addresses only</p>
578
+ * </li>
579
+ * <li>
580
+ * <p>
581
+ * <code>ipv6</code> - IPv6 addresses only</p>
582
+ * </li>
583
+ * <li>
584
+ * <p>
585
+ * <code>dual_stack</code> - Both IPv4 and IPv6 addresses</p>
586
+ * </li>
587
+ * </ul>
588
+ * @public
589
+ */
590
+ NetworkType?: NetworkType | undefined;
522
591
  }
523
592
  /**
524
593
  * @public
@@ -544,8 +613,8 @@ export declare class InsufficientClusterCapacityFault extends __BaseException {
544
613
  constructor(opts: __ExceptionOptionType<InsufficientClusterCapacityFault, __BaseException>);
545
614
  }
546
615
  /**
547
- * <p>The requested DAX cluster is not in the <i>available</i>
548
- * state.</p>
616
+ * <p>The requested DAX cluster is not in the
617
+ * <i>available</i> state.</p>
549
618
  * @public
550
619
  */
551
620
  export declare class InvalidClusterStateFault extends __BaseException {
@@ -618,8 +687,7 @@ export declare class NodeQuotaForClusterExceededFault extends __BaseException {
618
687
  constructor(opts: __ExceptionOptionType<NodeQuotaForClusterExceededFault, __BaseException>);
619
688
  }
620
689
  /**
621
- * <p>You have attempted to exceed the maximum number of nodes for your AWS
622
- * account.</p>
690
+ * <p>You have attempted to exceed the maximum number of nodes for your Amazon Web Services account.</p>
623
691
  * @public
624
692
  */
625
693
  export declare class NodeQuotaForCustomerExceededFault extends __BaseException {
@@ -656,8 +724,8 @@ export declare class ServiceLinkedRoleNotFoundFault extends __BaseException {
656
724
  }
657
725
  /**
658
726
  * <p>You have reached the maximum number of x509 certificates that can be created for
659
- * encrypted clusters in a 30 day period. Contact AWS customer support to discuss options
660
- * for continuing to create encrypted clusters.</p>
727
+ * encrypted clusters in a 30 day period. Contact Amazon Web Services customer support to
728
+ * discuss options for continuing to create encrypted clusters.</p>
661
729
  * @public
662
730
  */
663
731
  export declare class ServiceQuotaExceededException extends __BaseException {
@@ -710,8 +778,7 @@ export interface CreateParameterGroupRequest {
710
778
  Description?: string | undefined;
711
779
  }
712
780
  /**
713
- * <p>A named set of parameters that are applied to all of the nodes in a DAX
714
- * cluster.</p>
781
+ * <p>A named set of parameters that are applied to all of the nodes in a DAX cluster.</p>
715
782
  * @public
716
783
  */
717
784
  export interface ParameterGroup {
@@ -782,9 +849,9 @@ export interface CreateSubnetGroupRequest {
782
849
  SubnetIds: string[] | undefined;
783
850
  }
784
851
  /**
785
- * <p>Represents the subnet associated with a DAX cluster. This parameter refers to
786
- * subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with
787
- * DAX.</p>
852
+ * <p>Represents the subnet associated with a DAX cluster. This parameter
853
+ * refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with
854
+ * DAX.</p>
788
855
  * @public
789
856
  */
790
857
  export interface Subnet {
@@ -798,19 +865,26 @@ export interface Subnet {
798
865
  * @public
799
866
  */
800
867
  SubnetAvailabilityZone?: string | undefined;
868
+ /**
869
+ * <p>The network types supported by this subnet. Returns an array of strings that can
870
+ * include <code>ipv4</code>, <code>ipv6</code>, or both, indicating whether the subnet
871
+ * supports IPv4 only, IPv6 only, or dual-stack deployments.</p>
872
+ * @public
873
+ */
874
+ SupportedNetworkTypes?: NetworkType[] | undefined;
801
875
  }
802
876
  /**
803
877
  * <p>Represents the output of one of the following actions:</p>
804
- * <ul>
878
+ * <ul>
805
879
  * <li>
806
- * <p>
807
- * <i>CreateSubnetGroup</i>
808
- * </p>
880
+ * <p>
881
+ * <i>CreateSubnetGroup</i>
882
+ * </p>
809
883
  * </li>
810
884
  * <li>
811
- * <p>
812
- * <i>ModifySubnetGroup</i>
813
- * </p>
885
+ * <p>
886
+ * <i>ModifySubnetGroup</i>
887
+ * </p>
814
888
  * </li>
815
889
  * </ul>
816
890
  * @public
@@ -836,6 +910,13 @@ export interface SubnetGroup {
836
910
  * @public
837
911
  */
838
912
  Subnets?: Subnet[] | undefined;
913
+ /**
914
+ * <p>The network types supported by this subnet. Returns an array of strings that can
915
+ * include <code>ipv4</code>, <code>ipv6</code>, or both, indicating whether the subnet
916
+ * group supports IPv4 only, IPv6 only, or dual-stack deployments. </p>
917
+ * @public
918
+ */
919
+ SupportedNetworkTypes?: NetworkType[] | undefined;
839
920
  }
840
921
  /**
841
922
  * @public
@@ -885,6 +966,22 @@ export declare class SubnetGroupQuotaExceededFault extends __BaseException {
885
966
  */
886
967
  constructor(opts: __ExceptionOptionType<SubnetGroupQuotaExceededFault, __BaseException>);
887
968
  }
969
+ /**
970
+ * <p>The specified subnet can't be used for the requested network type. This error
971
+ * occurs when either there aren't enough subnets of the required network type to create
972
+ * the cluster, or when you try to use a subnet that doesn't support the requested network
973
+ * type (for example, trying to create a dual-stack cluster with a subnet that doesn't have
974
+ * IPv6 CIDR). </p>
975
+ * @public
976
+ */
977
+ export declare class SubnetNotAllowedFault extends __BaseException {
978
+ readonly name: "SubnetNotAllowedFault";
979
+ readonly $fault: "client";
980
+ /**
981
+ * @internal
982
+ */
983
+ constructor(opts: __ExceptionOptionType<SubnetNotAllowedFault, __BaseException>);
984
+ }
888
985
  /**
889
986
  * <p>The request cannot be processed because it would exceed the allowed number of
890
987
  * subnets in a subnet group.</p>
@@ -899,7 +996,8 @@ export declare class SubnetQuotaExceededFault extends __BaseException {
899
996
  constructor(opts: __ExceptionOptionType<SubnetQuotaExceededFault, __BaseException>);
900
997
  }
901
998
  /**
902
- * <p>The requested cluster ID does not refer to an existing DAX cluster.</p>
999
+ * <p>The requested cluster ID does not refer to an existing DAX
1000
+ * cluster.</p>
903
1001
  * @public
904
1002
  */
905
1003
  export declare class ClusterNotFoundFault extends __BaseException {
@@ -915,7 +1013,8 @@ export declare class ClusterNotFoundFault extends __BaseException {
915
1013
  */
916
1014
  export interface DecreaseReplicationFactorRequest {
917
1015
  /**
918
- * <p>The name of the DAX cluster from which you want to remove nodes.</p>
1016
+ * <p>The name of the DAX cluster from which you want to remove
1017
+ * nodes.</p>
919
1018
  * @public
920
1019
  */
921
1020
  ClusterName: string | undefined;
@@ -940,8 +1039,8 @@ export interface DecreaseReplicationFactorRequest {
940
1039
  */
941
1040
  export interface DecreaseReplicationFactorResponse {
942
1041
  /**
943
- * <p>A description of the DAX cluster, after you have decreased its replication
944
- * factor.</p>
1042
+ * <p>A description of the DAX cluster, after you have decreased its
1043
+ * replication factor.</p>
945
1044
  * @public
946
1045
  */
947
1046
  Cluster?: Cluster | undefined;
@@ -1045,7 +1144,7 @@ export interface DescribeClustersRequest {
1045
1144
  * <p>The maximum number of results to include in the response. If more results exist
1046
1145
  * than the specified <code>MaxResults</code> value, a token is included in the response so
1047
1146
  * that the remaining results can be retrieved.</p>
1048
- * <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>
1147
+ * <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>
1049
1148
  * @public
1050
1149
  */
1051
1150
  MaxResults?: number | undefined;
@@ -1069,7 +1168,7 @@ export interface DescribeClustersResponse {
1069
1168
  NextToken?: string | undefined;
1070
1169
  /**
1071
1170
  * <p>The descriptions of your DAX clusters, in response to a
1072
- * <i>DescribeClusters</i> request.</p>
1171
+ * <i>DescribeClusters</i> request.</p>
1073
1172
  * @public
1074
1173
  */
1075
1174
  Clusters?: Cluster[] | undefined;
@@ -1082,7 +1181,7 @@ export interface DescribeDefaultParametersRequest {
1082
1181
  * <p>The maximum number of results to include in the response. If more results exist
1083
1182
  * than the specified <code>MaxResults</code> value, a token is included in the response so
1084
1183
  * that the remaining results can be retrieved.</p>
1085
- * <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>
1184
+ * <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>
1086
1185
  * @public
1087
1186
  */
1088
1187
  MaxResults?: number | undefined;
@@ -1220,7 +1319,7 @@ export interface DescribeDefaultParametersResponse {
1220
1319
  */
1221
1320
  NextToken?: string | undefined;
1222
1321
  /**
1223
- * <p>A list of parameters. Each element in the list represents one parameter.</p>
1322
+ * <p>A list of parameters. Each element in the list represents one parameter.</p>
1224
1323
  * @public
1225
1324
  */
1226
1325
  Parameters?: Parameter[] | undefined;
@@ -1275,7 +1374,7 @@ export interface DescribeEventsRequest {
1275
1374
  * <p>The maximum number of results to include in the response. If more results exist
1276
1375
  * than the specified <code>MaxResults</code> value, a token is included in the response so
1277
1376
  * that the remaining results can be retrieved.</p>
1278
- * <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>
1377
+ * <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>
1279
1378
  * @public
1280
1379
  */
1281
1380
  MaxResults?: number | undefined;
@@ -1290,8 +1389,8 @@ export interface DescribeEventsRequest {
1290
1389
  }
1291
1390
  /**
1292
1391
  * <p>Represents a single occurrence of something interesting within the system. Some
1293
- * examples of events are creating a DAX cluster, adding or removing a node, or rebooting
1294
- * a node.</p>
1392
+ * examples of events are creating a DAX cluster, adding or removing a node, or rebooting a
1393
+ * node.</p>
1295
1394
  * @public
1296
1395
  */
1297
1396
  export interface Event {
@@ -1328,7 +1427,7 @@ export interface DescribeEventsResponse {
1328
1427
  */
1329
1428
  NextToken?: string | undefined;
1330
1429
  /**
1331
- * <p>An array of events. Each element in the array represents one event.</p>
1430
+ * <p>An array of events. Each element in the array represents one event.</p>
1332
1431
  * @public
1333
1432
  */
1334
1433
  Events?: Event[] | undefined;
@@ -1346,7 +1445,7 @@ export interface DescribeParameterGroupsRequest {
1346
1445
  * <p>The maximum number of results to include in the response. If more results exist
1347
1446
  * than the specified <code>MaxResults</code> value, a token is included in the response so
1348
1447
  * that the remaining results can be retrieved.</p>
1349
- * <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>
1448
+ * <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>
1350
1449
  * @public
1351
1450
  */
1352
1451
  MaxResults?: number | undefined;
@@ -1369,7 +1468,8 @@ export interface DescribeParameterGroupsResponse {
1369
1468
  */
1370
1469
  NextToken?: string | undefined;
1371
1470
  /**
1372
- * <p>An array of parameter groups. Each element in the array represents one parameter group.</p>
1471
+ * <p>An array of parameter groups. Each element in the array represents one parameter
1472
+ * group.</p>
1373
1473
  * @public
1374
1474
  */
1375
1475
  ParameterGroups?: ParameterGroup[] | undefined;
@@ -1393,7 +1493,7 @@ export interface DescribeParametersRequest {
1393
1493
  * <p>The maximum number of results to include in the response. If more results exist
1394
1494
  * than the specified <code>MaxResults</code> value, a token is included in the response so
1395
1495
  * that the remaining results can be retrieved.</p>
1396
- * <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>
1496
+ * <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>
1397
1497
  * @public
1398
1498
  */
1399
1499
  MaxResults?: number | undefined;
@@ -1416,7 +1516,8 @@ export interface DescribeParametersResponse {
1416
1516
  */
1417
1517
  NextToken?: string | undefined;
1418
1518
  /**
1419
- * <p>A list of parameters within a parameter group. Each element in the list represents one parameter.</p>
1519
+ * <p>A list of parameters within a parameter group. Each element in the list represents
1520
+ * one parameter.</p>
1420
1521
  * @public
1421
1522
  */
1422
1523
  Parameters?: Parameter[] | undefined;
@@ -1434,7 +1535,7 @@ export interface DescribeSubnetGroupsRequest {
1434
1535
  * <p>The maximum number of results to include in the response. If more results exist
1435
1536
  * than the specified <code>MaxResults</code> value, a token is included in the response so
1436
1537
  * that the remaining results can be retrieved.</p>
1437
- * <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>
1538
+ * <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>
1438
1539
  * @public
1439
1540
  */
1440
1541
  MaxResults?: number | undefined;
@@ -1457,7 +1558,8 @@ export interface DescribeSubnetGroupsResponse {
1457
1558
  */
1458
1559
  NextToken?: string | undefined;
1459
1560
  /**
1460
- * <p>An array of subnet groups. Each element in the array represents a single subnet group.</p>
1561
+ * <p>An array of subnet groups. Each element in the array represents a single subnet
1562
+ * group.</p>
1461
1563
  * @public
1462
1564
  */
1463
1565
  SubnetGroups?: SubnetGroup[] | undefined;
@@ -1478,8 +1580,8 @@ export interface IncreaseReplicationFactorRequest {
1478
1580
  NewReplicationFactor: number | undefined;
1479
1581
  /**
1480
1582
  * <p>The Availability Zones (AZs) in which the cluster nodes will be created. All nodes
1481
- * belonging to the cluster are placed in these Availability Zones. Use this parameter if you want
1482
- * to distribute the nodes across multiple AZs.</p>
1583
+ * belonging to the cluster are placed in these Availability Zones. Use this parameter if
1584
+ * you want to distribute the nodes across multiple AZs.</p>
1483
1585
  * @public
1484
1586
  */
1485
1587
  AvailabilityZones?: string[] | undefined;
@@ -1489,7 +1591,8 @@ export interface IncreaseReplicationFactorRequest {
1489
1591
  */
1490
1592
  export interface IncreaseReplicationFactorResponse {
1491
1593
  /**
1492
- * <p>A description of the DAX cluster. with its new replication factor.</p>
1594
+ * <p>A description of the DAX cluster, with its new replication
1595
+ * factor.</p>
1493
1596
  * @public
1494
1597
  */
1495
1598
  Cluster?: Cluster | undefined;
@@ -1533,8 +1636,9 @@ export interface ListTagsResponse {
1533
1636
  */
1534
1637
  Tags?: Tag[] | undefined;
1535
1638
  /**
1536
- * <p>If this value is present, there are additional results to be displayed. To retrieve them, call
1537
- * <code>ListTags</code> again, with <code>NextToken</code> set to this value.</p>
1639
+ * <p>If this value is present, there are additional results to be displayed. To retrieve
1640
+ * them, call <code>ListTags</code> again, with <code>NextToken</code> set to this
1641
+ * value.</p>
1538
1642
  * @public
1539
1643
  */
1540
1644
  NextToken?: string | undefined;
@@ -1544,7 +1648,8 @@ export interface ListTagsResponse {
1544
1648
  */
1545
1649
  export interface RebootNodeRequest {
1546
1650
  /**
1547
- * <p>The name of the DAX cluster containing the node to be rebooted.</p>
1651
+ * <p>The name of the DAX cluster containing the node to be
1652
+ * rebooted.</p>
1548
1653
  * @public
1549
1654
  */
1550
1655
  ClusterName: string | undefined;
@@ -1559,7 +1664,8 @@ export interface RebootNodeRequest {
1559
1664
  */
1560
1665
  export interface RebootNodeResponse {
1561
1666
  /**
1562
- * <p>A description of the DAX cluster after a node has been rebooted.</p>
1667
+ * <p>A description of the DAX cluster after a node has been
1668
+ * rebooted.</p>
1563
1669
  * @public
1564
1670
  */
1565
1671
  Cluster?: Cluster | undefined;
@@ -1569,7 +1675,8 @@ export interface RebootNodeResponse {
1569
1675
  */
1570
1676
  export interface TagResourceRequest {
1571
1677
  /**
1572
- * <p>The name of the DAX resource to which tags should be added.</p>
1678
+ * <p>The name of the DAX resource to which tags should be
1679
+ * added.</p>
1573
1680
  * @public
1574
1681
  */
1575
1682
  ResourceName: string | undefined;
@@ -1606,12 +1713,14 @@ export declare class TagNotFoundFault extends __BaseException {
1606
1713
  */
1607
1714
  export interface UntagResourceRequest {
1608
1715
  /**
1609
- * <p>The name of the DAX resource from which the tags should be removed.</p>
1716
+ * <p>The name of the DAX resource from which the tags should be
1717
+ * removed.</p>
1610
1718
  * @public
1611
1719
  */
1612
1720
  ResourceName: string | undefined;
1613
1721
  /**
1614
- * <p>A list of tag keys. If the DAX cluster has any tags with these keys, then the tags are removed from the cluster.</p>
1722
+ * <p>A list of tag keys. If the DAX cluster has any tags with these keys,
1723
+ * then the tags are removed from the cluster.</p>
1615
1724
  * @public
1616
1725
  */
1617
1726
  TagKeys: string[] | undefined;
@@ -1654,8 +1763,8 @@ export interface UpdateClusterRequest {
1654
1763
  NotificationTopicArn?: string | undefined;
1655
1764
  /**
1656
1765
  * <p>The current state of the topic. A value of “active” means that notifications will
1657
- * be sent to the topic. A value of “inactive” means that notifications will not be sent to the
1658
- * topic.</p>
1766
+ * be sent to the topic. A value of “inactive” means that notifications will not be sent to
1767
+ * the topic.</p>
1659
1768
  * @public
1660
1769
  */
1661
1770
  NotificationTopicStatus?: string | undefined;
@@ -1665,8 +1774,9 @@ export interface UpdateClusterRequest {
1665
1774
  */
1666
1775
  ParameterGroupName?: string | undefined;
1667
1776
  /**
1668
- * <p>A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this parameter is not
1669
- * specified, DAX assigns the default VPC security group to each node.</p>
1777
+ * <p>A list of user-specified security group IDs to be assigned to each node in the DAX
1778
+ * cluster. If this parameter is not specified, DAX assigns the default VPC security group
1779
+ * to each node.</p>
1670
1780
  * @public
1671
1781
  */
1672
1782
  SecurityGroupIds?: string[] | undefined;
@@ -1709,10 +1819,11 @@ export interface UpdateParameterGroupRequest {
1709
1819
  /**
1710
1820
  * <p>An array of name-value pairs for the parameters in the group. Each element in the
1711
1821
  * array represents a single parameter.</p>
1712
- * <note>
1822
+ * <note>
1713
1823
  * <p>
1714
- * <code>record-ttl-millis</code> and <code>query-ttl-millis</code> are the only supported parameter names. For more details, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings.ttl">Configuring TTL Settings</a>.</p>
1715
- * </note>
1824
+ * <code>record-ttl-millis</code> and <code>query-ttl-millis</code> are the only
1825
+ * supported parameter names. For more details, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings.ttl">Configuring TTL Settings</a>.</p>
1826
+ * </note>
1716
1827
  * @public
1717
1828
  */
1718
1829
  ParameterNameValues: ParameterNameValue[] | undefined;