@aws-sdk/client-dax 3.379.1 → 3.385.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.
@@ -43,6 +43,7 @@ export type ClusterEndpointEncryptionType = (typeof ClusterEndpointEncryptionTyp
43
43
  */
44
44
  export interface SSESpecification {
45
45
  /**
46
+ * @public
46
47
  * <p>Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.</p>
47
48
  */
48
49
  Enabled: boolean | undefined;
@@ -58,12 +59,14 @@ export interface SSESpecification {
58
59
  */
59
60
  export interface Tag {
60
61
  /**
62
+ * @public
61
63
  * <p>The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have
62
64
  * one tag with the same key. If you try to add an existing tag (same key), the
63
65
  * existing tag value will be updated to the new value.</p>
64
66
  */
65
67
  Key?: string;
66
68
  /**
69
+ * @public
67
70
  * <p>The value of the tag. Tag values are case-sensitive and can be null. </p>
68
71
  */
69
72
  Value?: string;
@@ -73,6 +76,7 @@ export interface Tag {
73
76
  */
74
77
  export interface CreateClusterRequest {
75
78
  /**
79
+ * @public
76
80
  * <p>The cluster identifier. This parameter is stored as a lowercase
77
81
  * string.</p>
78
82
  * <p>
@@ -94,14 +98,17 @@ export interface CreateClusterRequest {
94
98
  */
95
99
  ClusterName: string | undefined;
96
100
  /**
101
+ * @public
97
102
  * <p>The compute and memory capacity of the nodes in the cluster.</p>
98
103
  */
99
104
  NodeType: string | undefined;
100
105
  /**
106
+ * @public
101
107
  * <p>A description of the cluster.</p>
102
108
  */
103
109
  Description?: string;
104
110
  /**
111
+ * @public
105
112
  * <p>The number of nodes in the DAX cluster. A replication factor of 1 will
106
113
  * create a single-node cluster, without any read replicas. For additional fault tolerance,
107
114
  * you can create a multiple node cluster with one or more read replicas. To do this, set
@@ -113,12 +120,14 @@ export interface CreateClusterRequest {
113
120
  */
114
121
  ReplicationFactor: number | undefined;
115
122
  /**
123
+ * @public
116
124
  * <p>The Availability Zones (AZs) in which the cluster nodes will reside after the cluster
117
125
  * has been created or updated. If provided, the length of this list must equal the <code>ReplicationFactor</code> parameter.
118
126
  * If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.</p>
119
127
  */
120
128
  AvailabilityZones?: string[];
121
129
  /**
130
+ * @public
122
131
  * <p>The name of the subnet group to be used for the replication group.</p>
123
132
  * <important>
124
133
  * <p>DAX clusters can only run in an Amazon VPC environment. All of the subnets
@@ -127,6 +136,7 @@ export interface CreateClusterRequest {
127
136
  */
128
137
  SubnetGroupName?: string;
129
138
  /**
139
+ * @public
130
140
  * <p>A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the
131
141
  * security group ID is system-generated.)</p>
132
142
  * <p>If this parameter is not specified, DAX assigns the default VPC security group to
@@ -134,6 +144,7 @@ export interface CreateClusterRequest {
134
144
  */
135
145
  SecurityGroupIds?: string[];
136
146
  /**
147
+ * @public
137
148
  * <p>Specifies the weekly time range during which maintenance on the DAX cluster is
138
149
  * performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock
139
150
  * UTC). The minimum maintenance window is a 60 minute period. Valid values for
@@ -185,6 +196,7 @@ export interface CreateClusterRequest {
185
196
  */
186
197
  PreferredMaintenanceWindow?: string;
187
198
  /**
199
+ * @public
188
200
  * <p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will
189
201
  * be sent.</p>
190
202
  * <note>
@@ -193,24 +205,29 @@ export interface CreateClusterRequest {
193
205
  */
194
206
  NotificationTopicArn?: string;
195
207
  /**
208
+ * @public
196
209
  * <p>A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX
197
210
  * will assume this role and use the role's permissions to access DynamoDB on your
198
211
  * behalf.</p>
199
212
  */
200
213
  IamRoleArn: string | undefined;
201
214
  /**
215
+ * @public
202
216
  * <p>The parameter group to be associated with the DAX cluster.</p>
203
217
  */
204
218
  ParameterGroupName?: string;
205
219
  /**
220
+ * @public
206
221
  * <p>A set of tags to associate with the DAX cluster. </p>
207
222
  */
208
223
  Tags?: Tag[];
209
224
  /**
225
+ * @public
210
226
  * <p>Represents the settings used to enable server-side encryption on the cluster.</p>
211
227
  */
212
228
  SSESpecification?: SSESpecification;
213
229
  /**
230
+ * @public
214
231
  * <p>The type of encryption the cluster's endpoint should support. Values are:</p>
215
232
  * <ul>
216
233
  * <li>
@@ -232,14 +249,17 @@ export interface CreateClusterRequest {
232
249
  */
233
250
  export interface Endpoint {
234
251
  /**
252
+ * @public
235
253
  * <p>The DNS hostname of the endpoint.</p>
236
254
  */
237
255
  Address?: string;
238
256
  /**
257
+ * @public
239
258
  * <p>The port number that applications should use to connect to the endpoint.</p>
240
259
  */
241
260
  Port?: number;
242
261
  /**
262
+ * @public
243
263
  * <p>The URL that applications should use to connect to the endpoint. The default
244
264
  * ports are 8111 for the "dax" protocol and 9111 for the "daxs" protocol.</p>
245
265
  */
@@ -251,10 +271,12 @@ export interface Endpoint {
251
271
  */
252
272
  export interface Node {
253
273
  /**
274
+ * @public
254
275
  * <p>A system-generated identifier for the node.</p>
255
276
  */
256
277
  NodeId?: string;
257
278
  /**
279
+ * @public
258
280
  * <p>The endpoint for the node, consisting of a DNS name and a port number. Client
259
281
  * applications can connect directly to a node endpoint, if desired (as an alternative to
260
282
  * allowing DAX client software to intelligently route requests and responses to nodes in
@@ -262,18 +284,22 @@ export interface Node {
262
284
  */
263
285
  Endpoint?: Endpoint;
264
286
  /**
287
+ * @public
265
288
  * <p>The date and time (in UNIX epoch format) when the node was launched.</p>
266
289
  */
267
290
  NodeCreateTime?: Date;
268
291
  /**
292
+ * @public
269
293
  * <p>The Availability Zone (AZ) in which the node has been deployed.</p>
270
294
  */
271
295
  AvailabilityZone?: string;
272
296
  /**
297
+ * @public
273
298
  * <p>The current status of the node. For example: <code>available</code>.</p>
274
299
  */
275
300
  NodeStatus?: string;
276
301
  /**
302
+ * @public
277
303
  * <p>The status of the parameter group associated with this node. For example,
278
304
  * <code>in-sync</code>.</p>
279
305
  */
@@ -287,10 +313,12 @@ export interface Node {
287
313
  */
288
314
  export interface NotificationConfiguration {
289
315
  /**
316
+ * @public
290
317
  * <p>The Amazon Resource Name (ARN) that identifies the topic. </p>
291
318
  */
292
319
  TopicArn?: string;
293
320
  /**
321
+ * @public
294
322
  * <p>The current state of the topic. A value of “active” means that notifications will
295
323
  * be sent to the topic. A value of “inactive” means that notifications will not be sent to the
296
324
  * topic.</p>
@@ -303,14 +331,17 @@ export interface NotificationConfiguration {
303
331
  */
304
332
  export interface ParameterGroupStatus {
305
333
  /**
334
+ * @public
306
335
  * <p>The name of the parameter group.</p>
307
336
  */
308
337
  ParameterGroupName?: string;
309
338
  /**
339
+ * @public
310
340
  * <p>The status of parameter updates. </p>
311
341
  */
312
342
  ParameterApplyStatus?: string;
313
343
  /**
344
+ * @public
314
345
  * <p>The node IDs of one or more nodes to be rebooted.</p>
315
346
  */
316
347
  NodeIdsToReboot?: string[];
@@ -321,10 +352,12 @@ export interface ParameterGroupStatus {
321
352
  */
322
353
  export interface SecurityGroupMembership {
323
354
  /**
355
+ * @public
324
356
  * <p>The unique ID for this security group.</p>
325
357
  */
326
358
  SecurityGroupIdentifier?: string;
327
359
  /**
360
+ * @public
328
361
  * <p>The status of this security group.</p>
329
362
  */
330
363
  Status?: string;
@@ -339,6 +372,7 @@ export type SSEStatus = "DISABLED" | "DISABLING" | "ENABLED" | "ENABLING";
339
372
  */
340
373
  export interface SSEDescription {
341
374
  /**
375
+ * @public
342
376
  * <p>The current state of server-side encryption:</p>
343
377
  * <ul>
344
378
  * <li>
@@ -367,85 +401,103 @@ export interface SSEDescription {
367
401
  */
368
402
  export interface Cluster {
369
403
  /**
404
+ * @public
370
405
  * <p>The name of the DAX cluster.</p>
371
406
  */
372
407
  ClusterName?: string;
373
408
  /**
409
+ * @public
374
410
  * <p>The description of the cluster.</p>
375
411
  */
376
412
  Description?: string;
377
413
  /**
414
+ * @public
378
415
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.
379
416
  * </p>
380
417
  */
381
418
  ClusterArn?: string;
382
419
  /**
420
+ * @public
383
421
  * <p>The total number of nodes in the cluster.</p>
384
422
  */
385
423
  TotalNodes?: number;
386
424
  /**
425
+ * @public
387
426
  * <p>The number of nodes in the cluster that are active (i.e., capable of serving
388
427
  * requests).</p>
389
428
  */
390
429
  ActiveNodes?: number;
391
430
  /**
431
+ * @public
392
432
  * <p>The node type for the nodes in the cluster. (All nodes in a DAX cluster are of
393
433
  * the same type.)</p>
394
434
  */
395
435
  NodeType?: string;
396
436
  /**
437
+ * @public
397
438
  * <p>The current status of the cluster.</p>
398
439
  */
399
440
  Status?: string;
400
441
  /**
442
+ * @public
401
443
  * <p>The endpoint for this DAX cluster, consisting of a DNS name, a port number,
402
444
  * and a URL. Applications should use the URL to configure the DAX client to find
403
445
  * their cluster.</p>
404
446
  */
405
447
  ClusterDiscoveryEndpoint?: Endpoint;
406
448
  /**
449
+ * @public
407
450
  * <p>A list of nodes to be removed from the cluster.</p>
408
451
  */
409
452
  NodeIdsToRemove?: string[];
410
453
  /**
454
+ * @public
411
455
  * <p>A list of nodes that are currently in the cluster.</p>
412
456
  */
413
457
  Nodes?: Node[];
414
458
  /**
459
+ * @public
415
460
  * <p>A range of time when maintenance of DAX cluster software will be performed. For
416
461
  * example: <code>sun:01:00-sun:09:00</code>. Cluster maintenance normally takes less than
417
462
  * 30 minutes, and is performed automatically within the maintenance window.</p>
418
463
  */
419
464
  PreferredMaintenanceWindow?: string;
420
465
  /**
466
+ * @public
421
467
  * <p>Describes a notification topic and its status. Notification topics are used for
422
468
  * publishing DAX events to subscribers using Amazon Simple Notification Service
423
469
  * (SNS).</p>
424
470
  */
425
471
  NotificationConfiguration?: NotificationConfiguration;
426
472
  /**
473
+ * @public
427
474
  * <p>The subnet group where the DAX cluster is running.</p>
428
475
  */
429
476
  SubnetGroup?: string;
430
477
  /**
478
+ * @public
431
479
  * <p>A list of security groups, and the status of each, for the nodes in the cluster.</p>
432
480
  */
433
481
  SecurityGroups?: SecurityGroupMembership[];
434
482
  /**
483
+ * @public
435
484
  * <p>A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX
436
485
  * will assume this role and use the role's permissions to access DynamoDB on your
437
486
  * behalf.</p>
438
487
  */
439
488
  IamRoleArn?: string;
440
489
  /**
490
+ * @public
441
491
  * <p>The parameter group being used by nodes in the cluster.</p>
442
492
  */
443
493
  ParameterGroup?: ParameterGroupStatus;
444
494
  /**
495
+ * @public
445
496
  * <p>The description of the server-side encryption status on the specified DAX cluster.</p>
446
497
  */
447
498
  SSEDescription?: SSEDescription;
448
499
  /**
500
+ * @public
449
501
  * <p>The type of encryption supported by the cluster's endpoint. Values are:</p>
450
502
  * <ul>
451
503
  * <li>
@@ -463,6 +515,7 @@ export interface Cluster {
463
515
  */
464
516
  export interface CreateClusterResponse {
465
517
  /**
518
+ * @public
466
519
  * <p>A description of the DAX cluster that you have created.</p>
467
520
  */
468
521
  Cluster?: Cluster;
@@ -635,11 +688,13 @@ export declare class TagQuotaPerResourceExceeded extends __BaseException {
635
688
  */
636
689
  export interface CreateParameterGroupRequest {
637
690
  /**
691
+ * @public
638
692
  * <p>The name of the parameter group to apply to all of the clusters in this replication
639
693
  * group.</p>
640
694
  */
641
695
  ParameterGroupName: string | undefined;
642
696
  /**
697
+ * @public
643
698
  * <p>A description of the parameter group.</p>
644
699
  */
645
700
  Description?: string;
@@ -651,10 +706,12 @@ export interface CreateParameterGroupRequest {
651
706
  */
652
707
  export interface ParameterGroup {
653
708
  /**
709
+ * @public
654
710
  * <p>The name of the parameter group.</p>
655
711
  */
656
712
  ParameterGroupName?: string;
657
713
  /**
714
+ * @public
658
715
  * <p>A description of the parameter group.</p>
659
716
  */
660
717
  Description?: string;
@@ -664,6 +721,7 @@ export interface ParameterGroup {
664
721
  */
665
722
  export interface CreateParameterGroupResponse {
666
723
  /**
724
+ * @public
667
725
  * <p>Represents the output of a <i>CreateParameterGroup</i>
668
726
  * action.</p>
669
727
  */
@@ -698,14 +756,17 @@ export declare class ParameterGroupQuotaExceededFault extends __BaseException {
698
756
  */
699
757
  export interface CreateSubnetGroupRequest {
700
758
  /**
759
+ * @public
701
760
  * <p>A name for the subnet group. This value is stored as a lowercase string. </p>
702
761
  */
703
762
  SubnetGroupName: string | undefined;
704
763
  /**
764
+ * @public
705
765
  * <p>A description for the subnet group</p>
706
766
  */
707
767
  Description?: string;
708
768
  /**
769
+ * @public
709
770
  * <p>A list of VPC subnet IDs for the subnet group.</p>
710
771
  */
711
772
  SubnetIds: string[] | undefined;
@@ -718,10 +779,12 @@ export interface CreateSubnetGroupRequest {
718
779
  */
719
780
  export interface Subnet {
720
781
  /**
782
+ * @public
721
783
  * <p>The system-assigned identifier for the subnet.</p>
722
784
  */
723
785
  SubnetIdentifier?: string;
724
786
  /**
787
+ * @public
725
788
  * <p>The Availability Zone (AZ) for the subnet.</p>
726
789
  */
727
790
  SubnetAvailabilityZone?: string;
@@ -744,18 +807,22 @@ export interface Subnet {
744
807
  */
745
808
  export interface SubnetGroup {
746
809
  /**
810
+ * @public
747
811
  * <p>The name of the subnet group.</p>
748
812
  */
749
813
  SubnetGroupName?: string;
750
814
  /**
815
+ * @public
751
816
  * <p>The description of the subnet group.</p>
752
817
  */
753
818
  Description?: string;
754
819
  /**
820
+ * @public
755
821
  * <p>The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.</p>
756
822
  */
757
823
  VpcId?: string;
758
824
  /**
825
+ * @public
759
826
  * <p>A list of subnets associated with the subnet group. </p>
760
827
  */
761
828
  Subnets?: Subnet[];
@@ -765,6 +832,7 @@ export interface SubnetGroup {
765
832
  */
766
833
  export interface CreateSubnetGroupResponse {
767
834
  /**
835
+ * @public
768
836
  * <p>Represents the output of a <i>CreateSubnetGroup</i>
769
837
  * operation.</p>
770
838
  */
@@ -837,18 +905,22 @@ export declare class ClusterNotFoundFault extends __BaseException {
837
905
  */
838
906
  export interface DecreaseReplicationFactorRequest {
839
907
  /**
908
+ * @public
840
909
  * <p>The name of the DAX cluster from which you want to remove nodes.</p>
841
910
  */
842
911
  ClusterName: string | undefined;
843
912
  /**
913
+ * @public
844
914
  * <p>The new number of nodes for the DAX cluster.</p>
845
915
  */
846
916
  NewReplicationFactor: number | undefined;
847
917
  /**
918
+ * @public
848
919
  * <p>The Availability Zone(s) from which to remove nodes.</p>
849
920
  */
850
921
  AvailabilityZones?: string[];
851
922
  /**
923
+ * @public
852
924
  * <p>The unique identifiers of the nodes to be removed from the cluster.</p>
853
925
  */
854
926
  NodeIdsToRemove?: string[];
@@ -858,6 +930,7 @@ export interface DecreaseReplicationFactorRequest {
858
930
  */
859
931
  export interface DecreaseReplicationFactorResponse {
860
932
  /**
933
+ * @public
861
934
  * <p>A description of the DAX cluster, after you have decreased its replication
862
935
  * factor.</p>
863
936
  */
@@ -880,6 +953,7 @@ export declare class NodeNotFoundFault extends __BaseException {
880
953
  */
881
954
  export interface DeleteClusterRequest {
882
955
  /**
956
+ * @public
883
957
  * <p>The name of the cluster to be deleted.</p>
884
958
  */
885
959
  ClusterName: string | undefined;
@@ -889,6 +963,7 @@ export interface DeleteClusterRequest {
889
963
  */
890
964
  export interface DeleteClusterResponse {
891
965
  /**
966
+ * @public
892
967
  * <p>A description of the DAX cluster that is being deleted.</p>
893
968
  */
894
969
  Cluster?: Cluster;
@@ -898,6 +973,7 @@ export interface DeleteClusterResponse {
898
973
  */
899
974
  export interface DeleteParameterGroupRequest {
900
975
  /**
976
+ * @public
901
977
  * <p>The name of the parameter group to delete.</p>
902
978
  */
903
979
  ParameterGroupName: string | undefined;
@@ -907,6 +983,7 @@ export interface DeleteParameterGroupRequest {
907
983
  */
908
984
  export interface DeleteParameterGroupResponse {
909
985
  /**
986
+ * @public
910
987
  * <p>A user-specified message for this action (i.e., a reason for deleting the parameter
911
988
  * group).</p>
912
989
  */
@@ -917,6 +994,7 @@ export interface DeleteParameterGroupResponse {
917
994
  */
918
995
  export interface DeleteSubnetGroupRequest {
919
996
  /**
997
+ * @public
920
998
  * <p>The name of the subnet group to delete.</p>
921
999
  */
922
1000
  SubnetGroupName: string | undefined;
@@ -926,6 +1004,7 @@ export interface DeleteSubnetGroupRequest {
926
1004
  */
927
1005
  export interface DeleteSubnetGroupResponse {
928
1006
  /**
1007
+ * @public
929
1008
  * <p>A user-specified message for this action (i.e., a reason for deleting the subnet
930
1009
  * group).</p>
931
1010
  */
@@ -948,10 +1027,12 @@ export declare class SubnetGroupInUseFault extends __BaseException {
948
1027
  */
949
1028
  export interface DescribeClustersRequest {
950
1029
  /**
1030
+ * @public
951
1031
  * <p>The names of the DAX clusters being described.</p>
952
1032
  */
953
1033
  ClusterNames?: string[];
954
1034
  /**
1035
+ * @public
955
1036
  * <p>The maximum number of results to include in the response. If more results exist
956
1037
  * than the specified <code>MaxResults</code> value, a token is included in the response so
957
1038
  * that the remaining results can be retrieved.</p>
@@ -959,6 +1040,7 @@ export interface DescribeClustersRequest {
959
1040
  */
960
1041
  MaxResults?: number;
961
1042
  /**
1043
+ * @public
962
1044
  * <p>An optional token returned from a prior request. Use this token for pagination of
963
1045
  * results from this action. If this parameter is specified, the response includes only
964
1046
  * results beyond the token, up to the value specified by
@@ -971,10 +1053,12 @@ export interface DescribeClustersRequest {
971
1053
  */
972
1054
  export interface DescribeClustersResponse {
973
1055
  /**
1056
+ * @public
974
1057
  * <p>Provides an identifier to allow retrieval of paginated results.</p>
975
1058
  */
976
1059
  NextToken?: string;
977
1060
  /**
1061
+ * @public
978
1062
  * <p>The descriptions of your DAX clusters, in response to a
979
1063
  * <i>DescribeClusters</i> request.</p>
980
1064
  */
@@ -985,6 +1069,7 @@ export interface DescribeClustersResponse {
985
1069
  */
986
1070
  export interface DescribeDefaultParametersRequest {
987
1071
  /**
1072
+ * @public
988
1073
  * <p>The maximum number of results to include in the response. If more results exist
989
1074
  * than the specified <code>MaxResults</code> value, a token is included in the response so
990
1075
  * that the remaining results can be retrieved.</p>
@@ -992,6 +1077,7 @@ export interface DescribeDefaultParametersRequest {
992
1077
  */
993
1078
  MaxResults?: number;
994
1079
  /**
1080
+ * @public
995
1081
  * <p>An optional token returned from a prior request. Use this token for pagination of
996
1082
  * results from this action. If this parameter is specified, the response includes only
997
1083
  * results beyond the token, up to the value specified by
@@ -1014,10 +1100,12 @@ export type IsModifiable = "CONDITIONAL" | "FALSE" | "TRUE";
1014
1100
  */
1015
1101
  export interface NodeTypeSpecificValue {
1016
1102
  /**
1103
+ * @public
1017
1104
  * <p>A node type to which the parameter value applies.</p>
1018
1105
  */
1019
1106
  NodeType?: string;
1020
1107
  /**
1108
+ * @public
1021
1109
  * <p>The parameter value for this node type.</p>
1022
1110
  */
1023
1111
  Value?: string;
@@ -1033,44 +1121,54 @@ export type ParameterType = "DEFAULT" | "NODE_TYPE_SPECIFIC";
1033
1121
  */
1034
1122
  export interface Parameter {
1035
1123
  /**
1124
+ * @public
1036
1125
  * <p>The name of the parameter.</p>
1037
1126
  */
1038
1127
  ParameterName?: string;
1039
1128
  /**
1129
+ * @public
1040
1130
  * <p>Determines whether the parameter can be applied to any nodes, or only nodes of a
1041
1131
  * particular type.</p>
1042
1132
  */
1043
1133
  ParameterType?: ParameterType | string;
1044
1134
  /**
1135
+ * @public
1045
1136
  * <p>The value for the parameter.</p>
1046
1137
  */
1047
1138
  ParameterValue?: string;
1048
1139
  /**
1140
+ * @public
1049
1141
  * <p>A list of node types, and specific parameter values for each node.</p>
1050
1142
  */
1051
1143
  NodeTypeSpecificValues?: NodeTypeSpecificValue[];
1052
1144
  /**
1145
+ * @public
1053
1146
  * <p>A description of the parameter</p>
1054
1147
  */
1055
1148
  Description?: string;
1056
1149
  /**
1150
+ * @public
1057
1151
  * <p>How the parameter is defined. For example, <code>system</code> denotes a
1058
1152
  * system-defined parameter.</p>
1059
1153
  */
1060
1154
  Source?: string;
1061
1155
  /**
1156
+ * @public
1062
1157
  * <p>The data type of the parameter. For example, <code>integer</code>:</p>
1063
1158
  */
1064
1159
  DataType?: string;
1065
1160
  /**
1161
+ * @public
1066
1162
  * <p>A range of values within which the parameter can be set.</p>
1067
1163
  */
1068
1164
  AllowedValues?: string;
1069
1165
  /**
1166
+ * @public
1070
1167
  * <p>Whether the customer is allowed to modify the parameter.</p>
1071
1168
  */
1072
1169
  IsModifiable?: IsModifiable | string;
1073
1170
  /**
1171
+ * @public
1074
1172
  * <p>The conditions under which changes to this parameter can be applied. For example,
1075
1173
  * <code>requires-reboot</code> indicates that a new value for this parameter will only
1076
1174
  * take effect if a node is rebooted.</p>
@@ -1082,10 +1180,12 @@ export interface Parameter {
1082
1180
  */
1083
1181
  export interface DescribeDefaultParametersResponse {
1084
1182
  /**
1183
+ * @public
1085
1184
  * <p>Provides an identifier to allow retrieval of paginated results.</p>
1086
1185
  */
1087
1186
  NextToken?: string;
1088
1187
  /**
1188
+ * @public
1089
1189
  * <p>A list of parameters. Each element in the list represents one parameter.</p>
1090
1190
  */
1091
1191
  Parameters?: Parameter[];
@@ -1099,30 +1199,36 @@ export type SourceType = "CLUSTER" | "PARAMETER_GROUP" | "SUBNET_GROUP";
1099
1199
  */
1100
1200
  export interface DescribeEventsRequest {
1101
1201
  /**
1202
+ * @public
1102
1203
  * <p>The identifier of the event source for which events will be returned. If not
1103
1204
  * specified, then all sources are included in the response.</p>
1104
1205
  */
1105
1206
  SourceName?: string;
1106
1207
  /**
1208
+ * @public
1107
1209
  * <p>The event source to retrieve events for. If no value is specified, all events are
1108
1210
  * returned.</p>
1109
1211
  */
1110
1212
  SourceType?: SourceType | string;
1111
1213
  /**
1214
+ * @public
1112
1215
  * <p>The beginning of the time interval to retrieve events for, specified in ISO 8601
1113
1216
  * format.</p>
1114
1217
  */
1115
1218
  StartTime?: Date;
1116
1219
  /**
1220
+ * @public
1117
1221
  * <p>The end of the time interval for which to retrieve events, specified in ISO 8601
1118
1222
  * format.</p>
1119
1223
  */
1120
1224
  EndTime?: Date;
1121
1225
  /**
1226
+ * @public
1122
1227
  * <p>The number of minutes' worth of events to retrieve.</p>
1123
1228
  */
1124
1229
  Duration?: number;
1125
1230
  /**
1231
+ * @public
1126
1232
  * <p>The maximum number of results to include in the response. If more results exist
1127
1233
  * than the specified <code>MaxResults</code> value, a token is included in the response so
1128
1234
  * that the remaining results can be retrieved.</p>
@@ -1130,6 +1236,7 @@ export interface DescribeEventsRequest {
1130
1236
  */
1131
1237
  MaxResults?: number;
1132
1238
  /**
1239
+ * @public
1133
1240
  * <p>An optional token returned from a prior request. Use this token for pagination of
1134
1241
  * results from this action. If this parameter is specified, the response includes only
1135
1242
  * results beyond the token, up to the value specified by
@@ -1145,20 +1252,24 @@ export interface DescribeEventsRequest {
1145
1252
  */
1146
1253
  export interface Event {
1147
1254
  /**
1255
+ * @public
1148
1256
  * <p>The source of the event. For example, if the event occurred at the node level, the
1149
1257
  * source would be the node ID.</p>
1150
1258
  */
1151
1259
  SourceName?: string;
1152
1260
  /**
1261
+ * @public
1153
1262
  * <p>Specifies the origin of this event - a cluster, a parameter group, a node ID,
1154
1263
  * etc.</p>
1155
1264
  */
1156
1265
  SourceType?: SourceType | string;
1157
1266
  /**
1267
+ * @public
1158
1268
  * <p>A user-defined message associated with the event.</p>
1159
1269
  */
1160
1270
  Message?: string;
1161
1271
  /**
1272
+ * @public
1162
1273
  * <p>The date and time when the event occurred.</p>
1163
1274
  */
1164
1275
  Date?: Date;
@@ -1168,10 +1279,12 @@ export interface Event {
1168
1279
  */
1169
1280
  export interface DescribeEventsResponse {
1170
1281
  /**
1282
+ * @public
1171
1283
  * <p>Provides an identifier to allow retrieval of paginated results.</p>
1172
1284
  */
1173
1285
  NextToken?: string;
1174
1286
  /**
1287
+ * @public
1175
1288
  * <p>An array of events. Each element in the array represents one event.</p>
1176
1289
  */
1177
1290
  Events?: Event[];
@@ -1181,10 +1294,12 @@ export interface DescribeEventsResponse {
1181
1294
  */
1182
1295
  export interface DescribeParameterGroupsRequest {
1183
1296
  /**
1297
+ * @public
1184
1298
  * <p>The names of the parameter groups.</p>
1185
1299
  */
1186
1300
  ParameterGroupNames?: string[];
1187
1301
  /**
1302
+ * @public
1188
1303
  * <p>The maximum number of results to include in the response. If more results exist
1189
1304
  * than the specified <code>MaxResults</code> value, a token is included in the response so
1190
1305
  * that the remaining results can be retrieved.</p>
@@ -1192,6 +1307,7 @@ export interface DescribeParameterGroupsRequest {
1192
1307
  */
1193
1308
  MaxResults?: number;
1194
1309
  /**
1310
+ * @public
1195
1311
  * <p>An optional token returned from a prior request. Use this token for pagination of
1196
1312
  * results from this action. If this parameter is specified, the response includes only
1197
1313
  * results beyond the token, up to the value specified by
@@ -1204,10 +1320,12 @@ export interface DescribeParameterGroupsRequest {
1204
1320
  */
1205
1321
  export interface DescribeParameterGroupsResponse {
1206
1322
  /**
1323
+ * @public
1207
1324
  * <p>Provides an identifier to allow retrieval of paginated results.</p>
1208
1325
  */
1209
1326
  NextToken?: string;
1210
1327
  /**
1328
+ * @public
1211
1329
  * <p>An array of parameter groups. Each element in the array represents one parameter group.</p>
1212
1330
  */
1213
1331
  ParameterGroups?: ParameterGroup[];
@@ -1217,15 +1335,18 @@ export interface DescribeParameterGroupsResponse {
1217
1335
  */
1218
1336
  export interface DescribeParametersRequest {
1219
1337
  /**
1338
+ * @public
1220
1339
  * <p>The name of the parameter group.</p>
1221
1340
  */
1222
1341
  ParameterGroupName: string | undefined;
1223
1342
  /**
1343
+ * @public
1224
1344
  * <p>How the parameter is defined. For example, <code>system</code> denotes a
1225
1345
  * system-defined parameter.</p>
1226
1346
  */
1227
1347
  Source?: string;
1228
1348
  /**
1349
+ * @public
1229
1350
  * <p>The maximum number of results to include in the response. If more results exist
1230
1351
  * than the specified <code>MaxResults</code> value, a token is included in the response so
1231
1352
  * that the remaining results can be retrieved.</p>
@@ -1233,6 +1354,7 @@ export interface DescribeParametersRequest {
1233
1354
  */
1234
1355
  MaxResults?: number;
1235
1356
  /**
1357
+ * @public
1236
1358
  * <p>An optional token returned from a prior request. Use this token for pagination of
1237
1359
  * results from this action. If this parameter is specified, the response includes only
1238
1360
  * results beyond the token, up to the value specified by
@@ -1245,10 +1367,12 @@ export interface DescribeParametersRequest {
1245
1367
  */
1246
1368
  export interface DescribeParametersResponse {
1247
1369
  /**
1370
+ * @public
1248
1371
  * <p>Provides an identifier to allow retrieval of paginated results.</p>
1249
1372
  */
1250
1373
  NextToken?: string;
1251
1374
  /**
1375
+ * @public
1252
1376
  * <p>A list of parameters within a parameter group. Each element in the list represents one parameter.</p>
1253
1377
  */
1254
1378
  Parameters?: Parameter[];
@@ -1258,10 +1382,12 @@ export interface DescribeParametersResponse {
1258
1382
  */
1259
1383
  export interface DescribeSubnetGroupsRequest {
1260
1384
  /**
1385
+ * @public
1261
1386
  * <p>The name of the subnet group.</p>
1262
1387
  */
1263
1388
  SubnetGroupNames?: string[];
1264
1389
  /**
1390
+ * @public
1265
1391
  * <p>The maximum number of results to include in the response. If more results exist
1266
1392
  * than the specified <code>MaxResults</code> value, a token is included in the response so
1267
1393
  * that the remaining results can be retrieved.</p>
@@ -1269,6 +1395,7 @@ export interface DescribeSubnetGroupsRequest {
1269
1395
  */
1270
1396
  MaxResults?: number;
1271
1397
  /**
1398
+ * @public
1272
1399
  * <p>An optional token returned from a prior request. Use this token for pagination of
1273
1400
  * results from this action. If this parameter is specified, the response includes only
1274
1401
  * results beyond the token, up to the value specified by
@@ -1281,10 +1408,12 @@ export interface DescribeSubnetGroupsRequest {
1281
1408
  */
1282
1409
  export interface DescribeSubnetGroupsResponse {
1283
1410
  /**
1411
+ * @public
1284
1412
  * <p>Provides an identifier to allow retrieval of paginated results.</p>
1285
1413
  */
1286
1414
  NextToken?: string;
1287
1415
  /**
1416
+ * @public
1288
1417
  * <p>An array of subnet groups. Each element in the array represents a single subnet group.</p>
1289
1418
  */
1290
1419
  SubnetGroups?: SubnetGroup[];
@@ -1294,14 +1423,17 @@ export interface DescribeSubnetGroupsResponse {
1294
1423
  */
1295
1424
  export interface IncreaseReplicationFactorRequest {
1296
1425
  /**
1426
+ * @public
1297
1427
  * <p>The name of the DAX cluster that will receive additional nodes.</p>
1298
1428
  */
1299
1429
  ClusterName: string | undefined;
1300
1430
  /**
1431
+ * @public
1301
1432
  * <p>The new number of nodes for the DAX cluster.</p>
1302
1433
  */
1303
1434
  NewReplicationFactor: number | undefined;
1304
1435
  /**
1436
+ * @public
1305
1437
  * <p>The Availability Zones (AZs) in which the cluster nodes will be created. All nodes
1306
1438
  * belonging to the cluster are placed in these Availability Zones. Use this parameter if you want
1307
1439
  * to distribute the nodes across multiple AZs.</p>
@@ -1313,6 +1445,7 @@ export interface IncreaseReplicationFactorRequest {
1313
1445
  */
1314
1446
  export interface IncreaseReplicationFactorResponse {
1315
1447
  /**
1448
+ * @public
1316
1449
  * <p>A description of the DAX cluster. with its new replication factor.</p>
1317
1450
  */
1318
1451
  Cluster?: Cluster;
@@ -1334,10 +1467,12 @@ export declare class InvalidARNFault extends __BaseException {
1334
1467
  */
1335
1468
  export interface ListTagsRequest {
1336
1469
  /**
1470
+ * @public
1337
1471
  * <p>The name of the DAX resource to which the tags belong.</p>
1338
1472
  */
1339
1473
  ResourceName: string | undefined;
1340
1474
  /**
1475
+ * @public
1341
1476
  * <p>An optional token returned from a prior request. Use this token for pagination of
1342
1477
  * results from this action. If this parameter is specified, the response includes only
1343
1478
  * results beyond the token.</p>
@@ -1349,10 +1484,12 @@ export interface ListTagsRequest {
1349
1484
  */
1350
1485
  export interface ListTagsResponse {
1351
1486
  /**
1487
+ * @public
1352
1488
  * <p>A list of tags currently associated with the DAX cluster.</p>
1353
1489
  */
1354
1490
  Tags?: Tag[];
1355
1491
  /**
1492
+ * @public
1356
1493
  * <p>If this value is present, there are additional results to be displayed. To retrieve them, call
1357
1494
  * <code>ListTags</code> again, with <code>NextToken</code> set to this value.</p>
1358
1495
  */
@@ -1363,10 +1500,12 @@ export interface ListTagsResponse {
1363
1500
  */
1364
1501
  export interface RebootNodeRequest {
1365
1502
  /**
1503
+ * @public
1366
1504
  * <p>The name of the DAX cluster containing the node to be rebooted.</p>
1367
1505
  */
1368
1506
  ClusterName: string | undefined;
1369
1507
  /**
1508
+ * @public
1370
1509
  * <p>The system-assigned ID of the node to be rebooted.</p>
1371
1510
  */
1372
1511
  NodeId: string | undefined;
@@ -1376,6 +1515,7 @@ export interface RebootNodeRequest {
1376
1515
  */
1377
1516
  export interface RebootNodeResponse {
1378
1517
  /**
1518
+ * @public
1379
1519
  * <p>A description of the DAX cluster after a node has been rebooted.</p>
1380
1520
  */
1381
1521
  Cluster?: Cluster;
@@ -1385,10 +1525,12 @@ export interface RebootNodeResponse {
1385
1525
  */
1386
1526
  export interface TagResourceRequest {
1387
1527
  /**
1528
+ * @public
1388
1529
  * <p>The name of the DAX resource to which tags should be added.</p>
1389
1530
  */
1390
1531
  ResourceName: string | undefined;
1391
1532
  /**
1533
+ * @public
1392
1534
  * <p>The tags to be assigned to the DAX resource. </p>
1393
1535
  */
1394
1536
  Tags: Tag[] | undefined;
@@ -1398,6 +1540,7 @@ export interface TagResourceRequest {
1398
1540
  */
1399
1541
  export interface TagResourceResponse {
1400
1542
  /**
1543
+ * @public
1401
1544
  * <p>The list of tags that are associated with the DAX resource.</p>
1402
1545
  */
1403
1546
  Tags?: Tag[];
@@ -1419,10 +1562,12 @@ export declare class TagNotFoundFault extends __BaseException {
1419
1562
  */
1420
1563
  export interface UntagResourceRequest {
1421
1564
  /**
1565
+ * @public
1422
1566
  * <p>The name of the DAX resource from which the tags should be removed.</p>
1423
1567
  */
1424
1568
  ResourceName: string | undefined;
1425
1569
  /**
1570
+ * @public
1426
1571
  * <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>
1427
1572
  */
1428
1573
  TagKeys: string[] | undefined;
@@ -1432,6 +1577,7 @@ export interface UntagResourceRequest {
1432
1577
  */
1433
1578
  export interface UntagResourceResponse {
1434
1579
  /**
1580
+ * @public
1435
1581
  * <p>The tag keys that have been removed from the cluster.</p>
1436
1582
  */
1437
1583
  Tags?: Tag[];
@@ -1441,34 +1587,41 @@ export interface UntagResourceResponse {
1441
1587
  */
1442
1588
  export interface UpdateClusterRequest {
1443
1589
  /**
1590
+ * @public
1444
1591
  * <p>The name of the DAX cluster to be modified.</p>
1445
1592
  */
1446
1593
  ClusterName: string | undefined;
1447
1594
  /**
1595
+ * @public
1448
1596
  * <p>A description of the changes being made to the cluster.</p>
1449
1597
  */
1450
1598
  Description?: string;
1451
1599
  /**
1600
+ * @public
1452
1601
  * <p>A range of time when maintenance of DAX cluster software will be performed. For
1453
1602
  * example: <code>sun:01:00-sun:09:00</code>. Cluster maintenance normally takes less than
1454
1603
  * 30 minutes, and is performed automatically within the maintenance window.</p>
1455
1604
  */
1456
1605
  PreferredMaintenanceWindow?: string;
1457
1606
  /**
1607
+ * @public
1458
1608
  * <p>The Amazon Resource Name (ARN) that identifies the topic.</p>
1459
1609
  */
1460
1610
  NotificationTopicArn?: string;
1461
1611
  /**
1612
+ * @public
1462
1613
  * <p>The current state of the topic. A value of “active” means that notifications will
1463
1614
  * be sent to the topic. A value of “inactive” means that notifications will not be sent to the
1464
1615
  * topic.</p>
1465
1616
  */
1466
1617
  NotificationTopicStatus?: string;
1467
1618
  /**
1619
+ * @public
1468
1620
  * <p>The name of a parameter group for this cluster.</p>
1469
1621
  */
1470
1622
  ParameterGroupName?: string;
1471
1623
  /**
1624
+ * @public
1472
1625
  * <p>A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this parameter is not
1473
1626
  * specified, DAX assigns the default VPC security group to each node.</p>
1474
1627
  */
@@ -1479,6 +1632,7 @@ export interface UpdateClusterRequest {
1479
1632
  */
1480
1633
  export interface UpdateClusterResponse {
1481
1634
  /**
1635
+ * @public
1482
1636
  * <p>A description of the DAX cluster, after it has been modified.</p>
1483
1637
  */
1484
1638
  Cluster?: Cluster;
@@ -1489,10 +1643,12 @@ export interface UpdateClusterResponse {
1489
1643
  */
1490
1644
  export interface ParameterNameValue {
1491
1645
  /**
1646
+ * @public
1492
1647
  * <p>The name of the parameter.</p>
1493
1648
  */
1494
1649
  ParameterName?: string;
1495
1650
  /**
1651
+ * @public
1496
1652
  * <p>The value of the parameter.</p>
1497
1653
  */
1498
1654
  ParameterValue?: string;
@@ -1502,10 +1658,12 @@ export interface ParameterNameValue {
1502
1658
  */
1503
1659
  export interface UpdateParameterGroupRequest {
1504
1660
  /**
1661
+ * @public
1505
1662
  * <p>The name of the parameter group.</p>
1506
1663
  */
1507
1664
  ParameterGroupName: string | undefined;
1508
1665
  /**
1666
+ * @public
1509
1667
  * <p>An array of name-value pairs for the parameters in the group. Each element in the
1510
1668
  * array represents a single parameter.</p>
1511
1669
  * <note>
@@ -1520,6 +1678,7 @@ export interface UpdateParameterGroupRequest {
1520
1678
  */
1521
1679
  export interface UpdateParameterGroupResponse {
1522
1680
  /**
1681
+ * @public
1523
1682
  * <p>The parameter group that has been modified.</p>
1524
1683
  */
1525
1684
  ParameterGroup?: ParameterGroup;
@@ -1541,14 +1700,17 @@ export declare class SubnetInUse extends __BaseException {
1541
1700
  */
1542
1701
  export interface UpdateSubnetGroupRequest {
1543
1702
  /**
1703
+ * @public
1544
1704
  * <p>The name of the subnet group.</p>
1545
1705
  */
1546
1706
  SubnetGroupName: string | undefined;
1547
1707
  /**
1708
+ * @public
1548
1709
  * <p>A description of the subnet group.</p>
1549
1710
  */
1550
1711
  Description?: string;
1551
1712
  /**
1713
+ * @public
1552
1714
  * <p>A list of subnet IDs in the subnet group.</p>
1553
1715
  */
1554
1716
  SubnetIds?: string[];
@@ -1558,6 +1720,7 @@ export interface UpdateSubnetGroupRequest {
1558
1720
  */
1559
1721
  export interface UpdateSubnetGroupResponse {
1560
1722
  /**
1723
+ * @public
1561
1724
  * <p>The subnet group that has been modified.</p>
1562
1725
  */
1563
1726
  SubnetGroup?: SubnetGroup;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-dax",
3
3
  "description": "AWS SDK for JavaScript Dax Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.385.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.385.0",
25
+ "@aws-sdk/credential-provider-node": "3.385.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",