aws-sdk-memorydb 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::MemoryDB
11
+
12
+ class Resource
13
+
14
+ # @param options ({})
15
+ # @option options [Client] :client
16
+ def initialize(options = {})
17
+ @client = options[:client] || Client.new(options)
18
+ end
19
+
20
+ # @return [Client]
21
+ def client
22
+ @client
23
+ end
24
+
25
+ end
26
+ end
@@ -0,0 +1,3378 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::MemoryDB
11
+ module Types
12
+
13
+ # An Access Control List. You can authenticate users with Access Contol
14
+ # Lists. ACLs enable you to control cluster access by grouping users.
15
+ # These Access control lists are designed as a way to organize access to
16
+ # clusters.
17
+ #
18
+ # @!attribute [rw] name
19
+ # The name of the Access Control List
20
+ # @return [String]
21
+ #
22
+ # @!attribute [rw] status
23
+ # Indicates ACL status. Can be "creating", "active",
24
+ # "modifying", "deleting".
25
+ # @return [String]
26
+ #
27
+ # @!attribute [rw] user_names
28
+ # The list of user names that belong to the ACL.
29
+ # @return [Array<String>]
30
+ #
31
+ # @!attribute [rw] minimum_engine_version
32
+ # The minimum engine version supported for the ACL
33
+ # @return [String]
34
+ #
35
+ # @!attribute [rw] pending_changes
36
+ # A list of updates being applied to the ACL.
37
+ # @return [Types::ACLPendingChanges]
38
+ #
39
+ # @!attribute [rw] clusters
40
+ # A list of clusters associated with the ACL.
41
+ # @return [Array<String>]
42
+ #
43
+ # @!attribute [rw] arn
44
+ # The Amazon Resource Name (ARN) of the ACL
45
+ # @return [String]
46
+ #
47
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ACL AWS API Documentation
48
+ #
49
+ class ACL < Struct.new(
50
+ :name,
51
+ :status,
52
+ :user_names,
53
+ :minimum_engine_version,
54
+ :pending_changes,
55
+ :clusters,
56
+ :arn)
57
+ SENSITIVE = []
58
+ include Aws::Structure
59
+ end
60
+
61
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ACLAlreadyExistsFault AWS API Documentation
62
+ #
63
+ class ACLAlreadyExistsFault < Aws::EmptyStructure; end
64
+
65
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ACLNotFoundFault AWS API Documentation
66
+ #
67
+ class ACLNotFoundFault < Aws::EmptyStructure; end
68
+
69
+ # Returns the updates being applied to the ACL.
70
+ #
71
+ # @!attribute [rw] user_names_to_remove
72
+ # A list of user names being removed from the ACL
73
+ # @return [Array<String>]
74
+ #
75
+ # @!attribute [rw] user_names_to_add
76
+ # A list of users being added to the ACL
77
+ # @return [Array<String>]
78
+ #
79
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ACLPendingChanges AWS API Documentation
80
+ #
81
+ class ACLPendingChanges < Struct.new(
82
+ :user_names_to_remove,
83
+ :user_names_to_add)
84
+ SENSITIVE = []
85
+ include Aws::Structure
86
+ end
87
+
88
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ACLQuotaExceededFault AWS API Documentation
89
+ #
90
+ class ACLQuotaExceededFault < Aws::EmptyStructure; end
91
+
92
+ # The status of the ACL update
93
+ #
94
+ # @!attribute [rw] acl_to_apply
95
+ # A list of ACLs pending to be applied.
96
+ # @return [String]
97
+ #
98
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ACLsUpdateStatus AWS API Documentation
99
+ #
100
+ class ACLsUpdateStatus < Struct.new(
101
+ :acl_to_apply)
102
+ SENSITIVE = []
103
+ include Aws::Structure
104
+ end
105
+
106
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/APICallRateForCustomerExceededFault AWS API Documentation
107
+ #
108
+ class APICallRateForCustomerExceededFault < Aws::EmptyStructure; end
109
+
110
+ # Denotes the user's authentication properties, such as whether it
111
+ # requires a password to authenticate. Used in output responses.
112
+ #
113
+ # @!attribute [rw] type
114
+ # Indicates whether the user requires a password to authenticate.
115
+ # @return [String]
116
+ #
117
+ # @!attribute [rw] password_count
118
+ # The number of passwords belonging to the user. The maximum is two.
119
+ # @return [Integer]
120
+ #
121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/Authentication AWS API Documentation
122
+ #
123
+ class Authentication < Struct.new(
124
+ :type,
125
+ :password_count)
126
+ SENSITIVE = []
127
+ include Aws::Structure
128
+ end
129
+
130
+ # Denotes the user's authentication properties, such as whether it
131
+ # requires a password to authenticate. Used in output responses.
132
+ #
133
+ # @note When making an API call, you may pass AuthenticationMode
134
+ # data as a hash:
135
+ #
136
+ # {
137
+ # type: "password", # accepts password
138
+ # passwords: ["String"],
139
+ # }
140
+ #
141
+ # @!attribute [rw] type
142
+ # Indicates whether the user requires a password to authenticate. All
143
+ # newly-created users require a password.
144
+ # @return [String]
145
+ #
146
+ # @!attribute [rw] passwords
147
+ # The password(s) used for authentication
148
+ # @return [Array<String>]
149
+ #
150
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/AuthenticationMode AWS API Documentation
151
+ #
152
+ class AuthenticationMode < Struct.new(
153
+ :type,
154
+ :passwords)
155
+ SENSITIVE = []
156
+ include Aws::Structure
157
+ end
158
+
159
+ # Indicates if the cluster has a Multi-AZ configuration (multiaz) or not
160
+ # (singleaz).
161
+ #
162
+ # @!attribute [rw] name
163
+ # The name of the Availability Zone.
164
+ # @return [String]
165
+ #
166
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/AvailabilityZone AWS API Documentation
167
+ #
168
+ class AvailabilityZone < Struct.new(
169
+ :name)
170
+ SENSITIVE = []
171
+ include Aws::Structure
172
+ end
173
+
174
+ # @note When making an API call, you may pass BatchUpdateClusterRequest
175
+ # data as a hash:
176
+ #
177
+ # {
178
+ # cluster_names: ["String"], # required
179
+ # service_update: {
180
+ # service_update_name_to_apply: "String",
181
+ # },
182
+ # }
183
+ #
184
+ # @!attribute [rw] cluster_names
185
+ # The cluster names to apply the updates.
186
+ # @return [Array<String>]
187
+ #
188
+ # @!attribute [rw] service_update
189
+ # The unique ID of the service update
190
+ # @return [Types::ServiceUpdateRequest]
191
+ #
192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/BatchUpdateClusterRequest AWS API Documentation
193
+ #
194
+ class BatchUpdateClusterRequest < Struct.new(
195
+ :cluster_names,
196
+ :service_update)
197
+ SENSITIVE = []
198
+ include Aws::Structure
199
+ end
200
+
201
+ # @!attribute [rw] processed_clusters
202
+ # The list of clusters that have been updated.
203
+ # @return [Array<Types::Cluster>]
204
+ #
205
+ # @!attribute [rw] unprocessed_clusters
206
+ # The list of clusters where updates have not been applied.
207
+ # @return [Array<Types::UnprocessedCluster>]
208
+ #
209
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/BatchUpdateClusterResponse AWS API Documentation
210
+ #
211
+ class BatchUpdateClusterResponse < Struct.new(
212
+ :processed_clusters,
213
+ :unprocessed_clusters)
214
+ SENSITIVE = []
215
+ include Aws::Structure
216
+ end
217
+
218
+ # Contains all of the attributes of a specific cluster.
219
+ #
220
+ # @!attribute [rw] name
221
+ # The user-supplied name of the cluster. This identifier is a unique
222
+ # key that identifies a cluster.
223
+ # @return [String]
224
+ #
225
+ # @!attribute [rw] description
226
+ # A description of the cluster
227
+ # @return [String]
228
+ #
229
+ # @!attribute [rw] status
230
+ # The status of the cluster. For example, Available, Updating,
231
+ # Creating.
232
+ # @return [String]
233
+ #
234
+ # @!attribute [rw] pending_updates
235
+ # A group of settings that are currently being applied.
236
+ # @return [Types::ClusterPendingUpdates]
237
+ #
238
+ # @!attribute [rw] number_of_shards
239
+ # The number of shards in the cluster
240
+ # @return [Integer]
241
+ #
242
+ # @!attribute [rw] shards
243
+ # A list of shards that are members of the cluster.
244
+ # @return [Array<Types::Shard>]
245
+ #
246
+ # @!attribute [rw] availability_mode
247
+ # Indicates if the cluster has a Multi-AZ configuration (multiaz) or
248
+ # not (singleaz).
249
+ # @return [String]
250
+ #
251
+ # @!attribute [rw] cluster_endpoint
252
+ # The cluster's configuration endpoint
253
+ # @return [Types::Endpoint]
254
+ #
255
+ # @!attribute [rw] node_type
256
+ # The cluster's node type
257
+ # @return [String]
258
+ #
259
+ # @!attribute [rw] engine_version
260
+ # The Redis engine version used by the cluster
261
+ # @return [String]
262
+ #
263
+ # @!attribute [rw] engine_patch_version
264
+ # The Redis engine patch version used by the cluster
265
+ # @return [String]
266
+ #
267
+ # @!attribute [rw] parameter_group_name
268
+ # The name of the parameter group used by the cluster
269
+ # @return [String]
270
+ #
271
+ # @!attribute [rw] parameter_group_status
272
+ # The status of the parameter group used by the cluster, for example
273
+ # 'active' or 'applying'.
274
+ # @return [String]
275
+ #
276
+ # @!attribute [rw] security_groups
277
+ # A list of security groups used by the cluster
278
+ # @return [Array<Types::SecurityGroupMembership>]
279
+ #
280
+ # @!attribute [rw] subnet_group_name
281
+ # The name of the subnet group used by the cluster
282
+ # @return [String]
283
+ #
284
+ # @!attribute [rw] tls_enabled
285
+ # A flag to indicate if In-transit encryption is enabled
286
+ # @return [Boolean]
287
+ #
288
+ # @!attribute [rw] kms_key_id
289
+ # The ID of the KMS key used to encrypt the cluster
290
+ # @return [String]
291
+ #
292
+ # @!attribute [rw] arn
293
+ # The Amazon Resource Name (ARN) of the cluster.
294
+ # @return [String]
295
+ #
296
+ # @!attribute [rw] sns_topic_arn
297
+ # The Amazon Resource Name (ARN) of the SNS notification topic
298
+ # @return [String]
299
+ #
300
+ # @!attribute [rw] sns_topic_status
301
+ # The SNS topic must be in Active status to receive notifications
302
+ # @return [String]
303
+ #
304
+ # @!attribute [rw] snapshot_retention_limit
305
+ # The number of days for which MemoryDB retains automatic snapshots
306
+ # before deleting them. For example, if you set SnapshotRetentionLimit
307
+ # to 5, a snapshot that was taken today is retained for 5 days before
308
+ # being deleted.
309
+ # @return [Integer]
310
+ #
311
+ # @!attribute [rw] maintenance_window
312
+ # Specifies the weekly time range during which maintenance on the
313
+ # cluster is performed. It is specified as a range in the format
314
+ # ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance
315
+ # window is a 60 minute period.
316
+ # @return [String]
317
+ #
318
+ # @!attribute [rw] snapshot_window
319
+ # The daily time range (in UTC) during which MemoryDB begins taking a
320
+ # daily snapshot of your shard. Example: 05:00-09:00 If you do not
321
+ # specify this parameter, MemoryDB automatically chooses an
322
+ # appropriate time range.
323
+ # @return [String]
324
+ #
325
+ # @!attribute [rw] acl_name
326
+ # The name of the Access Control List associated with this cluster.
327
+ # @return [String]
328
+ #
329
+ # @!attribute [rw] auto_minor_version_upgrade
330
+ # When set to true, the cluster will automatically receive minor
331
+ # engine version upgrades after launch.
332
+ # @return [Boolean]
333
+ #
334
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/Cluster AWS API Documentation
335
+ #
336
+ class Cluster < Struct.new(
337
+ :name,
338
+ :description,
339
+ :status,
340
+ :pending_updates,
341
+ :number_of_shards,
342
+ :shards,
343
+ :availability_mode,
344
+ :cluster_endpoint,
345
+ :node_type,
346
+ :engine_version,
347
+ :engine_patch_version,
348
+ :parameter_group_name,
349
+ :parameter_group_status,
350
+ :security_groups,
351
+ :subnet_group_name,
352
+ :tls_enabled,
353
+ :kms_key_id,
354
+ :arn,
355
+ :sns_topic_arn,
356
+ :sns_topic_status,
357
+ :snapshot_retention_limit,
358
+ :maintenance_window,
359
+ :snapshot_window,
360
+ :acl_name,
361
+ :auto_minor_version_upgrade)
362
+ SENSITIVE = []
363
+ include Aws::Structure
364
+ end
365
+
366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ClusterAlreadyExistsFault AWS API Documentation
367
+ #
368
+ class ClusterAlreadyExistsFault < Aws::EmptyStructure; end
369
+
370
+ # A list of cluster configuration options.
371
+ #
372
+ # @!attribute [rw] name
373
+ # The name of the cluster
374
+ # @return [String]
375
+ #
376
+ # @!attribute [rw] description
377
+ # The description of the cluster configuration
378
+ # @return [String]
379
+ #
380
+ # @!attribute [rw] node_type
381
+ # The node type used for the cluster
382
+ # @return [String]
383
+ #
384
+ # @!attribute [rw] engine_version
385
+ # The Redis engine version used by the cluster
386
+ # @return [String]
387
+ #
388
+ # @!attribute [rw] maintenance_window
389
+ # The specified maintenance window for the cluster
390
+ # @return [String]
391
+ #
392
+ # @!attribute [rw] topic_arn
393
+ # The Amazon Resource Name (ARN) of the SNS notification topic for the
394
+ # cluster
395
+ # @return [String]
396
+ #
397
+ # @!attribute [rw] port
398
+ # The port used by the cluster
399
+ # @return [Integer]
400
+ #
401
+ # @!attribute [rw] parameter_group_name
402
+ # The name of parameter group used by the cluster
403
+ # @return [String]
404
+ #
405
+ # @!attribute [rw] subnet_group_name
406
+ # The name of the subnet group used by the cluster
407
+ # @return [String]
408
+ #
409
+ # @!attribute [rw] vpc_id
410
+ # The ID of the VPC the cluster belongs to
411
+ # @return [String]
412
+ #
413
+ # @!attribute [rw] snapshot_retention_limit
414
+ # The snapshot retention limit set by the cluster
415
+ # @return [Integer]
416
+ #
417
+ # @!attribute [rw] snapshot_window
418
+ # The snapshot window set by the cluster
419
+ # @return [String]
420
+ #
421
+ # @!attribute [rw] num_shards
422
+ # The number of shards in the cluster
423
+ # @return [Integer]
424
+ #
425
+ # @!attribute [rw] shards
426
+ # The list of shards in the cluster
427
+ # @return [Array<Types::ShardDetail>]
428
+ #
429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ClusterConfiguration AWS API Documentation
430
+ #
431
+ class ClusterConfiguration < Struct.new(
432
+ :name,
433
+ :description,
434
+ :node_type,
435
+ :engine_version,
436
+ :maintenance_window,
437
+ :topic_arn,
438
+ :port,
439
+ :parameter_group_name,
440
+ :subnet_group_name,
441
+ :vpc_id,
442
+ :snapshot_retention_limit,
443
+ :snapshot_window,
444
+ :num_shards,
445
+ :shards)
446
+ SENSITIVE = []
447
+ include Aws::Structure
448
+ end
449
+
450
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ClusterNotFoundFault AWS API Documentation
451
+ #
452
+ class ClusterNotFoundFault < Aws::EmptyStructure; end
453
+
454
+ # A list of updates being applied to the cluster
455
+ #
456
+ # @!attribute [rw] resharding
457
+ # The status of an online resharding operation.
458
+ # @return [Types::ReshardingStatus]
459
+ #
460
+ # @!attribute [rw] acls
461
+ # A list of ACLs associated with the cluster that are being updated
462
+ # @return [Types::ACLsUpdateStatus]
463
+ #
464
+ # @!attribute [rw] service_updates
465
+ # A list of service updates being applied to the cluster
466
+ # @return [Array<Types::PendingModifiedServiceUpdate>]
467
+ #
468
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ClusterPendingUpdates AWS API Documentation
469
+ #
470
+ class ClusterPendingUpdates < Struct.new(
471
+ :resharding,
472
+ :acls,
473
+ :service_updates)
474
+ SENSITIVE = []
475
+ include Aws::Structure
476
+ end
477
+
478
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ClusterQuotaForCustomerExceededFault AWS API Documentation
479
+ #
480
+ class ClusterQuotaForCustomerExceededFault < Aws::EmptyStructure; end
481
+
482
+ # @note When making an API call, you may pass CopySnapshotRequest
483
+ # data as a hash:
484
+ #
485
+ # {
486
+ # source_snapshot_name: "String", # required
487
+ # target_snapshot_name: "String", # required
488
+ # target_bucket: "TargetBucket",
489
+ # kms_key_id: "KmsKeyId",
490
+ # tags: [
491
+ # {
492
+ # key: "String",
493
+ # value: "String",
494
+ # },
495
+ # ],
496
+ # }
497
+ #
498
+ # @!attribute [rw] source_snapshot_name
499
+ # The name of an existing snapshot from which to make a copy.
500
+ # @return [String]
501
+ #
502
+ # @!attribute [rw] target_snapshot_name
503
+ # A name for the snapshot copy. MemoryDB does not permit overwriting a
504
+ # snapshot, therefore this name must be unique within its context -
505
+ # MemoryDB or an Amazon S3 bucket if exporting.
506
+ # @return [String]
507
+ #
508
+ # @!attribute [rw] target_bucket
509
+ # The Amazon S3 bucket to which the snapshot is exported. This
510
+ # parameter is used only when exporting a snapshot for external
511
+ # access. When using this parameter to export a snapshot, be sure
512
+ # MemoryDB has the needed permissions to this S3 bucket. For more
513
+ # information, see [Step 2: Grant MemoryDB Access to Your Amazon S3
514
+ # Bucket][1].
515
+ #
516
+ #
517
+ #
518
+ # [1]: https://docs.aws.amazon.com/AmazonMemoryDB/latest/devguide/snapshots-exporting.html
519
+ # @return [String]
520
+ #
521
+ # @!attribute [rw] kms_key_id
522
+ # The ID of the KMS key used to encrypt the target snapshot.
523
+ # @return [String]
524
+ #
525
+ # @!attribute [rw] tags
526
+ # A list of tags to be added to this resource. A tag is a key-value
527
+ # pair. A tag key must be accompanied by a tag value, although null is
528
+ # accepted.
529
+ # @return [Array<Types::Tag>]
530
+ #
531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CopySnapshotRequest AWS API Documentation
532
+ #
533
+ class CopySnapshotRequest < Struct.new(
534
+ :source_snapshot_name,
535
+ :target_snapshot_name,
536
+ :target_bucket,
537
+ :kms_key_id,
538
+ :tags)
539
+ SENSITIVE = []
540
+ include Aws::Structure
541
+ end
542
+
543
+ # @!attribute [rw] snapshot
544
+ # Represents a copy of an entire cluster as of the time when the
545
+ # snapshot was taken.
546
+ # @return [Types::Snapshot]
547
+ #
548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CopySnapshotResponse AWS API Documentation
549
+ #
550
+ class CopySnapshotResponse < Struct.new(
551
+ :snapshot)
552
+ SENSITIVE = []
553
+ include Aws::Structure
554
+ end
555
+
556
+ # @note When making an API call, you may pass CreateACLRequest
557
+ # data as a hash:
558
+ #
559
+ # {
560
+ # acl_name: "String", # required
561
+ # user_names: ["UserName"],
562
+ # tags: [
563
+ # {
564
+ # key: "String",
565
+ # value: "String",
566
+ # },
567
+ # ],
568
+ # }
569
+ #
570
+ # @!attribute [rw] acl_name
571
+ # The name of the Access Control List.
572
+ # @return [String]
573
+ #
574
+ # @!attribute [rw] user_names
575
+ # The list of users that belong to the Access Control List.
576
+ # @return [Array<String>]
577
+ #
578
+ # @!attribute [rw] tags
579
+ # A list of tags to be added to this resource. A tag is a key-value
580
+ # pair. A tag key must be accompanied by a tag value, although null is
581
+ # accepted.
582
+ # @return [Array<Types::Tag>]
583
+ #
584
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CreateACLRequest AWS API Documentation
585
+ #
586
+ class CreateACLRequest < Struct.new(
587
+ :acl_name,
588
+ :user_names,
589
+ :tags)
590
+ SENSITIVE = []
591
+ include Aws::Structure
592
+ end
593
+
594
+ # @!attribute [rw] acl
595
+ # The newly-created Access Control List.
596
+ # @return [Types::ACL]
597
+ #
598
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CreateACLResponse AWS API Documentation
599
+ #
600
+ class CreateACLResponse < Struct.new(
601
+ :acl)
602
+ SENSITIVE = []
603
+ include Aws::Structure
604
+ end
605
+
606
+ # @note When making an API call, you may pass CreateClusterRequest
607
+ # data as a hash:
608
+ #
609
+ # {
610
+ # cluster_name: "String", # required
611
+ # node_type: "String", # required
612
+ # parameter_group_name: "String",
613
+ # description: "String",
614
+ # num_shards: 1,
615
+ # num_replicas_per_shard: 1,
616
+ # subnet_group_name: "String",
617
+ # security_group_ids: ["String"],
618
+ # maintenance_window: "String",
619
+ # port: 1,
620
+ # sns_topic_arn: "String",
621
+ # tls_enabled: false,
622
+ # kms_key_id: "String",
623
+ # snapshot_arns: ["String"],
624
+ # snapshot_name: "String",
625
+ # snapshot_retention_limit: 1,
626
+ # tags: [
627
+ # {
628
+ # key: "String",
629
+ # value: "String",
630
+ # },
631
+ # ],
632
+ # snapshot_window: "String",
633
+ # acl_name: "ACLName", # required
634
+ # engine_version: "String",
635
+ # auto_minor_version_upgrade: false,
636
+ # }
637
+ #
638
+ # @!attribute [rw] cluster_name
639
+ # The name of the cluster. This value must be unique as it also serves
640
+ # as the cluster identifier.
641
+ # @return [String]
642
+ #
643
+ # @!attribute [rw] node_type
644
+ # The compute and memory capacity of the nodes in the cluster.
645
+ # @return [String]
646
+ #
647
+ # @!attribute [rw] parameter_group_name
648
+ # The name of the parameter group associated with the cluster.
649
+ # @return [String]
650
+ #
651
+ # @!attribute [rw] description
652
+ # An optional description of the cluster.
653
+ # @return [String]
654
+ #
655
+ # @!attribute [rw] num_shards
656
+ # The number of shards the cluster will contain.
657
+ #
658
+ # Clusters can have up to 500 shards, with your data partitioned
659
+ # across the shards. For example, you can choose to configure a 500
660
+ # node cluster that ranges between 83 shards (one primary and 5
661
+ # replicas per shard) and 500 shards (single primary and no replicas).
662
+ # Make sure there are enough available IP addresses to accommodate the
663
+ # increase. Common pitfalls include the subnets in the subnet group
664
+ # have too small a CIDR range or the subnets are shared and heavily
665
+ # used by other clusters.
666
+ # @return [Integer]
667
+ #
668
+ # @!attribute [rw] num_replicas_per_shard
669
+ # The number of replicas to apply to each shard. The limit is 5.
670
+ # @return [Integer]
671
+ #
672
+ # @!attribute [rw] subnet_group_name
673
+ # The name of the subnet group to be used for the cluster.
674
+ # @return [String]
675
+ #
676
+ # @!attribute [rw] security_group_ids
677
+ # A list of security group names to associate with this cluster.
678
+ # @return [Array<String>]
679
+ #
680
+ # @!attribute [rw] maintenance_window
681
+ # Specifies the weekly time range during which maintenance on the
682
+ # cluster is performed. It is specified as a range in the format
683
+ # `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance
684
+ # window is a 60 minute period.
685
+ # @return [String]
686
+ #
687
+ # @!attribute [rw] port
688
+ # The port number on which each of the nodes accepts connections.
689
+ # @return [Integer]
690
+ #
691
+ # @!attribute [rw] sns_topic_arn
692
+ # The Amazon Resource Name (ARN) of the Amazon Simple Notification
693
+ # Service (SNS) topic to which notifications are sent.
694
+ # @return [String]
695
+ #
696
+ # @!attribute [rw] tls_enabled
697
+ # A flag to enable in-transit encryption on the cluster.
698
+ # @return [Boolean]
699
+ #
700
+ # @!attribute [rw] kms_key_id
701
+ # The ID of the KMS key used to encrypt the cluster.
702
+ # @return [String]
703
+ #
704
+ # @!attribute [rw] snapshot_arns
705
+ # A list of Amazon Resource Names (ARN) that uniquely identify the RDB
706
+ # snapshot files stored in Amazon S3. The snapshot files are used to
707
+ # populate the new cluster. The Amazon S3 object name in the ARN
708
+ # cannot contain any commas.
709
+ # @return [Array<String>]
710
+ #
711
+ # @!attribute [rw] snapshot_name
712
+ # The name of a snapshot from which to restore data into the new
713
+ # cluster. The snapshot status changes to restoring while the new
714
+ # cluster is being created.
715
+ # @return [String]
716
+ #
717
+ # @!attribute [rw] snapshot_retention_limit
718
+ # The number of days for which MemoryDB retains automatic snapshots
719
+ # before deleting them. For example, if you set SnapshotRetentionLimit
720
+ # to 5, a snapshot that was taken today is retained for 5 days before
721
+ # being deleted.
722
+ # @return [Integer]
723
+ #
724
+ # @!attribute [rw] tags
725
+ # A list of tags to be added to this resource. Tags are
726
+ # comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue.
727
+ # You can include multiple tags as shown following: Key=myKey,
728
+ # Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
729
+ # @return [Array<Types::Tag>]
730
+ #
731
+ # @!attribute [rw] snapshot_window
732
+ # The daily time range (in UTC) during which MemoryDB begins taking a
733
+ # daily snapshot of your shard.
734
+ #
735
+ # Example: 05:00-09:00
736
+ #
737
+ # If you do not specify this parameter, MemoryDB automatically chooses
738
+ # an appropriate time range.
739
+ # @return [String]
740
+ #
741
+ # @!attribute [rw] acl_name
742
+ # The name of the Access Control List to associate with the cluster.
743
+ # @return [String]
744
+ #
745
+ # @!attribute [rw] engine_version
746
+ # The version number of the Redis engine to be used for the cluster.
747
+ # @return [String]
748
+ #
749
+ # @!attribute [rw] auto_minor_version_upgrade
750
+ # When set to true, the cluster will automatically receive minor
751
+ # engine version upgrades after launch.
752
+ # @return [Boolean]
753
+ #
754
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CreateClusterRequest AWS API Documentation
755
+ #
756
+ class CreateClusterRequest < Struct.new(
757
+ :cluster_name,
758
+ :node_type,
759
+ :parameter_group_name,
760
+ :description,
761
+ :num_shards,
762
+ :num_replicas_per_shard,
763
+ :subnet_group_name,
764
+ :security_group_ids,
765
+ :maintenance_window,
766
+ :port,
767
+ :sns_topic_arn,
768
+ :tls_enabled,
769
+ :kms_key_id,
770
+ :snapshot_arns,
771
+ :snapshot_name,
772
+ :snapshot_retention_limit,
773
+ :tags,
774
+ :snapshot_window,
775
+ :acl_name,
776
+ :engine_version,
777
+ :auto_minor_version_upgrade)
778
+ SENSITIVE = []
779
+ include Aws::Structure
780
+ end
781
+
782
+ # @!attribute [rw] cluster
783
+ # The newly-created cluster.
784
+ # @return [Types::Cluster]
785
+ #
786
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CreateClusterResponse AWS API Documentation
787
+ #
788
+ class CreateClusterResponse < Struct.new(
789
+ :cluster)
790
+ SENSITIVE = []
791
+ include Aws::Structure
792
+ end
793
+
794
+ # @note When making an API call, you may pass CreateParameterGroupRequest
795
+ # data as a hash:
796
+ #
797
+ # {
798
+ # parameter_group_name: "String", # required
799
+ # family: "String", # required
800
+ # description: "String",
801
+ # tags: [
802
+ # {
803
+ # key: "String",
804
+ # value: "String",
805
+ # },
806
+ # ],
807
+ # }
808
+ #
809
+ # @!attribute [rw] parameter_group_name
810
+ # The name of the parameter group.
811
+ # @return [String]
812
+ #
813
+ # @!attribute [rw] family
814
+ # The name of the parameter group family that the parameter group can
815
+ # be used with.
816
+ # @return [String]
817
+ #
818
+ # @!attribute [rw] description
819
+ # An optional description of the parameter group.
820
+ # @return [String]
821
+ #
822
+ # @!attribute [rw] tags
823
+ # A list of tags to be added to this resource. A tag is a key-value
824
+ # pair. A tag key must be accompanied by a tag value, although null is
825
+ # accepted.
826
+ # @return [Array<Types::Tag>]
827
+ #
828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CreateParameterGroupRequest AWS API Documentation
829
+ #
830
+ class CreateParameterGroupRequest < Struct.new(
831
+ :parameter_group_name,
832
+ :family,
833
+ :description,
834
+ :tags)
835
+ SENSITIVE = []
836
+ include Aws::Structure
837
+ end
838
+
839
+ # @!attribute [rw] parameter_group
840
+ # The newly-created parameter group.
841
+ # @return [Types::ParameterGroup]
842
+ #
843
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CreateParameterGroupResponse AWS API Documentation
844
+ #
845
+ class CreateParameterGroupResponse < Struct.new(
846
+ :parameter_group)
847
+ SENSITIVE = []
848
+ include Aws::Structure
849
+ end
850
+
851
+ # @note When making an API call, you may pass CreateSnapshotRequest
852
+ # data as a hash:
853
+ #
854
+ # {
855
+ # cluster_name: "String", # required
856
+ # snapshot_name: "String", # required
857
+ # kms_key_id: "String",
858
+ # tags: [
859
+ # {
860
+ # key: "String",
861
+ # value: "String",
862
+ # },
863
+ # ],
864
+ # }
865
+ #
866
+ # @!attribute [rw] cluster_name
867
+ # The snapshot is created from this cluster.
868
+ # @return [String]
869
+ #
870
+ # @!attribute [rw] snapshot_name
871
+ # A name for the snapshot being created.
872
+ # @return [String]
873
+ #
874
+ # @!attribute [rw] kms_key_id
875
+ # The ID of the KMS key used to encrypt the snapshot.
876
+ # @return [String]
877
+ #
878
+ # @!attribute [rw] tags
879
+ # A list of tags to be added to this resource. A tag is a key-value
880
+ # pair. A tag key must be accompanied by a tag value, although null is
881
+ # accepted.
882
+ # @return [Array<Types::Tag>]
883
+ #
884
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CreateSnapshotRequest AWS API Documentation
885
+ #
886
+ class CreateSnapshotRequest < Struct.new(
887
+ :cluster_name,
888
+ :snapshot_name,
889
+ :kms_key_id,
890
+ :tags)
891
+ SENSITIVE = []
892
+ include Aws::Structure
893
+ end
894
+
895
+ # @!attribute [rw] snapshot
896
+ # The newly-created snapshot.
897
+ # @return [Types::Snapshot]
898
+ #
899
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CreateSnapshotResponse AWS API Documentation
900
+ #
901
+ class CreateSnapshotResponse < Struct.new(
902
+ :snapshot)
903
+ SENSITIVE = []
904
+ include Aws::Structure
905
+ end
906
+
907
+ # @note When making an API call, you may pass CreateSubnetGroupRequest
908
+ # data as a hash:
909
+ #
910
+ # {
911
+ # subnet_group_name: "String", # required
912
+ # description: "String",
913
+ # subnet_ids: ["String"], # required
914
+ # tags: [
915
+ # {
916
+ # key: "String",
917
+ # value: "String",
918
+ # },
919
+ # ],
920
+ # }
921
+ #
922
+ # @!attribute [rw] subnet_group_name
923
+ # The name of the subnet group.
924
+ # @return [String]
925
+ #
926
+ # @!attribute [rw] description
927
+ # A description for the subnet group.
928
+ # @return [String]
929
+ #
930
+ # @!attribute [rw] subnet_ids
931
+ # A list of VPC subnet IDs for the subnet group.
932
+ # @return [Array<String>]
933
+ #
934
+ # @!attribute [rw] tags
935
+ # A list of tags to be added to this resource. A tag is a key-value
936
+ # pair. A tag key must be accompanied by a tag value, although null is
937
+ # accepted.
938
+ # @return [Array<Types::Tag>]
939
+ #
940
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CreateSubnetGroupRequest AWS API Documentation
941
+ #
942
+ class CreateSubnetGroupRequest < Struct.new(
943
+ :subnet_group_name,
944
+ :description,
945
+ :subnet_ids,
946
+ :tags)
947
+ SENSITIVE = []
948
+ include Aws::Structure
949
+ end
950
+
951
+ # @!attribute [rw] subnet_group
952
+ # The newly-created subnet group
953
+ # @return [Types::SubnetGroup]
954
+ #
955
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CreateSubnetGroupResponse AWS API Documentation
956
+ #
957
+ class CreateSubnetGroupResponse < Struct.new(
958
+ :subnet_group)
959
+ SENSITIVE = []
960
+ include Aws::Structure
961
+ end
962
+
963
+ # @note When making an API call, you may pass CreateUserRequest
964
+ # data as a hash:
965
+ #
966
+ # {
967
+ # user_name: "UserName", # required
968
+ # authentication_mode: { # required
969
+ # type: "password", # accepts password
970
+ # passwords: ["String"],
971
+ # },
972
+ # access_string: "AccessString", # required
973
+ # tags: [
974
+ # {
975
+ # key: "String",
976
+ # value: "String",
977
+ # },
978
+ # ],
979
+ # }
980
+ #
981
+ # @!attribute [rw] user_name
982
+ # The name of the user. This value must be unique as it also serves as
983
+ # the user identifier.
984
+ # @return [String]
985
+ #
986
+ # @!attribute [rw] authentication_mode
987
+ # Denotes the user's authentication properties, such as whether it
988
+ # requires a password to authenticate.
989
+ # @return [Types::AuthenticationMode]
990
+ #
991
+ # @!attribute [rw] access_string
992
+ # Access permissions string used for this user.
993
+ # @return [String]
994
+ #
995
+ # @!attribute [rw] tags
996
+ # A list of tags to be added to this resource. A tag is a key-value
997
+ # pair. A tag key must be accompanied by a tag value, although null is
998
+ # accepted.
999
+ # @return [Array<Types::Tag>]
1000
+ #
1001
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CreateUserRequest AWS API Documentation
1002
+ #
1003
+ class CreateUserRequest < Struct.new(
1004
+ :user_name,
1005
+ :authentication_mode,
1006
+ :access_string,
1007
+ :tags)
1008
+ SENSITIVE = []
1009
+ include Aws::Structure
1010
+ end
1011
+
1012
+ # @!attribute [rw] user
1013
+ # The newly-created user.
1014
+ # @return [Types::User]
1015
+ #
1016
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/CreateUserResponse AWS API Documentation
1017
+ #
1018
+ class CreateUserResponse < Struct.new(
1019
+ :user)
1020
+ SENSITIVE = []
1021
+ include Aws::Structure
1022
+ end
1023
+
1024
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DefaultUserRequired AWS API Documentation
1025
+ #
1026
+ class DefaultUserRequired < Aws::EmptyStructure; end
1027
+
1028
+ # @note When making an API call, you may pass DeleteACLRequest
1029
+ # data as a hash:
1030
+ #
1031
+ # {
1032
+ # acl_name: "String", # required
1033
+ # }
1034
+ #
1035
+ # @!attribute [rw] acl_name
1036
+ # The name of the Access Control List to delete
1037
+ # @return [String]
1038
+ #
1039
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DeleteACLRequest AWS API Documentation
1040
+ #
1041
+ class DeleteACLRequest < Struct.new(
1042
+ :acl_name)
1043
+ SENSITIVE = []
1044
+ include Aws::Structure
1045
+ end
1046
+
1047
+ # @!attribute [rw] acl
1048
+ # The Access Control List object that has been deleted.
1049
+ # @return [Types::ACL]
1050
+ #
1051
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DeleteACLResponse AWS API Documentation
1052
+ #
1053
+ class DeleteACLResponse < Struct.new(
1054
+ :acl)
1055
+ SENSITIVE = []
1056
+ include Aws::Structure
1057
+ end
1058
+
1059
+ # @note When making an API call, you may pass DeleteClusterRequest
1060
+ # data as a hash:
1061
+ #
1062
+ # {
1063
+ # cluster_name: "String", # required
1064
+ # final_snapshot_name: "String",
1065
+ # }
1066
+ #
1067
+ # @!attribute [rw] cluster_name
1068
+ # The name of the cluster to be deleted
1069
+ # @return [String]
1070
+ #
1071
+ # @!attribute [rw] final_snapshot_name
1072
+ # The user-supplied name of a final cluster snapshot. This is the
1073
+ # unique name that identifies the snapshot. MemoryDB creates the
1074
+ # snapshot, and then deletes the cluster immediately afterward.
1075
+ # @return [String]
1076
+ #
1077
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DeleteClusterRequest AWS API Documentation
1078
+ #
1079
+ class DeleteClusterRequest < Struct.new(
1080
+ :cluster_name,
1081
+ :final_snapshot_name)
1082
+ SENSITIVE = []
1083
+ include Aws::Structure
1084
+ end
1085
+
1086
+ # @!attribute [rw] cluster
1087
+ # The cluster object that has been deleted
1088
+ # @return [Types::Cluster]
1089
+ #
1090
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DeleteClusterResponse AWS API Documentation
1091
+ #
1092
+ class DeleteClusterResponse < Struct.new(
1093
+ :cluster)
1094
+ SENSITIVE = []
1095
+ include Aws::Structure
1096
+ end
1097
+
1098
+ # @note When making an API call, you may pass DeleteParameterGroupRequest
1099
+ # data as a hash:
1100
+ #
1101
+ # {
1102
+ # parameter_group_name: "String", # required
1103
+ # }
1104
+ #
1105
+ # @!attribute [rw] parameter_group_name
1106
+ # The name of the parameter group to delete.
1107
+ # @return [String]
1108
+ #
1109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DeleteParameterGroupRequest AWS API Documentation
1110
+ #
1111
+ class DeleteParameterGroupRequest < Struct.new(
1112
+ :parameter_group_name)
1113
+ SENSITIVE = []
1114
+ include Aws::Structure
1115
+ end
1116
+
1117
+ # @!attribute [rw] parameter_group
1118
+ # The parameter group that has been deleted.
1119
+ # @return [Types::ParameterGroup]
1120
+ #
1121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DeleteParameterGroupResponse AWS API Documentation
1122
+ #
1123
+ class DeleteParameterGroupResponse < Struct.new(
1124
+ :parameter_group)
1125
+ SENSITIVE = []
1126
+ include Aws::Structure
1127
+ end
1128
+
1129
+ # @note When making an API call, you may pass DeleteSnapshotRequest
1130
+ # data as a hash:
1131
+ #
1132
+ # {
1133
+ # snapshot_name: "String", # required
1134
+ # }
1135
+ #
1136
+ # @!attribute [rw] snapshot_name
1137
+ # The name of the snapshot to delete
1138
+ # @return [String]
1139
+ #
1140
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DeleteSnapshotRequest AWS API Documentation
1141
+ #
1142
+ class DeleteSnapshotRequest < Struct.new(
1143
+ :snapshot_name)
1144
+ SENSITIVE = []
1145
+ include Aws::Structure
1146
+ end
1147
+
1148
+ # @!attribute [rw] snapshot
1149
+ # The snapshot object that has been deleted.
1150
+ # @return [Types::Snapshot]
1151
+ #
1152
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DeleteSnapshotResponse AWS API Documentation
1153
+ #
1154
+ class DeleteSnapshotResponse < Struct.new(
1155
+ :snapshot)
1156
+ SENSITIVE = []
1157
+ include Aws::Structure
1158
+ end
1159
+
1160
+ # @note When making an API call, you may pass DeleteSubnetGroupRequest
1161
+ # data as a hash:
1162
+ #
1163
+ # {
1164
+ # subnet_group_name: "String", # required
1165
+ # }
1166
+ #
1167
+ # @!attribute [rw] subnet_group_name
1168
+ # The name of the subnet group to delete
1169
+ # @return [String]
1170
+ #
1171
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DeleteSubnetGroupRequest AWS API Documentation
1172
+ #
1173
+ class DeleteSubnetGroupRequest < Struct.new(
1174
+ :subnet_group_name)
1175
+ SENSITIVE = []
1176
+ include Aws::Structure
1177
+ end
1178
+
1179
+ # @!attribute [rw] subnet_group
1180
+ # The subnet group object that has been deleted.
1181
+ # @return [Types::SubnetGroup]
1182
+ #
1183
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DeleteSubnetGroupResponse AWS API Documentation
1184
+ #
1185
+ class DeleteSubnetGroupResponse < Struct.new(
1186
+ :subnet_group)
1187
+ SENSITIVE = []
1188
+ include Aws::Structure
1189
+ end
1190
+
1191
+ # @note When making an API call, you may pass DeleteUserRequest
1192
+ # data as a hash:
1193
+ #
1194
+ # {
1195
+ # user_name: "UserName", # required
1196
+ # }
1197
+ #
1198
+ # @!attribute [rw] user_name
1199
+ # The name of the user to delete
1200
+ # @return [String]
1201
+ #
1202
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DeleteUserRequest AWS API Documentation
1203
+ #
1204
+ class DeleteUserRequest < Struct.new(
1205
+ :user_name)
1206
+ SENSITIVE = []
1207
+ include Aws::Structure
1208
+ end
1209
+
1210
+ # @!attribute [rw] user
1211
+ # The user object that has been deleted.
1212
+ # @return [Types::User]
1213
+ #
1214
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DeleteUserResponse AWS API Documentation
1215
+ #
1216
+ class DeleteUserResponse < Struct.new(
1217
+ :user)
1218
+ SENSITIVE = []
1219
+ include Aws::Structure
1220
+ end
1221
+
1222
+ # @note When making an API call, you may pass DescribeACLsRequest
1223
+ # data as a hash:
1224
+ #
1225
+ # {
1226
+ # acl_name: "String",
1227
+ # max_results: 1,
1228
+ # next_token: "String",
1229
+ # }
1230
+ #
1231
+ # @!attribute [rw] acl_name
1232
+ # The name of the ACL
1233
+ # @return [String]
1234
+ #
1235
+ # @!attribute [rw] max_results
1236
+ # The maximum number of records to include in the response. If more
1237
+ # records exist than the specified MaxResults value, a token is
1238
+ # included in the response so that the remaining results can be
1239
+ # retrieved.
1240
+ # @return [Integer]
1241
+ #
1242
+ # @!attribute [rw] next_token
1243
+ # An optional argument to pass in case the total number of records
1244
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1245
+ # more results available. The value of nextToken is a unique
1246
+ # pagination token for each page. Make the call again using the
1247
+ # returned token to retrieve the next page. Keep all other arguments
1248
+ # unchanged.
1249
+ # @return [String]
1250
+ #
1251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeACLsRequest AWS API Documentation
1252
+ #
1253
+ class DescribeACLsRequest < Struct.new(
1254
+ :acl_name,
1255
+ :max_results,
1256
+ :next_token)
1257
+ SENSITIVE = []
1258
+ include Aws::Structure
1259
+ end
1260
+
1261
+ # @!attribute [rw] acls
1262
+ # The list of ACLs
1263
+ # @return [Array<Types::ACL>]
1264
+ #
1265
+ # @!attribute [rw] next_token
1266
+ # If nextToken is returned, there are more results available. The
1267
+ # value of nextToken is a unique pagination token for each page. Make
1268
+ # the call again using the returned token to retrieve the next page.
1269
+ # Keep all other arguments unchanged.
1270
+ # @return [String]
1271
+ #
1272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeACLsResponse AWS API Documentation
1273
+ #
1274
+ class DescribeACLsResponse < Struct.new(
1275
+ :acls,
1276
+ :next_token)
1277
+ SENSITIVE = []
1278
+ include Aws::Structure
1279
+ end
1280
+
1281
+ # @note When making an API call, you may pass DescribeClustersRequest
1282
+ # data as a hash:
1283
+ #
1284
+ # {
1285
+ # cluster_name: "String",
1286
+ # max_results: 1,
1287
+ # next_token: "String",
1288
+ # show_shard_details: false,
1289
+ # }
1290
+ #
1291
+ # @!attribute [rw] cluster_name
1292
+ # The name of the cluster
1293
+ # @return [String]
1294
+ #
1295
+ # @!attribute [rw] max_results
1296
+ # The maximum number of records to include in the response. If more
1297
+ # records exist than the specified MaxResults value, a token is
1298
+ # included in the response so that the remaining results can be
1299
+ # retrieved.
1300
+ # @return [Integer]
1301
+ #
1302
+ # @!attribute [rw] next_token
1303
+ # An optional argument to pass in case the total number of records
1304
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1305
+ # more results available. The value of nextToken is a unique
1306
+ # pagination token for each page. Make the call again using the
1307
+ # returned token to retrieve the next page. Keep all other arguments
1308
+ # unchanged.
1309
+ # @return [String]
1310
+ #
1311
+ # @!attribute [rw] show_shard_details
1312
+ # An optional flag that can be included in the request to retrieve
1313
+ # information about the individual shard(s).
1314
+ # @return [Boolean]
1315
+ #
1316
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeClustersRequest AWS API Documentation
1317
+ #
1318
+ class DescribeClustersRequest < Struct.new(
1319
+ :cluster_name,
1320
+ :max_results,
1321
+ :next_token,
1322
+ :show_shard_details)
1323
+ SENSITIVE = []
1324
+ include Aws::Structure
1325
+ end
1326
+
1327
+ # @!attribute [rw] next_token
1328
+ # An optional argument to pass in case the total number of records
1329
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1330
+ # more results available. The value of nextToken is a unique
1331
+ # pagination token for each page. Make the call again using the
1332
+ # returned token to retrieve the next page. Keep all other arguments
1333
+ # unchanged.
1334
+ # @return [String]
1335
+ #
1336
+ # @!attribute [rw] clusters
1337
+ # A list of clusters
1338
+ # @return [Array<Types::Cluster>]
1339
+ #
1340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeClustersResponse AWS API Documentation
1341
+ #
1342
+ class DescribeClustersResponse < Struct.new(
1343
+ :next_token,
1344
+ :clusters)
1345
+ SENSITIVE = []
1346
+ include Aws::Structure
1347
+ end
1348
+
1349
+ # @note When making an API call, you may pass DescribeEngineVersionsRequest
1350
+ # data as a hash:
1351
+ #
1352
+ # {
1353
+ # engine_version: "String",
1354
+ # parameter_group_family: "String",
1355
+ # max_results: 1,
1356
+ # next_token: "String",
1357
+ # default_only: false,
1358
+ # }
1359
+ #
1360
+ # @!attribute [rw] engine_version
1361
+ # The Redis engine version
1362
+ # @return [String]
1363
+ #
1364
+ # @!attribute [rw] parameter_group_family
1365
+ # The name of a specific parameter group family to return details for.
1366
+ # @return [String]
1367
+ #
1368
+ # @!attribute [rw] max_results
1369
+ # The maximum number of records to include in the response. If more
1370
+ # records exist than the specified MaxResults value, a token is
1371
+ # included in the response so that the remaining results can be
1372
+ # retrieved.
1373
+ # @return [Integer]
1374
+ #
1375
+ # @!attribute [rw] next_token
1376
+ # An optional argument to pass in case the total number of records
1377
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1378
+ # more results available. The value of nextToken is a unique
1379
+ # pagination token for each page. Make the call again using the
1380
+ # returned token to retrieve the next page. Keep all other arguments
1381
+ # unchanged.
1382
+ # @return [String]
1383
+ #
1384
+ # @!attribute [rw] default_only
1385
+ # If true, specifies that only the default version of the specified
1386
+ # engine or engine and major version combination is to be returned.
1387
+ # @return [Boolean]
1388
+ #
1389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeEngineVersionsRequest AWS API Documentation
1390
+ #
1391
+ class DescribeEngineVersionsRequest < Struct.new(
1392
+ :engine_version,
1393
+ :parameter_group_family,
1394
+ :max_results,
1395
+ :next_token,
1396
+ :default_only)
1397
+ SENSITIVE = []
1398
+ include Aws::Structure
1399
+ end
1400
+
1401
+ # @!attribute [rw] next_token
1402
+ # An optional argument to pass in case the total number of records
1403
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1404
+ # more results available. The value of nextToken is a unique
1405
+ # pagination token for each page. Make the call again using the
1406
+ # returned token to retrieve the next page. Keep all other arguments
1407
+ # unchanged.
1408
+ # @return [String]
1409
+ #
1410
+ # @!attribute [rw] engine_versions
1411
+ # A list of engine version details. Each element in the list contains
1412
+ # detailed information about one engine version.
1413
+ # @return [Array<Types::EngineVersionInfo>]
1414
+ #
1415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeEngineVersionsResponse AWS API Documentation
1416
+ #
1417
+ class DescribeEngineVersionsResponse < Struct.new(
1418
+ :next_token,
1419
+ :engine_versions)
1420
+ SENSITIVE = []
1421
+ include Aws::Structure
1422
+ end
1423
+
1424
+ # @note When making an API call, you may pass DescribeEventsRequest
1425
+ # data as a hash:
1426
+ #
1427
+ # {
1428
+ # source_name: "String",
1429
+ # source_type: "node", # accepts node, parameter-group, subnet-group, cluster, user, acl
1430
+ # start_time: Time.now,
1431
+ # end_time: Time.now,
1432
+ # duration: 1,
1433
+ # max_results: 1,
1434
+ # next_token: "String",
1435
+ # }
1436
+ #
1437
+ # @!attribute [rw] source_name
1438
+ # The identifier of the event source for which events are returned. If
1439
+ # not specified, all sources are included in the response.
1440
+ # @return [String]
1441
+ #
1442
+ # @!attribute [rw] source_type
1443
+ # The event source to retrieve events for. If no value is specified,
1444
+ # all events are returned.
1445
+ # @return [String]
1446
+ #
1447
+ # @!attribute [rw] start_time
1448
+ # The beginning of the time interval to retrieve events for, specified
1449
+ # in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
1450
+ # @return [Time]
1451
+ #
1452
+ # @!attribute [rw] end_time
1453
+ # The end of the time interval for which to retrieve events, specified
1454
+ # in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
1455
+ # @return [Time]
1456
+ #
1457
+ # @!attribute [rw] duration
1458
+ # The number of minutes worth of events to retrieve.
1459
+ # @return [Integer]
1460
+ #
1461
+ # @!attribute [rw] max_results
1462
+ # The maximum number of records to include in the response. If more
1463
+ # records exist than the specified MaxResults value, a token is
1464
+ # included in the response so that the remaining results can be
1465
+ # retrieved.
1466
+ # @return [Integer]
1467
+ #
1468
+ # @!attribute [rw] next_token
1469
+ # An optional argument to pass in case the total number of records
1470
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1471
+ # more results available. The value of nextToken is a unique
1472
+ # pagination token for each page. Make the call again using the
1473
+ # returned token to retrieve the next page. Keep all other arguments
1474
+ # unchanged.
1475
+ # @return [String]
1476
+ #
1477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeEventsRequest AWS API Documentation
1478
+ #
1479
+ class DescribeEventsRequest < Struct.new(
1480
+ :source_name,
1481
+ :source_type,
1482
+ :start_time,
1483
+ :end_time,
1484
+ :duration,
1485
+ :max_results,
1486
+ :next_token)
1487
+ SENSITIVE = []
1488
+ include Aws::Structure
1489
+ end
1490
+
1491
+ # @!attribute [rw] next_token
1492
+ # An optional argument to pass in case the total number of records
1493
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1494
+ # more results available. The value of nextToken is a unique
1495
+ # pagination token for each page. Make the call again using the
1496
+ # returned token to retrieve the next page. Keep all other arguments
1497
+ # unchanged.
1498
+ # @return [String]
1499
+ #
1500
+ # @!attribute [rw] events
1501
+ # A list of events. Each element in the list contains detailed
1502
+ # information about one event.
1503
+ # @return [Array<Types::Event>]
1504
+ #
1505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeEventsResponse AWS API Documentation
1506
+ #
1507
+ class DescribeEventsResponse < Struct.new(
1508
+ :next_token,
1509
+ :events)
1510
+ SENSITIVE = []
1511
+ include Aws::Structure
1512
+ end
1513
+
1514
+ # @note When making an API call, you may pass DescribeParameterGroupsRequest
1515
+ # data as a hash:
1516
+ #
1517
+ # {
1518
+ # parameter_group_name: "String",
1519
+ # max_results: 1,
1520
+ # next_token: "String",
1521
+ # }
1522
+ #
1523
+ # @!attribute [rw] parameter_group_name
1524
+ # The name of a specific parameter group to return details for.
1525
+ # @return [String]
1526
+ #
1527
+ # @!attribute [rw] max_results
1528
+ # The maximum number of records to include in the response. If more
1529
+ # records exist than the specified MaxResults value, a token is
1530
+ # included in the response so that the remaining results can be
1531
+ # retrieved.
1532
+ # @return [Integer]
1533
+ #
1534
+ # @!attribute [rw] next_token
1535
+ # An optional argument to pass in case the total number of records
1536
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1537
+ # more results available. The value of nextToken is a unique
1538
+ # pagination token for each page. Make the call again using the
1539
+ # returned token to retrieve the next page. Keep all other arguments
1540
+ # unchanged.
1541
+ # @return [String]
1542
+ #
1543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeParameterGroupsRequest AWS API Documentation
1544
+ #
1545
+ class DescribeParameterGroupsRequest < Struct.new(
1546
+ :parameter_group_name,
1547
+ :max_results,
1548
+ :next_token)
1549
+ SENSITIVE = []
1550
+ include Aws::Structure
1551
+ end
1552
+
1553
+ # @!attribute [rw] next_token
1554
+ # An optional argument to pass in case the total number of records
1555
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1556
+ # more results available. The value of nextToken is a unique
1557
+ # pagination token for each page. Make the call again using the
1558
+ # returned token to retrieve the next page. Keep all other arguments
1559
+ # unchanged.
1560
+ # @return [String]
1561
+ #
1562
+ # @!attribute [rw] parameter_groups
1563
+ # A list of parameter groups. Each element in the list contains
1564
+ # detailed information about one parameter group.
1565
+ # @return [Array<Types::ParameterGroup>]
1566
+ #
1567
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeParameterGroupsResponse AWS API Documentation
1568
+ #
1569
+ class DescribeParameterGroupsResponse < Struct.new(
1570
+ :next_token,
1571
+ :parameter_groups)
1572
+ SENSITIVE = []
1573
+ include Aws::Structure
1574
+ end
1575
+
1576
+ # @note When making an API call, you may pass DescribeParametersRequest
1577
+ # data as a hash:
1578
+ #
1579
+ # {
1580
+ # parameter_group_name: "String", # required
1581
+ # max_results: 1,
1582
+ # next_token: "String",
1583
+ # }
1584
+ #
1585
+ # @!attribute [rw] parameter_group_name
1586
+ # he name of a specific parameter group to return details for.
1587
+ # @return [String]
1588
+ #
1589
+ # @!attribute [rw] max_results
1590
+ # The maximum number of records to include in the response. If more
1591
+ # records exist than the specified MaxResults value, a token is
1592
+ # included in the response so that the remaining results can be
1593
+ # retrieved.
1594
+ # @return [Integer]
1595
+ #
1596
+ # @!attribute [rw] next_token
1597
+ # An optional argument to pass in case the total number of records
1598
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1599
+ # more results available. The value of nextToken is a unique
1600
+ # pagination token for each page. Make the call again using the
1601
+ # returned token to retrieve the next page. Keep all other arguments
1602
+ # unchanged.
1603
+ # @return [String]
1604
+ #
1605
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeParametersRequest AWS API Documentation
1606
+ #
1607
+ class DescribeParametersRequest < Struct.new(
1608
+ :parameter_group_name,
1609
+ :max_results,
1610
+ :next_token)
1611
+ SENSITIVE = []
1612
+ include Aws::Structure
1613
+ end
1614
+
1615
+ # @!attribute [rw] next_token
1616
+ # An optional argument to pass in case the total number of records
1617
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1618
+ # more results available. The value of nextToken is a unique
1619
+ # pagination token for each page. Make the call again using the
1620
+ # returned token to retrieve the next page. Keep all other arguments
1621
+ # unchanged.
1622
+ # @return [String]
1623
+ #
1624
+ # @!attribute [rw] parameters
1625
+ # A list of parameters specific to a particular parameter group. Each
1626
+ # element in the list contains detailed information about one
1627
+ # parameter.
1628
+ # @return [Array<Types::Parameter>]
1629
+ #
1630
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeParametersResponse AWS API Documentation
1631
+ #
1632
+ class DescribeParametersResponse < Struct.new(
1633
+ :next_token,
1634
+ :parameters)
1635
+ SENSITIVE = []
1636
+ include Aws::Structure
1637
+ end
1638
+
1639
+ # @note When making an API call, you may pass DescribeServiceUpdatesRequest
1640
+ # data as a hash:
1641
+ #
1642
+ # {
1643
+ # service_update_name: "String",
1644
+ # cluster_names: ["String"],
1645
+ # status: ["available"], # accepts available, in-progress, complete, scheduled
1646
+ # max_results: 1,
1647
+ # next_token: "String",
1648
+ # }
1649
+ #
1650
+ # @!attribute [rw] service_update_name
1651
+ # The unique ID of the service update to describe.
1652
+ # @return [String]
1653
+ #
1654
+ # @!attribute [rw] cluster_names
1655
+ # The list of cluster names to identify service updates to apply
1656
+ # @return [Array<String>]
1657
+ #
1658
+ # @!attribute [rw] status
1659
+ # The status(es) of the service updates to filter on
1660
+ # @return [Array<String>]
1661
+ #
1662
+ # @!attribute [rw] max_results
1663
+ # The maximum number of records to include in the response. If more
1664
+ # records exist than the specified MaxResults value, a token is
1665
+ # included in the response so that the remaining results can be
1666
+ # retrieved.
1667
+ # @return [Integer]
1668
+ #
1669
+ # @!attribute [rw] next_token
1670
+ # An optional argument to pass in case the total number of records
1671
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1672
+ # more results available. The value of nextToken is a unique
1673
+ # pagination token for each page. Make the call again using the
1674
+ # returned token to retrieve the next page. Keep all other arguments
1675
+ # unchanged.
1676
+ # @return [String]
1677
+ #
1678
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeServiceUpdatesRequest AWS API Documentation
1679
+ #
1680
+ class DescribeServiceUpdatesRequest < Struct.new(
1681
+ :service_update_name,
1682
+ :cluster_names,
1683
+ :status,
1684
+ :max_results,
1685
+ :next_token)
1686
+ SENSITIVE = []
1687
+ include Aws::Structure
1688
+ end
1689
+
1690
+ # @!attribute [rw] next_token
1691
+ # An optional argument to pass in case the total number of records
1692
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1693
+ # more results available. The value of nextToken is a unique
1694
+ # pagination token for each page. Make the call again using the
1695
+ # returned token to retrieve the next page. Keep all other arguments
1696
+ # unchanged.
1697
+ # @return [String]
1698
+ #
1699
+ # @!attribute [rw] service_updates
1700
+ # A list of service updates
1701
+ # @return [Array<Types::ServiceUpdate>]
1702
+ #
1703
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeServiceUpdatesResponse AWS API Documentation
1704
+ #
1705
+ class DescribeServiceUpdatesResponse < Struct.new(
1706
+ :next_token,
1707
+ :service_updates)
1708
+ SENSITIVE = []
1709
+ include Aws::Structure
1710
+ end
1711
+
1712
+ # @note When making an API call, you may pass DescribeSnapshotsRequest
1713
+ # data as a hash:
1714
+ #
1715
+ # {
1716
+ # cluster_name: "String",
1717
+ # snapshot_name: "String",
1718
+ # source: "String",
1719
+ # next_token: "String",
1720
+ # max_results: 1,
1721
+ # show_detail: false,
1722
+ # }
1723
+ #
1724
+ # @!attribute [rw] cluster_name
1725
+ # A user-supplied cluster identifier. If this parameter is specified,
1726
+ # only snapshots associated with that specific cluster are described.
1727
+ # @return [String]
1728
+ #
1729
+ # @!attribute [rw] snapshot_name
1730
+ # A user-supplied name of the snapshot. If this parameter is
1731
+ # specified, only this named snapshot is described.
1732
+ # @return [String]
1733
+ #
1734
+ # @!attribute [rw] source
1735
+ # If set to system, the output shows snapshots that were automatically
1736
+ # created by MemoryDB. If set to user the output shows snapshots that
1737
+ # were manually created. If omitted, the output shows both
1738
+ # automatically and manually created snapshots.
1739
+ # @return [String]
1740
+ #
1741
+ # @!attribute [rw] next_token
1742
+ # An optional argument to pass in case the total number of records
1743
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1744
+ # more results available. The value of nextToken is a unique
1745
+ # pagination token for each page. Make the call again using the
1746
+ # returned token to retrieve the next page. Keep all other arguments
1747
+ # unchanged.
1748
+ # @return [String]
1749
+ #
1750
+ # @!attribute [rw] max_results
1751
+ # The maximum number of records to include in the response. If more
1752
+ # records exist than the specified MaxResults value, a token is
1753
+ # included in the response so that the remaining results can be
1754
+ # retrieved.
1755
+ # @return [Integer]
1756
+ #
1757
+ # @!attribute [rw] show_detail
1758
+ # A Boolean value which if true, the shard configuration is included
1759
+ # in the snapshot description.
1760
+ # @return [Boolean]
1761
+ #
1762
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeSnapshotsRequest AWS API Documentation
1763
+ #
1764
+ class DescribeSnapshotsRequest < Struct.new(
1765
+ :cluster_name,
1766
+ :snapshot_name,
1767
+ :source,
1768
+ :next_token,
1769
+ :max_results,
1770
+ :show_detail)
1771
+ SENSITIVE = []
1772
+ include Aws::Structure
1773
+ end
1774
+
1775
+ # @!attribute [rw] next_token
1776
+ # An optional argument to pass in case the total number of records
1777
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1778
+ # more results available. The value of nextToken is a unique
1779
+ # pagination token for each page. Make the call again using the
1780
+ # returned token to retrieve the next page. Keep all other arguments
1781
+ # unchanged.
1782
+ # @return [String]
1783
+ #
1784
+ # @!attribute [rw] snapshots
1785
+ # A list of snapshots. Each item in the list contains detailed
1786
+ # information about one snapshot.
1787
+ # @return [Array<Types::Snapshot>]
1788
+ #
1789
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeSnapshotsResponse AWS API Documentation
1790
+ #
1791
+ class DescribeSnapshotsResponse < Struct.new(
1792
+ :next_token,
1793
+ :snapshots)
1794
+ SENSITIVE = []
1795
+ include Aws::Structure
1796
+ end
1797
+
1798
+ # @note When making an API call, you may pass DescribeSubnetGroupsRequest
1799
+ # data as a hash:
1800
+ #
1801
+ # {
1802
+ # subnet_group_name: "String",
1803
+ # max_results: 1,
1804
+ # next_token: "String",
1805
+ # }
1806
+ #
1807
+ # @!attribute [rw] subnet_group_name
1808
+ # The name of the subnet group to return details for.
1809
+ # @return [String]
1810
+ #
1811
+ # @!attribute [rw] max_results
1812
+ # The maximum number of records to include in the response. If more
1813
+ # records exist than the specified MaxResults value, a token is
1814
+ # included in the response so that the remaining results can be
1815
+ # retrieved.
1816
+ # @return [Integer]
1817
+ #
1818
+ # @!attribute [rw] next_token
1819
+ # An optional argument to pass in case the total number of records
1820
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1821
+ # more results available. The value of nextToken is a unique
1822
+ # pagination token for each page. Make the call again using the
1823
+ # returned token to retrieve the next page. Keep all other arguments
1824
+ # unchanged.
1825
+ # @return [String]
1826
+ #
1827
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeSubnetGroupsRequest AWS API Documentation
1828
+ #
1829
+ class DescribeSubnetGroupsRequest < Struct.new(
1830
+ :subnet_group_name,
1831
+ :max_results,
1832
+ :next_token)
1833
+ SENSITIVE = []
1834
+ include Aws::Structure
1835
+ end
1836
+
1837
+ # @!attribute [rw] next_token
1838
+ # An optional argument to pass in case the total number of records
1839
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1840
+ # more results available. The value of nextToken is a unique
1841
+ # pagination token for each page. Make the call again using the
1842
+ # returned token to retrieve the next page. Keep all other arguments
1843
+ # unchanged.
1844
+ # @return [String]
1845
+ #
1846
+ # @!attribute [rw] subnet_groups
1847
+ # A list of subnet groups. Each element in the list contains detailed
1848
+ # information about one group.
1849
+ # @return [Array<Types::SubnetGroup>]
1850
+ #
1851
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeSubnetGroupsResponse AWS API Documentation
1852
+ #
1853
+ class DescribeSubnetGroupsResponse < Struct.new(
1854
+ :next_token,
1855
+ :subnet_groups)
1856
+ SENSITIVE = []
1857
+ include Aws::Structure
1858
+ end
1859
+
1860
+ # @note When making an API call, you may pass DescribeUsersRequest
1861
+ # data as a hash:
1862
+ #
1863
+ # {
1864
+ # user_name: "UserName",
1865
+ # filters: [
1866
+ # {
1867
+ # name: "FilterName", # required
1868
+ # values: ["FilterValue"], # required
1869
+ # },
1870
+ # ],
1871
+ # max_results: 1,
1872
+ # next_token: "String",
1873
+ # }
1874
+ #
1875
+ # @!attribute [rw] user_name
1876
+ # The name of the user
1877
+ # @return [String]
1878
+ #
1879
+ # @!attribute [rw] filters
1880
+ # Filter to determine the list of users to return.
1881
+ # @return [Array<Types::Filter>]
1882
+ #
1883
+ # @!attribute [rw] max_results
1884
+ # The maximum number of records to include in the response. If more
1885
+ # records exist than the specified MaxResults value, a token is
1886
+ # included in the response so that the remaining results can be
1887
+ # retrieved.
1888
+ # @return [Integer]
1889
+ #
1890
+ # @!attribute [rw] next_token
1891
+ # An optional argument to pass in case the total number of records
1892
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1893
+ # more results available. The value of nextToken is a unique
1894
+ # pagination token for each page. Make the call again using the
1895
+ # returned token to retrieve the next page. Keep all other arguments
1896
+ # unchanged.
1897
+ # @return [String]
1898
+ #
1899
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeUsersRequest AWS API Documentation
1900
+ #
1901
+ class DescribeUsersRequest < Struct.new(
1902
+ :user_name,
1903
+ :filters,
1904
+ :max_results,
1905
+ :next_token)
1906
+ SENSITIVE = []
1907
+ include Aws::Structure
1908
+ end
1909
+
1910
+ # @!attribute [rw] users
1911
+ # A list of users.
1912
+ # @return [Array<Types::User>]
1913
+ #
1914
+ # @!attribute [rw] next_token
1915
+ # An optional argument to pass in case the total number of records
1916
+ # exceeds the value of MaxResults. If nextToken is returned, there are
1917
+ # more results available. The value of nextToken is a unique
1918
+ # pagination token for each page. Make the call again using the
1919
+ # returned token to retrieve the next page. Keep all other arguments
1920
+ # unchanged.
1921
+ # @return [String]
1922
+ #
1923
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeUsersResponse AWS API Documentation
1924
+ #
1925
+ class DescribeUsersResponse < Struct.new(
1926
+ :users,
1927
+ :next_token)
1928
+ SENSITIVE = []
1929
+ include Aws::Structure
1930
+ end
1931
+
1932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DuplicateUserNameFault AWS API Documentation
1933
+ #
1934
+ class DuplicateUserNameFault < Aws::EmptyStructure; end
1935
+
1936
+ # Represents the information required for client programs to connect to
1937
+ # the cluster and its nodes.
1938
+ #
1939
+ # @!attribute [rw] address
1940
+ # The DNS hostname of the node.
1941
+ # @return [String]
1942
+ #
1943
+ # @!attribute [rw] port
1944
+ # The port number that the engine is listening on.
1945
+ # @return [Integer]
1946
+ #
1947
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/Endpoint AWS API Documentation
1948
+ #
1949
+ class Endpoint < Struct.new(
1950
+ :address,
1951
+ :port)
1952
+ SENSITIVE = []
1953
+ include Aws::Structure
1954
+ end
1955
+
1956
+ # Provides details of the Redis engine version
1957
+ #
1958
+ # @!attribute [rw] engine_version
1959
+ # The engine version
1960
+ # @return [String]
1961
+ #
1962
+ # @!attribute [rw] engine_patch_version
1963
+ # The patched engine version
1964
+ # @return [String]
1965
+ #
1966
+ # @!attribute [rw] parameter_group_family
1967
+ # Specifies the name of the parameter group family to which the engine
1968
+ # default parameters apply.
1969
+ # @return [String]
1970
+ #
1971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/EngineVersionInfo AWS API Documentation
1972
+ #
1973
+ class EngineVersionInfo < Struct.new(
1974
+ :engine_version,
1975
+ :engine_patch_version,
1976
+ :parameter_group_family)
1977
+ SENSITIVE = []
1978
+ include Aws::Structure
1979
+ end
1980
+
1981
+ # Represents a single occurrence of something interesting within the
1982
+ # system. Some examples of events are creating a cluster or adding or
1983
+ # removing a node.
1984
+ #
1985
+ # @!attribute [rw] source_name
1986
+ # The name for the source of the event. For example, if the event
1987
+ # occurred at the cluster level, the identifier would be the name of
1988
+ # the cluster.
1989
+ # @return [String]
1990
+ #
1991
+ # @!attribute [rw] source_type
1992
+ # Specifies the origin of this event - a cluster, a parameter group, a
1993
+ # security group, etc.
1994
+ # @return [String]
1995
+ #
1996
+ # @!attribute [rw] message
1997
+ # The text of the event.
1998
+ # @return [String]
1999
+ #
2000
+ # @!attribute [rw] date
2001
+ # The date and time when the event occurred.
2002
+ # @return [Time]
2003
+ #
2004
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/Event AWS API Documentation
2005
+ #
2006
+ class Event < Struct.new(
2007
+ :source_name,
2008
+ :source_type,
2009
+ :message,
2010
+ :date)
2011
+ SENSITIVE = []
2012
+ include Aws::Structure
2013
+ end
2014
+
2015
+ # @note When making an API call, you may pass FailoverShardRequest
2016
+ # data as a hash:
2017
+ #
2018
+ # {
2019
+ # cluster_name: "String", # required
2020
+ # shard_name: "String", # required
2021
+ # }
2022
+ #
2023
+ # @!attribute [rw] cluster_name
2024
+ # The cluster being failed over
2025
+ # @return [String]
2026
+ #
2027
+ # @!attribute [rw] shard_name
2028
+ # The name of the shard
2029
+ # @return [String]
2030
+ #
2031
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/FailoverShardRequest AWS API Documentation
2032
+ #
2033
+ class FailoverShardRequest < Struct.new(
2034
+ :cluster_name,
2035
+ :shard_name)
2036
+ SENSITIVE = []
2037
+ include Aws::Structure
2038
+ end
2039
+
2040
+ # @!attribute [rw] cluster
2041
+ # The cluster being failed over
2042
+ # @return [Types::Cluster]
2043
+ #
2044
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/FailoverShardResponse AWS API Documentation
2045
+ #
2046
+ class FailoverShardResponse < Struct.new(
2047
+ :cluster)
2048
+ SENSITIVE = []
2049
+ include Aws::Structure
2050
+ end
2051
+
2052
+ # Used to streamline results of a search based on the property being
2053
+ # filtered.
2054
+ #
2055
+ # @note When making an API call, you may pass Filter
2056
+ # data as a hash:
2057
+ #
2058
+ # {
2059
+ # name: "FilterName", # required
2060
+ # values: ["FilterValue"], # required
2061
+ # }
2062
+ #
2063
+ # @!attribute [rw] name
2064
+ # The property being filtered. For example, UserName.
2065
+ # @return [String]
2066
+ #
2067
+ # @!attribute [rw] values
2068
+ # The property values to filter on. For example, "user-123".
2069
+ # @return [Array<String>]
2070
+ #
2071
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/Filter AWS API Documentation
2072
+ #
2073
+ class Filter < Struct.new(
2074
+ :name,
2075
+ :values)
2076
+ SENSITIVE = []
2077
+ include Aws::Structure
2078
+ end
2079
+
2080
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/InsufficientClusterCapacityFault AWS API Documentation
2081
+ #
2082
+ class InsufficientClusterCapacityFault < Aws::EmptyStructure; end
2083
+
2084
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/InvalidACLStateFault AWS API Documentation
2085
+ #
2086
+ class InvalidACLStateFault < Aws::EmptyStructure; end
2087
+
2088
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/InvalidARNFault AWS API Documentation
2089
+ #
2090
+ class InvalidARNFault < Aws::EmptyStructure; end
2091
+
2092
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/InvalidClusterStateFault AWS API Documentation
2093
+ #
2094
+ class InvalidClusterStateFault < Aws::EmptyStructure; end
2095
+
2096
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/InvalidCredentialsException AWS API Documentation
2097
+ #
2098
+ class InvalidCredentialsException < Aws::EmptyStructure; end
2099
+
2100
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/InvalidKMSKeyFault AWS API Documentation
2101
+ #
2102
+ class InvalidKMSKeyFault < Aws::EmptyStructure; end
2103
+
2104
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/InvalidNodeStateFault AWS API Documentation
2105
+ #
2106
+ class InvalidNodeStateFault < Aws::EmptyStructure; end
2107
+
2108
+ # @!attribute [rw] message
2109
+ # @return [String]
2110
+ #
2111
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/InvalidParameterCombinationException AWS API Documentation
2112
+ #
2113
+ class InvalidParameterCombinationException < Struct.new(
2114
+ :message)
2115
+ SENSITIVE = []
2116
+ include Aws::Structure
2117
+ end
2118
+
2119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/InvalidParameterGroupStateFault AWS API Documentation
2120
+ #
2121
+ class InvalidParameterGroupStateFault < Aws::EmptyStructure; end
2122
+
2123
+ # @!attribute [rw] message
2124
+ # @return [String]
2125
+ #
2126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/InvalidParameterValueException AWS API Documentation
2127
+ #
2128
+ class InvalidParameterValueException < Struct.new(
2129
+ :message)
2130
+ SENSITIVE = []
2131
+ include Aws::Structure
2132
+ end
2133
+
2134
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/InvalidSnapshotStateFault AWS API Documentation
2135
+ #
2136
+ class InvalidSnapshotStateFault < Aws::EmptyStructure; end
2137
+
2138
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/InvalidSubnet AWS API Documentation
2139
+ #
2140
+ class InvalidSubnet < Aws::EmptyStructure; end
2141
+
2142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/InvalidUserStateFault AWS API Documentation
2143
+ #
2144
+ class InvalidUserStateFault < Aws::EmptyStructure; end
2145
+
2146
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/InvalidVPCNetworkStateFault AWS API Documentation
2147
+ #
2148
+ class InvalidVPCNetworkStateFault < Aws::EmptyStructure; end
2149
+
2150
+ # @note When making an API call, you may pass ListAllowedNodeTypeUpdatesRequest
2151
+ # data as a hash:
2152
+ #
2153
+ # {
2154
+ # cluster_name: "String", # required
2155
+ # }
2156
+ #
2157
+ # @!attribute [rw] cluster_name
2158
+ # The name of the cluster you want to scale. MemoryDB uses the cluster
2159
+ # name to identify the current node type being used by this cluster,
2160
+ # and from that to create a list of node types you can scale up to.
2161
+ # @return [String]
2162
+ #
2163
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ListAllowedNodeTypeUpdatesRequest AWS API Documentation
2164
+ #
2165
+ class ListAllowedNodeTypeUpdatesRequest < Struct.new(
2166
+ :cluster_name)
2167
+ SENSITIVE = []
2168
+ include Aws::Structure
2169
+ end
2170
+
2171
+ # @!attribute [rw] scale_up_node_types
2172
+ # A list node types which you can use to scale up your cluster.
2173
+ # @return [Array<String>]
2174
+ #
2175
+ # @!attribute [rw] scale_down_node_types
2176
+ # A list node types which you can use to scale down your cluster.
2177
+ # @return [Array<String>]
2178
+ #
2179
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ListAllowedNodeTypeUpdatesResponse AWS API Documentation
2180
+ #
2181
+ class ListAllowedNodeTypeUpdatesResponse < Struct.new(
2182
+ :scale_up_node_types,
2183
+ :scale_down_node_types)
2184
+ SENSITIVE = []
2185
+ include Aws::Structure
2186
+ end
2187
+
2188
+ # @note When making an API call, you may pass ListTagsRequest
2189
+ # data as a hash:
2190
+ #
2191
+ # {
2192
+ # resource_arn: "String", # required
2193
+ # }
2194
+ #
2195
+ # @!attribute [rw] resource_arn
2196
+ # The Amazon Resource Name (ARN) of the resource for which you want
2197
+ # the list of tags
2198
+ # @return [String]
2199
+ #
2200
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ListTagsRequest AWS API Documentation
2201
+ #
2202
+ class ListTagsRequest < Struct.new(
2203
+ :resource_arn)
2204
+ SENSITIVE = []
2205
+ include Aws::Structure
2206
+ end
2207
+
2208
+ # @!attribute [rw] tag_list
2209
+ # A list of tags as key-value pairs.
2210
+ # @return [Array<Types::Tag>]
2211
+ #
2212
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ListTagsResponse AWS API Documentation
2213
+ #
2214
+ class ListTagsResponse < Struct.new(
2215
+ :tag_list)
2216
+ SENSITIVE = []
2217
+ include Aws::Structure
2218
+ end
2219
+
2220
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/NoOperationFault AWS API Documentation
2221
+ #
2222
+ class NoOperationFault < Aws::EmptyStructure; end
2223
+
2224
+ # Represents an individual node within a cluster. Each node runs its own
2225
+ # instance of the cluster's protocol-compliant caching software.
2226
+ #
2227
+ # @!attribute [rw] name
2228
+ # The node identifier. A node name is a numeric identifier (0001,
2229
+ # 0002, etc.). The combination of cluster name, shard name and node
2230
+ # name uniquely identifies every node used in a customer's Amazon
2231
+ # account.
2232
+ # @return [String]
2233
+ #
2234
+ # @!attribute [rw] status
2235
+ # The status of the service update on the node
2236
+ # @return [String]
2237
+ #
2238
+ # @!attribute [rw] availability_zone
2239
+ # The Availability Zone in which the node resides
2240
+ # @return [String]
2241
+ #
2242
+ # @!attribute [rw] create_time
2243
+ # The date and time when the node was created.
2244
+ # @return [Time]
2245
+ #
2246
+ # @!attribute [rw] endpoint
2247
+ # The hostname for connecting to this node.
2248
+ # @return [Types::Endpoint]
2249
+ #
2250
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/Node AWS API Documentation
2251
+ #
2252
+ class Node < Struct.new(
2253
+ :name,
2254
+ :status,
2255
+ :availability_zone,
2256
+ :create_time,
2257
+ :endpoint)
2258
+ SENSITIVE = []
2259
+ include Aws::Structure
2260
+ end
2261
+
2262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/NodeQuotaForClusterExceededFault AWS API Documentation
2263
+ #
2264
+ class NodeQuotaForClusterExceededFault < Aws::EmptyStructure; end
2265
+
2266
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/NodeQuotaForCustomerExceededFault AWS API Documentation
2267
+ #
2268
+ class NodeQuotaForCustomerExceededFault < Aws::EmptyStructure; end
2269
+
2270
+ # Describes an individual setting that controls some aspect of MemoryDB
2271
+ # behavior.
2272
+ #
2273
+ # @!attribute [rw] name
2274
+ # The name of the parameter
2275
+ # @return [String]
2276
+ #
2277
+ # @!attribute [rw] value
2278
+ # The value of the parameter
2279
+ # @return [String]
2280
+ #
2281
+ # @!attribute [rw] description
2282
+ # A description of the parameter
2283
+ # @return [String]
2284
+ #
2285
+ # @!attribute [rw] data_type
2286
+ # The parameter's data type
2287
+ # @return [String]
2288
+ #
2289
+ # @!attribute [rw] allowed_values
2290
+ # The valid range of values for the parameter.
2291
+ # @return [String]
2292
+ #
2293
+ # @!attribute [rw] minimum_engine_version
2294
+ # The earliest engine version to which the parameter can apply.
2295
+ # @return [String]
2296
+ #
2297
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/Parameter AWS API Documentation
2298
+ #
2299
+ class Parameter < Struct.new(
2300
+ :name,
2301
+ :value,
2302
+ :description,
2303
+ :data_type,
2304
+ :allowed_values,
2305
+ :minimum_engine_version)
2306
+ SENSITIVE = []
2307
+ include Aws::Structure
2308
+ end
2309
+
2310
+ # Represents the output of a CreateParameterGroup operation. A parameter
2311
+ # group represents a combination of specific values for the parameters
2312
+ # that are passed to the engine software during startup.
2313
+ #
2314
+ # @!attribute [rw] name
2315
+ # The name of the parameter group
2316
+ # @return [String]
2317
+ #
2318
+ # @!attribute [rw] family
2319
+ # The name of the parameter group family that this parameter group is
2320
+ # compatible with.
2321
+ # @return [String]
2322
+ #
2323
+ # @!attribute [rw] description
2324
+ # A description of the parameter group
2325
+ # @return [String]
2326
+ #
2327
+ # @!attribute [rw] arn
2328
+ # The Amazon Resource Name (ARN) of the parameter group
2329
+ # @return [String]
2330
+ #
2331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ParameterGroup AWS API Documentation
2332
+ #
2333
+ class ParameterGroup < Struct.new(
2334
+ :name,
2335
+ :family,
2336
+ :description,
2337
+ :arn)
2338
+ SENSITIVE = []
2339
+ include Aws::Structure
2340
+ end
2341
+
2342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ParameterGroupAlreadyExistsFault AWS API Documentation
2343
+ #
2344
+ class ParameterGroupAlreadyExistsFault < Aws::EmptyStructure; end
2345
+
2346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ParameterGroupNotFoundFault AWS API Documentation
2347
+ #
2348
+ class ParameterGroupNotFoundFault < Aws::EmptyStructure; end
2349
+
2350
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ParameterGroupQuotaExceededFault AWS API Documentation
2351
+ #
2352
+ class ParameterGroupQuotaExceededFault < Aws::EmptyStructure; end
2353
+
2354
+ # Describes a name-value pair that is used to update the value of a
2355
+ # parameter.
2356
+ #
2357
+ # @note When making an API call, you may pass ParameterNameValue
2358
+ # data as a hash:
2359
+ #
2360
+ # {
2361
+ # parameter_name: "String",
2362
+ # parameter_value: "String",
2363
+ # }
2364
+ #
2365
+ # @!attribute [rw] parameter_name
2366
+ # The name of the parameter
2367
+ # @return [String]
2368
+ #
2369
+ # @!attribute [rw] parameter_value
2370
+ # The value of the parameter
2371
+ # @return [String]
2372
+ #
2373
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ParameterNameValue AWS API Documentation
2374
+ #
2375
+ class ParameterNameValue < Struct.new(
2376
+ :parameter_name,
2377
+ :parameter_value)
2378
+ SENSITIVE = []
2379
+ include Aws::Structure
2380
+ end
2381
+
2382
+ # Update action that has yet to be processed for the corresponding
2383
+ # apply/stop request
2384
+ #
2385
+ # @!attribute [rw] service_update_name
2386
+ # The unique ID of the service update
2387
+ # @return [String]
2388
+ #
2389
+ # @!attribute [rw] status
2390
+ # The status of the service update
2391
+ # @return [String]
2392
+ #
2393
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/PendingModifiedServiceUpdate AWS API Documentation
2394
+ #
2395
+ class PendingModifiedServiceUpdate < Struct.new(
2396
+ :service_update_name,
2397
+ :status)
2398
+ SENSITIVE = []
2399
+ include Aws::Structure
2400
+ end
2401
+
2402
+ # A request to configure the number of replicas in a shard
2403
+ #
2404
+ # @note When making an API call, you may pass ReplicaConfigurationRequest
2405
+ # data as a hash:
2406
+ #
2407
+ # {
2408
+ # replica_count: 1,
2409
+ # }
2410
+ #
2411
+ # @!attribute [rw] replica_count
2412
+ # The number of replicas to scale up or down to
2413
+ # @return [Integer]
2414
+ #
2415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ReplicaConfigurationRequest AWS API Documentation
2416
+ #
2417
+ class ReplicaConfigurationRequest < Struct.new(
2418
+ :replica_count)
2419
+ SENSITIVE = []
2420
+ include Aws::Structure
2421
+ end
2422
+
2423
+ # @note When making an API call, you may pass ResetParameterGroupRequest
2424
+ # data as a hash:
2425
+ #
2426
+ # {
2427
+ # parameter_group_name: "String", # required
2428
+ # all_parameters: false,
2429
+ # parameter_names: ["String"],
2430
+ # }
2431
+ #
2432
+ # @!attribute [rw] parameter_group_name
2433
+ # The name of the parameter group to reset.
2434
+ # @return [String]
2435
+ #
2436
+ # @!attribute [rw] all_parameters
2437
+ # If true, all parameters in the parameter group are reset to their
2438
+ # default values. If false, only the parameters listed by
2439
+ # ParameterNames are reset to their default values.
2440
+ # @return [Boolean]
2441
+ #
2442
+ # @!attribute [rw] parameter_names
2443
+ # An array of parameter names to reset to their default values. If
2444
+ # AllParameters is true, do not use ParameterNames. If AllParameters
2445
+ # is false, you must specify the name of at least one parameter to
2446
+ # reset.
2447
+ # @return [Array<String>]
2448
+ #
2449
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ResetParameterGroupRequest AWS API Documentation
2450
+ #
2451
+ class ResetParameterGroupRequest < Struct.new(
2452
+ :parameter_group_name,
2453
+ :all_parameters,
2454
+ :parameter_names)
2455
+ SENSITIVE = []
2456
+ include Aws::Structure
2457
+ end
2458
+
2459
+ # @!attribute [rw] parameter_group
2460
+ # The parameter group being reset.
2461
+ # @return [Types::ParameterGroup]
2462
+ #
2463
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ResetParameterGroupResponse AWS API Documentation
2464
+ #
2465
+ class ResetParameterGroupResponse < Struct.new(
2466
+ :parameter_group)
2467
+ SENSITIVE = []
2468
+ include Aws::Structure
2469
+ end
2470
+
2471
+ # The status of the online resharding
2472
+ #
2473
+ # @!attribute [rw] slot_migration
2474
+ # The status of the online resharding slot migration
2475
+ # @return [Types::SlotMigration]
2476
+ #
2477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ReshardingStatus AWS API Documentation
2478
+ #
2479
+ class ReshardingStatus < Struct.new(
2480
+ :slot_migration)
2481
+ SENSITIVE = []
2482
+ include Aws::Structure
2483
+ end
2484
+
2485
+ # Represents a single security group and its status.
2486
+ #
2487
+ # @!attribute [rw] security_group_id
2488
+ # The identifier of the security group.
2489
+ # @return [String]
2490
+ #
2491
+ # @!attribute [rw] status
2492
+ # The status of the security group membership. The status changes
2493
+ # whenever a security group is modified, or when the security groups
2494
+ # assigned to a cluster are modified.
2495
+ # @return [String]
2496
+ #
2497
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/SecurityGroupMembership AWS API Documentation
2498
+ #
2499
+ class SecurityGroupMembership < Struct.new(
2500
+ :security_group_id,
2501
+ :status)
2502
+ SENSITIVE = []
2503
+ include Aws::Structure
2504
+ end
2505
+
2506
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ServiceLinkedRoleNotFoundFault AWS API Documentation
2507
+ #
2508
+ class ServiceLinkedRoleNotFoundFault < Aws::EmptyStructure; end
2509
+
2510
+ # An update that you can apply to your MemoryDB clusters.
2511
+ #
2512
+ # @!attribute [rw] cluster_name
2513
+ # The name of the cluster to which the service update applies
2514
+ # @return [String]
2515
+ #
2516
+ # @!attribute [rw] service_update_name
2517
+ # The unique ID of the service update
2518
+ # @return [String]
2519
+ #
2520
+ # @!attribute [rw] release_date
2521
+ # The date when the service update is initially available
2522
+ # @return [Time]
2523
+ #
2524
+ # @!attribute [rw] description
2525
+ # Provides details of the service update
2526
+ # @return [String]
2527
+ #
2528
+ # @!attribute [rw] status
2529
+ # The status of the service update
2530
+ # @return [String]
2531
+ #
2532
+ # @!attribute [rw] type
2533
+ # Reflects the nature of the service update
2534
+ # @return [String]
2535
+ #
2536
+ # @!attribute [rw] nodes_updated
2537
+ # A list of nodes updated by the service update
2538
+ # @return [String]
2539
+ #
2540
+ # @!attribute [rw] auto_update_start_date
2541
+ # The date at which the service update will be automatically applied
2542
+ # @return [Time]
2543
+ #
2544
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ServiceUpdate AWS API Documentation
2545
+ #
2546
+ class ServiceUpdate < Struct.new(
2547
+ :cluster_name,
2548
+ :service_update_name,
2549
+ :release_date,
2550
+ :description,
2551
+ :status,
2552
+ :type,
2553
+ :nodes_updated,
2554
+ :auto_update_start_date)
2555
+ SENSITIVE = []
2556
+ include Aws::Structure
2557
+ end
2558
+
2559
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ServiceUpdateNotFoundFault AWS API Documentation
2560
+ #
2561
+ class ServiceUpdateNotFoundFault < Aws::EmptyStructure; end
2562
+
2563
+ # A request to apply a service update
2564
+ #
2565
+ # @note When making an API call, you may pass ServiceUpdateRequest
2566
+ # data as a hash:
2567
+ #
2568
+ # {
2569
+ # service_update_name_to_apply: "String",
2570
+ # }
2571
+ #
2572
+ # @!attribute [rw] service_update_name_to_apply
2573
+ # The unique ID of the service update
2574
+ # @return [String]
2575
+ #
2576
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ServiceUpdateRequest AWS API Documentation
2577
+ #
2578
+ class ServiceUpdateRequest < Struct.new(
2579
+ :service_update_name_to_apply)
2580
+ SENSITIVE = []
2581
+ include Aws::Structure
2582
+ end
2583
+
2584
+ # Represents a collection of nodes in a cluster. One node in the node
2585
+ # group is the read/write primary node. All the other nodes are
2586
+ # read-only Replica nodes.
2587
+ #
2588
+ # @!attribute [rw] name
2589
+ # The name of the shard
2590
+ # @return [String]
2591
+ #
2592
+ # @!attribute [rw] status
2593
+ # The current state of this replication group - creating, available,
2594
+ # modifying, deleting.
2595
+ # @return [String]
2596
+ #
2597
+ # @!attribute [rw] slots
2598
+ # The keyspace for this shard.
2599
+ # @return [String]
2600
+ #
2601
+ # @!attribute [rw] nodes
2602
+ # A list containing information about individual nodes within the
2603
+ # shard
2604
+ # @return [Array<Types::Node>]
2605
+ #
2606
+ # @!attribute [rw] number_of_nodes
2607
+ # The number of nodes in the shard
2608
+ # @return [Integer]
2609
+ #
2610
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/Shard AWS API Documentation
2611
+ #
2612
+ class Shard < Struct.new(
2613
+ :name,
2614
+ :status,
2615
+ :slots,
2616
+ :nodes,
2617
+ :number_of_nodes)
2618
+ SENSITIVE = []
2619
+ include Aws::Structure
2620
+ end
2621
+
2622
+ # Shard configuration options. Each shard configuration has the
2623
+ # following: Slots and ReplicaCount.
2624
+ #
2625
+ # @!attribute [rw] slots
2626
+ # A string that specifies the keyspace for a particular node group.
2627
+ # Keyspaces range from 0 to 16,383. The string is in the format
2628
+ # startkey-endkey.
2629
+ # @return [String]
2630
+ #
2631
+ # @!attribute [rw] replica_count
2632
+ # The number of read replica nodes in this shard.
2633
+ # @return [Integer]
2634
+ #
2635
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ShardConfiguration AWS API Documentation
2636
+ #
2637
+ class ShardConfiguration < Struct.new(
2638
+ :slots,
2639
+ :replica_count)
2640
+ SENSITIVE = []
2641
+ include Aws::Structure
2642
+ end
2643
+
2644
+ # A request to configure the sharding properties of a cluster
2645
+ #
2646
+ # @note When making an API call, you may pass ShardConfigurationRequest
2647
+ # data as a hash:
2648
+ #
2649
+ # {
2650
+ # shard_count: 1,
2651
+ # }
2652
+ #
2653
+ # @!attribute [rw] shard_count
2654
+ # The number of shards in the cluster
2655
+ # @return [Integer]
2656
+ #
2657
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ShardConfigurationRequest AWS API Documentation
2658
+ #
2659
+ class ShardConfigurationRequest < Struct.new(
2660
+ :shard_count)
2661
+ SENSITIVE = []
2662
+ include Aws::Structure
2663
+ end
2664
+
2665
+ # Provides details of a shard in a snapshot
2666
+ #
2667
+ # @!attribute [rw] name
2668
+ # The name of the shard
2669
+ # @return [String]
2670
+ #
2671
+ # @!attribute [rw] configuration
2672
+ # The configuration details of the shard
2673
+ # @return [Types::ShardConfiguration]
2674
+ #
2675
+ # @!attribute [rw] size
2676
+ # The size of the shard's snapshot
2677
+ # @return [String]
2678
+ #
2679
+ # @!attribute [rw] snapshot_creation_time
2680
+ # The date and time that the shard's snapshot was created
2681
+ # @return [Time]
2682
+ #
2683
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ShardDetail AWS API Documentation
2684
+ #
2685
+ class ShardDetail < Struct.new(
2686
+ :name,
2687
+ :configuration,
2688
+ :size,
2689
+ :snapshot_creation_time)
2690
+ SENSITIVE = []
2691
+ include Aws::Structure
2692
+ end
2693
+
2694
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ShardNotFoundFault AWS API Documentation
2695
+ #
2696
+ class ShardNotFoundFault < Aws::EmptyStructure; end
2697
+
2698
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/ShardsPerClusterQuotaExceededFault AWS API Documentation
2699
+ #
2700
+ class ShardsPerClusterQuotaExceededFault < Aws::EmptyStructure; end
2701
+
2702
+ # Represents the progress of an online resharding operation.
2703
+ #
2704
+ # @!attribute [rw] progress_percentage
2705
+ # The percentage of the slot migration that is complete.
2706
+ # @return [Float]
2707
+ #
2708
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/SlotMigration AWS API Documentation
2709
+ #
2710
+ class SlotMigration < Struct.new(
2711
+ :progress_percentage)
2712
+ SENSITIVE = []
2713
+ include Aws::Structure
2714
+ end
2715
+
2716
+ # Represents a copy of an entire cluster as of the time when the
2717
+ # snapshot was taken.
2718
+ #
2719
+ # @!attribute [rw] name
2720
+ # The name of the snapshot
2721
+ # @return [String]
2722
+ #
2723
+ # @!attribute [rw] status
2724
+ # The status of the snapshot. Valid values: creating \| available \|
2725
+ # restoring \| copying \| deleting.
2726
+ # @return [String]
2727
+ #
2728
+ # @!attribute [rw] source
2729
+ # Indicates whether the snapshot is from an automatic backup
2730
+ # (automated) or was created manually (manual).
2731
+ # @return [String]
2732
+ #
2733
+ # @!attribute [rw] kms_key_id
2734
+ # The ID of the KMS key used to encrypt the snapshot.
2735
+ # @return [String]
2736
+ #
2737
+ # @!attribute [rw] arn
2738
+ # The ARN (Amazon Resource Name) of the snapshot.
2739
+ # @return [String]
2740
+ #
2741
+ # @!attribute [rw] cluster_configuration
2742
+ # The configuration of the cluster from which the snapshot was taken
2743
+ # @return [Types::ClusterConfiguration]
2744
+ #
2745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/Snapshot AWS API Documentation
2746
+ #
2747
+ class Snapshot < Struct.new(
2748
+ :name,
2749
+ :status,
2750
+ :source,
2751
+ :kms_key_id,
2752
+ :arn,
2753
+ :cluster_configuration)
2754
+ SENSITIVE = []
2755
+ include Aws::Structure
2756
+ end
2757
+
2758
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/SnapshotAlreadyExistsFault AWS API Documentation
2759
+ #
2760
+ class SnapshotAlreadyExistsFault < Aws::EmptyStructure; end
2761
+
2762
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/SnapshotNotFoundFault AWS API Documentation
2763
+ #
2764
+ class SnapshotNotFoundFault < Aws::EmptyStructure; end
2765
+
2766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/SnapshotQuotaExceededFault AWS API Documentation
2767
+ #
2768
+ class SnapshotQuotaExceededFault < Aws::EmptyStructure; end
2769
+
2770
+ # Represents the subnet associated with a cluster. This parameter refers
2771
+ # to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and
2772
+ # used with MemoryDB.
2773
+ #
2774
+ # @!attribute [rw] identifier
2775
+ # The unique identifier for the subnet.
2776
+ # @return [String]
2777
+ #
2778
+ # @!attribute [rw] availability_zone
2779
+ # The Availability Zone where the subnet resides
2780
+ # @return [Types::AvailabilityZone]
2781
+ #
2782
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/Subnet AWS API Documentation
2783
+ #
2784
+ class Subnet < Struct.new(
2785
+ :identifier,
2786
+ :availability_zone)
2787
+ SENSITIVE = []
2788
+ include Aws::Structure
2789
+ end
2790
+
2791
+ # Represents the output of one of the following operations:
2792
+ #
2793
+ # * CreateSubnetGroup
2794
+ #
2795
+ # * UpdateSubnetGroup
2796
+ #
2797
+ # A subnet group is a collection of subnets (typically private) that you
2798
+ # can designate for your clusters running in an Amazon Virtual Private
2799
+ # Cloud (VPC) environment.
2800
+ #
2801
+ # @!attribute [rw] name
2802
+ # The name of the subnet group
2803
+ # @return [String]
2804
+ #
2805
+ # @!attribute [rw] description
2806
+ # A description of the subnet group
2807
+ # @return [String]
2808
+ #
2809
+ # @!attribute [rw] vpc_id
2810
+ # The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet
2811
+ # group.
2812
+ # @return [String]
2813
+ #
2814
+ # @!attribute [rw] subnets
2815
+ # A list of subnets associated with the subnet group.
2816
+ # @return [Array<Types::Subnet>]
2817
+ #
2818
+ # @!attribute [rw] arn
2819
+ # The ARN (Amazon Resource Name) of the subnet group.
2820
+ # @return [String]
2821
+ #
2822
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/SubnetGroup AWS API Documentation
2823
+ #
2824
+ class SubnetGroup < Struct.new(
2825
+ :name,
2826
+ :description,
2827
+ :vpc_id,
2828
+ :subnets,
2829
+ :arn)
2830
+ SENSITIVE = []
2831
+ include Aws::Structure
2832
+ end
2833
+
2834
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/SubnetGroupAlreadyExistsFault AWS API Documentation
2835
+ #
2836
+ class SubnetGroupAlreadyExistsFault < Aws::EmptyStructure; end
2837
+
2838
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/SubnetGroupInUseFault AWS API Documentation
2839
+ #
2840
+ class SubnetGroupInUseFault < Aws::EmptyStructure; end
2841
+
2842
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/SubnetGroupNotFoundFault AWS API Documentation
2843
+ #
2844
+ class SubnetGroupNotFoundFault < Aws::EmptyStructure; end
2845
+
2846
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/SubnetGroupQuotaExceededFault AWS API Documentation
2847
+ #
2848
+ class SubnetGroupQuotaExceededFault < Aws::EmptyStructure; end
2849
+
2850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/SubnetInUse AWS API Documentation
2851
+ #
2852
+ class SubnetInUse < Aws::EmptyStructure; end
2853
+
2854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/SubnetNotAllowedFault AWS API Documentation
2855
+ #
2856
+ class SubnetNotAllowedFault < Aws::EmptyStructure; end
2857
+
2858
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/SubnetQuotaExceededFault AWS API Documentation
2859
+ #
2860
+ class SubnetQuotaExceededFault < Aws::EmptyStructure; end
2861
+
2862
+ # A tag that can be added to an MemoryDB resource. Tags are composed of
2863
+ # a Key/Value pair. You can use tags to categorize and track all your
2864
+ # MemoryDB resources. When you add or remove tags on clusters, those
2865
+ # actions will be replicated to all nodes in the cluster. A tag with a
2866
+ # null Value is permitted. For more information, see [Tagging your
2867
+ # MemoryDB resources][1]
2868
+ #
2869
+ #
2870
+ #
2871
+ # [1]: https://docs.aws.amazon.com/AmazonMemoryDB/latest/devguide/Tagging-Resources.html
2872
+ #
2873
+ # @note When making an API call, you may pass Tag
2874
+ # data as a hash:
2875
+ #
2876
+ # {
2877
+ # key: "String",
2878
+ # value: "String",
2879
+ # }
2880
+ #
2881
+ # @!attribute [rw] key
2882
+ # The key for the tag. May not be null.
2883
+ # @return [String]
2884
+ #
2885
+ # @!attribute [rw] value
2886
+ # The tag's value. May be null.
2887
+ # @return [String]
2888
+ #
2889
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/Tag AWS API Documentation
2890
+ #
2891
+ class Tag < Struct.new(
2892
+ :key,
2893
+ :value)
2894
+ SENSITIVE = []
2895
+ include Aws::Structure
2896
+ end
2897
+
2898
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/TagNotFoundFault AWS API Documentation
2899
+ #
2900
+ class TagNotFoundFault < Aws::EmptyStructure; end
2901
+
2902
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/TagQuotaPerResourceExceeded AWS API Documentation
2903
+ #
2904
+ class TagQuotaPerResourceExceeded < Aws::EmptyStructure; end
2905
+
2906
+ # @note When making an API call, you may pass TagResourceRequest
2907
+ # data as a hash:
2908
+ #
2909
+ # {
2910
+ # resource_arn: "String", # required
2911
+ # tags: [ # required
2912
+ # {
2913
+ # key: "String",
2914
+ # value: "String",
2915
+ # },
2916
+ # ],
2917
+ # }
2918
+ #
2919
+ # @!attribute [rw] resource_arn
2920
+ # The Amazon Resource Name (ARN) of the resource to which the tags are
2921
+ # to be added
2922
+ # @return [String]
2923
+ #
2924
+ # @!attribute [rw] tags
2925
+ # A list of tags to be added to this resource. A tag is a key-value
2926
+ # pair. A tag key must be accompanied by a tag value, although null is
2927
+ # accepted.
2928
+ # @return [Array<Types::Tag>]
2929
+ #
2930
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/TagResourceRequest AWS API Documentation
2931
+ #
2932
+ class TagResourceRequest < Struct.new(
2933
+ :resource_arn,
2934
+ :tags)
2935
+ SENSITIVE = []
2936
+ include Aws::Structure
2937
+ end
2938
+
2939
+ # @!attribute [rw] tag_list
2940
+ # A list of tags as key-value pairs.
2941
+ # @return [Array<Types::Tag>]
2942
+ #
2943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/TagResourceResponse AWS API Documentation
2944
+ #
2945
+ class TagResourceResponse < Struct.new(
2946
+ :tag_list)
2947
+ SENSITIVE = []
2948
+ include Aws::Structure
2949
+ end
2950
+
2951
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/TestFailoverNotAvailableFault AWS API Documentation
2952
+ #
2953
+ class TestFailoverNotAvailableFault < Aws::EmptyStructure; end
2954
+
2955
+ # A cluster whose updates have failed
2956
+ #
2957
+ # @!attribute [rw] cluster_name
2958
+ # The name of the cluster
2959
+ # @return [String]
2960
+ #
2961
+ # @!attribute [rw] error_type
2962
+ # The error type associated with the update failure
2963
+ # @return [String]
2964
+ #
2965
+ # @!attribute [rw] error_message
2966
+ # The error message associated with the update failure
2967
+ # @return [String]
2968
+ #
2969
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UnprocessedCluster AWS API Documentation
2970
+ #
2971
+ class UnprocessedCluster < Struct.new(
2972
+ :cluster_name,
2973
+ :error_type,
2974
+ :error_message)
2975
+ SENSITIVE = []
2976
+ include Aws::Structure
2977
+ end
2978
+
2979
+ # @note When making an API call, you may pass UntagResourceRequest
2980
+ # data as a hash:
2981
+ #
2982
+ # {
2983
+ # resource_arn: "String", # required
2984
+ # tag_keys: ["String"], # required
2985
+ # }
2986
+ #
2987
+ # @!attribute [rw] resource_arn
2988
+ # The Amazon Resource Name (ARN) of the resource to which the tags are
2989
+ # to be removed
2990
+ # @return [String]
2991
+ #
2992
+ # @!attribute [rw] tag_keys
2993
+ # The list of keys of the tags that are to be removed
2994
+ # @return [Array<String>]
2995
+ #
2996
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UntagResourceRequest AWS API Documentation
2997
+ #
2998
+ class UntagResourceRequest < Struct.new(
2999
+ :resource_arn,
3000
+ :tag_keys)
3001
+ SENSITIVE = []
3002
+ include Aws::Structure
3003
+ end
3004
+
3005
+ # @!attribute [rw] tag_list
3006
+ # The list of tags removed
3007
+ # @return [Array<Types::Tag>]
3008
+ #
3009
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UntagResourceResponse AWS API Documentation
3010
+ #
3011
+ class UntagResourceResponse < Struct.new(
3012
+ :tag_list)
3013
+ SENSITIVE = []
3014
+ include Aws::Structure
3015
+ end
3016
+
3017
+ # @note When making an API call, you may pass UpdateACLRequest
3018
+ # data as a hash:
3019
+ #
3020
+ # {
3021
+ # acl_name: "String", # required
3022
+ # user_names_to_add: ["UserName"],
3023
+ # user_names_to_remove: ["UserName"],
3024
+ # }
3025
+ #
3026
+ # @!attribute [rw] acl_name
3027
+ # The name of the Access Control List
3028
+ # @return [String]
3029
+ #
3030
+ # @!attribute [rw] user_names_to_add
3031
+ # The list of users to add to the Access Control List
3032
+ # @return [Array<String>]
3033
+ #
3034
+ # @!attribute [rw] user_names_to_remove
3035
+ # The list of users to remove from the Access Control List
3036
+ # @return [Array<String>]
3037
+ #
3038
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UpdateACLRequest AWS API Documentation
3039
+ #
3040
+ class UpdateACLRequest < Struct.new(
3041
+ :acl_name,
3042
+ :user_names_to_add,
3043
+ :user_names_to_remove)
3044
+ SENSITIVE = []
3045
+ include Aws::Structure
3046
+ end
3047
+
3048
+ # @!attribute [rw] acl
3049
+ # The updated Access Control List
3050
+ # @return [Types::ACL]
3051
+ #
3052
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UpdateACLResponse AWS API Documentation
3053
+ #
3054
+ class UpdateACLResponse < Struct.new(
3055
+ :acl)
3056
+ SENSITIVE = []
3057
+ include Aws::Structure
3058
+ end
3059
+
3060
+ # @note When making an API call, you may pass UpdateClusterRequest
3061
+ # data as a hash:
3062
+ #
3063
+ # {
3064
+ # cluster_name: "String", # required
3065
+ # description: "String",
3066
+ # security_group_ids: ["String"],
3067
+ # maintenance_window: "String",
3068
+ # sns_topic_arn: "String",
3069
+ # sns_topic_status: "String",
3070
+ # parameter_group_name: "String",
3071
+ # snapshot_window: "String",
3072
+ # snapshot_retention_limit: 1,
3073
+ # node_type: "String",
3074
+ # engine_version: "String",
3075
+ # replica_configuration: {
3076
+ # replica_count: 1,
3077
+ # },
3078
+ # shard_configuration: {
3079
+ # shard_count: 1,
3080
+ # },
3081
+ # acl_name: "ACLName",
3082
+ # }
3083
+ #
3084
+ # @!attribute [rw] cluster_name
3085
+ # The name of the cluster to update
3086
+ # @return [String]
3087
+ #
3088
+ # @!attribute [rw] description
3089
+ # The description of the cluster to update
3090
+ # @return [String]
3091
+ #
3092
+ # @!attribute [rw] security_group_ids
3093
+ # The SecurityGroupIds to update
3094
+ # @return [Array<String>]
3095
+ #
3096
+ # @!attribute [rw] maintenance_window
3097
+ # The maintenance window to update
3098
+ # @return [String]
3099
+ #
3100
+ # @!attribute [rw] sns_topic_arn
3101
+ # The SNS topic ARN to update
3102
+ # @return [String]
3103
+ #
3104
+ # @!attribute [rw] sns_topic_status
3105
+ # The status of the Amazon SNS notification topic. Notifications are
3106
+ # sent only if the status is active.
3107
+ # @return [String]
3108
+ #
3109
+ # @!attribute [rw] parameter_group_name
3110
+ # The name of the parameter group to update
3111
+ # @return [String]
3112
+ #
3113
+ # @!attribute [rw] snapshot_window
3114
+ # The daily time range (in UTC) during which MemoryDB begins taking a
3115
+ # daily snapshot of your cluster.
3116
+ # @return [String]
3117
+ #
3118
+ # @!attribute [rw] snapshot_retention_limit
3119
+ # The number of days for which MemoryDB retains automatic cluster
3120
+ # snapshots before deleting them. For example, if you set
3121
+ # SnapshotRetentionLimit to 5, a snapshot that was taken today is
3122
+ # retained for 5 days before being deleted.
3123
+ # @return [Integer]
3124
+ #
3125
+ # @!attribute [rw] node_type
3126
+ # A valid node type that you want to scale this cluster up or down to.
3127
+ # @return [String]
3128
+ #
3129
+ # @!attribute [rw] engine_version
3130
+ # The upgraded version of the engine to be run on the nodes. You can
3131
+ # upgrade to a newer engine version, but you cannot downgrade to an
3132
+ # earlier engine version. If you want to use an earlier engine
3133
+ # version, you must delete the existing cluster and create it anew
3134
+ # with the earlier engine version.
3135
+ # @return [String]
3136
+ #
3137
+ # @!attribute [rw] replica_configuration
3138
+ # The number of replicas that will reside in each shard
3139
+ # @return [Types::ReplicaConfigurationRequest]
3140
+ #
3141
+ # @!attribute [rw] shard_configuration
3142
+ # The number of shards in the cluster
3143
+ # @return [Types::ShardConfigurationRequest]
3144
+ #
3145
+ # @!attribute [rw] acl_name
3146
+ # The Access Control List that is associated with the cluster
3147
+ # @return [String]
3148
+ #
3149
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UpdateClusterRequest AWS API Documentation
3150
+ #
3151
+ class UpdateClusterRequest < Struct.new(
3152
+ :cluster_name,
3153
+ :description,
3154
+ :security_group_ids,
3155
+ :maintenance_window,
3156
+ :sns_topic_arn,
3157
+ :sns_topic_status,
3158
+ :parameter_group_name,
3159
+ :snapshot_window,
3160
+ :snapshot_retention_limit,
3161
+ :node_type,
3162
+ :engine_version,
3163
+ :replica_configuration,
3164
+ :shard_configuration,
3165
+ :acl_name)
3166
+ SENSITIVE = []
3167
+ include Aws::Structure
3168
+ end
3169
+
3170
+ # @!attribute [rw] cluster
3171
+ # The updated cluster
3172
+ # @return [Types::Cluster]
3173
+ #
3174
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UpdateClusterResponse AWS API Documentation
3175
+ #
3176
+ class UpdateClusterResponse < Struct.new(
3177
+ :cluster)
3178
+ SENSITIVE = []
3179
+ include Aws::Structure
3180
+ end
3181
+
3182
+ # @note When making an API call, you may pass UpdateParameterGroupRequest
3183
+ # data as a hash:
3184
+ #
3185
+ # {
3186
+ # parameter_group_name: "String", # required
3187
+ # parameter_name_values: [ # required
3188
+ # {
3189
+ # parameter_name: "String",
3190
+ # parameter_value: "String",
3191
+ # },
3192
+ # ],
3193
+ # }
3194
+ #
3195
+ # @!attribute [rw] parameter_group_name
3196
+ # The name of the parameter group to update.
3197
+ # @return [String]
3198
+ #
3199
+ # @!attribute [rw] parameter_name_values
3200
+ # An array of parameter names and values for the parameter update. You
3201
+ # must supply at least one parameter name and value; subsequent
3202
+ # arguments are optional. A maximum of 20 parameters may be updated
3203
+ # per request.
3204
+ # @return [Array<Types::ParameterNameValue>]
3205
+ #
3206
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UpdateParameterGroupRequest AWS API Documentation
3207
+ #
3208
+ class UpdateParameterGroupRequest < Struct.new(
3209
+ :parameter_group_name,
3210
+ :parameter_name_values)
3211
+ SENSITIVE = []
3212
+ include Aws::Structure
3213
+ end
3214
+
3215
+ # @!attribute [rw] parameter_group
3216
+ # The updated parameter group
3217
+ # @return [Types::ParameterGroup]
3218
+ #
3219
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UpdateParameterGroupResponse AWS API Documentation
3220
+ #
3221
+ class UpdateParameterGroupResponse < Struct.new(
3222
+ :parameter_group)
3223
+ SENSITIVE = []
3224
+ include Aws::Structure
3225
+ end
3226
+
3227
+ # @note When making an API call, you may pass UpdateSubnetGroupRequest
3228
+ # data as a hash:
3229
+ #
3230
+ # {
3231
+ # subnet_group_name: "String", # required
3232
+ # description: "String",
3233
+ # subnet_ids: ["String"],
3234
+ # }
3235
+ #
3236
+ # @!attribute [rw] subnet_group_name
3237
+ # The name of the subnet group
3238
+ # @return [String]
3239
+ #
3240
+ # @!attribute [rw] description
3241
+ # A description of the subnet group
3242
+ # @return [String]
3243
+ #
3244
+ # @!attribute [rw] subnet_ids
3245
+ # The EC2 subnet IDs for the subnet group.
3246
+ # @return [Array<String>]
3247
+ #
3248
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UpdateSubnetGroupRequest AWS API Documentation
3249
+ #
3250
+ class UpdateSubnetGroupRequest < Struct.new(
3251
+ :subnet_group_name,
3252
+ :description,
3253
+ :subnet_ids)
3254
+ SENSITIVE = []
3255
+ include Aws::Structure
3256
+ end
3257
+
3258
+ # @!attribute [rw] subnet_group
3259
+ # The updated subnet group
3260
+ # @return [Types::SubnetGroup]
3261
+ #
3262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UpdateSubnetGroupResponse AWS API Documentation
3263
+ #
3264
+ class UpdateSubnetGroupResponse < Struct.new(
3265
+ :subnet_group)
3266
+ SENSITIVE = []
3267
+ include Aws::Structure
3268
+ end
3269
+
3270
+ # @note When making an API call, you may pass UpdateUserRequest
3271
+ # data as a hash:
3272
+ #
3273
+ # {
3274
+ # user_name: "UserName", # required
3275
+ # authentication_mode: {
3276
+ # type: "password", # accepts password
3277
+ # passwords: ["String"],
3278
+ # },
3279
+ # access_string: "AccessString",
3280
+ # }
3281
+ #
3282
+ # @!attribute [rw] user_name
3283
+ # The name of the user
3284
+ # @return [String]
3285
+ #
3286
+ # @!attribute [rw] authentication_mode
3287
+ # Denotes the user's authentication properties, such as whether it
3288
+ # requires a password to authenticate.
3289
+ # @return [Types::AuthenticationMode]
3290
+ #
3291
+ # @!attribute [rw] access_string
3292
+ # Access permissions string used for this user.
3293
+ # @return [String]
3294
+ #
3295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UpdateUserRequest AWS API Documentation
3296
+ #
3297
+ class UpdateUserRequest < Struct.new(
3298
+ :user_name,
3299
+ :authentication_mode,
3300
+ :access_string)
3301
+ SENSITIVE = []
3302
+ include Aws::Structure
3303
+ end
3304
+
3305
+ # @!attribute [rw] user
3306
+ # The updated user
3307
+ # @return [Types::User]
3308
+ #
3309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UpdateUserResponse AWS API Documentation
3310
+ #
3311
+ class UpdateUserResponse < Struct.new(
3312
+ :user)
3313
+ SENSITIVE = []
3314
+ include Aws::Structure
3315
+ end
3316
+
3317
+ # You create users and assign them specific permissions by using an
3318
+ # access string. You assign the users to Access Control Lists aligned
3319
+ # with a specific role (administrators, human resources) that are then
3320
+ # deployed to one or more MemoryDB clusters.
3321
+ #
3322
+ # @!attribute [rw] name
3323
+ # The name of the user
3324
+ # @return [String]
3325
+ #
3326
+ # @!attribute [rw] status
3327
+ # Indicates the user status. Can be "active", "modifying" or
3328
+ # "deleting".
3329
+ # @return [String]
3330
+ #
3331
+ # @!attribute [rw] access_string
3332
+ # Access permissions string used for this user.
3333
+ # @return [String]
3334
+ #
3335
+ # @!attribute [rw] acl_names
3336
+ # The names of the Access Control Lists to which the user belongs
3337
+ # @return [Array<String>]
3338
+ #
3339
+ # @!attribute [rw] minimum_engine_version
3340
+ # The minimum engine version supported for the user
3341
+ # @return [String]
3342
+ #
3343
+ # @!attribute [rw] authentication
3344
+ # Denotes whether the user requires a password to authenticate.
3345
+ # @return [Types::Authentication]
3346
+ #
3347
+ # @!attribute [rw] arn
3348
+ # The Amazon Resource Name (ARN) of the user.
3349
+ # @return [String]
3350
+ #
3351
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/User AWS API Documentation
3352
+ #
3353
+ class User < Struct.new(
3354
+ :name,
3355
+ :status,
3356
+ :access_string,
3357
+ :acl_names,
3358
+ :minimum_engine_version,
3359
+ :authentication,
3360
+ :arn)
3361
+ SENSITIVE = []
3362
+ include Aws::Structure
3363
+ end
3364
+
3365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UserAlreadyExistsFault AWS API Documentation
3366
+ #
3367
+ class UserAlreadyExistsFault < Aws::EmptyStructure; end
3368
+
3369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UserNotFoundFault AWS API Documentation
3370
+ #
3371
+ class UserNotFoundFault < Aws::EmptyStructure; end
3372
+
3373
+ # @see http://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/UserQuotaExceededFault AWS API Documentation
3374
+ #
3375
+ class UserQuotaExceededFault < Aws::EmptyStructure; end
3376
+
3377
+ end
3378
+ end