aws-sdk-dax 1.0.0.rc1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
File without changes
@@ -0,0 +1,14 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::DAX
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ end
14
+ end
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::DAX
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,1575 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::DAX
9
+ module Types
10
+
11
+ # Contains all of the attributes of a specific DAX cluster.
12
+ #
13
+ # @!attribute [rw] cluster_name
14
+ # The name of the DAX cluster.
15
+ # @return [String]
16
+ #
17
+ # @!attribute [rw] description
18
+ # The description of the cluster.
19
+ # @return [String]
20
+ #
21
+ # @!attribute [rw] cluster_arn
22
+ # The Amazon Resource Name (ARN) that uniquely identifies the cluster.
23
+ # @return [String]
24
+ #
25
+ # @!attribute [rw] total_nodes
26
+ # The total number of nodes in the cluster.
27
+ # @return [Integer]
28
+ #
29
+ # @!attribute [rw] active_nodes
30
+ # The number of nodes in the cluster that are active (i.e., capable of
31
+ # serving requests).
32
+ # @return [Integer]
33
+ #
34
+ # @!attribute [rw] node_type
35
+ # The node type for the nodes in the cluster. (All nodes in a DAX
36
+ # cluster are of the same type.)
37
+ # @return [String]
38
+ #
39
+ # @!attribute [rw] status
40
+ # The current status of the cluster.
41
+ # @return [String]
42
+ #
43
+ # @!attribute [rw] cluster_discovery_endpoint
44
+ # The configuration endpoint for this DAX cluster, consisting of a DNS
45
+ # name and a port number. Client applications can specify this
46
+ # endpoint, rather than an individual node endpoint, and allow the DAX
47
+ # client software to intelligently route requests and responses to
48
+ # nodes in the DAX cluster.
49
+ # @return [Types::Endpoint]
50
+ #
51
+ # @!attribute [rw] node_ids_to_remove
52
+ # A list of nodes to be removed from the cluster.
53
+ # @return [Array<String>]
54
+ #
55
+ # @!attribute [rw] nodes
56
+ # A list of nodes that are currently in the cluster.
57
+ # @return [Array<Types::Node>]
58
+ #
59
+ # @!attribute [rw] preferred_maintenance_window
60
+ # A range of time when maintenance of DAX cluster software will be
61
+ # performed. For example: `sun:01:00-sun:09:00`. Cluster maintenance
62
+ # normally takes less than 30 minutes, and is performed automatically
63
+ # within the maintenance window.
64
+ # @return [String]
65
+ #
66
+ # @!attribute [rw] notification_configuration
67
+ # Describes a notification topic and its status. Notification topics
68
+ # are used for publishing DAX events to subscribers using Amazon
69
+ # Simple Notification Service (SNS).
70
+ # @return [Types::NotificationConfiguration]
71
+ #
72
+ # @!attribute [rw] subnet_group
73
+ # The subnet group where the DAX cluster is running.
74
+ # @return [String]
75
+ #
76
+ # @!attribute [rw] security_groups
77
+ # A list of security groups, and the status of each, for the nodes in
78
+ # the cluster.
79
+ # @return [Array<Types::SecurityGroupMembership>]
80
+ #
81
+ # @!attribute [rw] iam_role_arn
82
+ # A valid Amazon Resource Name (ARN) that identifies an IAM role. At
83
+ # runtime, DAX will assume this role and use the role's permissions
84
+ # to access DynamoDB on your behalf.
85
+ # @return [String]
86
+ #
87
+ # @!attribute [rw] parameter_group
88
+ # The parameter group being used by nodes in the cluster.
89
+ # @return [Types::ParameterGroupStatus]
90
+ #
91
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/Cluster AWS API Documentation
92
+ #
93
+ class Cluster < Struct.new(
94
+ :cluster_name,
95
+ :description,
96
+ :cluster_arn,
97
+ :total_nodes,
98
+ :active_nodes,
99
+ :node_type,
100
+ :status,
101
+ :cluster_discovery_endpoint,
102
+ :node_ids_to_remove,
103
+ :nodes,
104
+ :preferred_maintenance_window,
105
+ :notification_configuration,
106
+ :subnet_group,
107
+ :security_groups,
108
+ :iam_role_arn,
109
+ :parameter_group)
110
+ include Aws::Structure
111
+ end
112
+
113
+ # @note When making an API call, you may pass CreateClusterRequest
114
+ # data as a hash:
115
+ #
116
+ # {
117
+ # cluster_name: "String", # required
118
+ # node_type: "String", # required
119
+ # description: "String",
120
+ # replication_factor: 1, # required
121
+ # availability_zones: ["String"],
122
+ # subnet_group_name: "String",
123
+ # security_group_ids: ["String"],
124
+ # preferred_maintenance_window: "String",
125
+ # notification_topic_arn: "String",
126
+ # iam_role_arn: "String", # required
127
+ # parameter_group_name: "String",
128
+ # tags: [
129
+ # {
130
+ # key: "String",
131
+ # value: "String",
132
+ # },
133
+ # ],
134
+ # }
135
+ #
136
+ # @!attribute [rw] cluster_name
137
+ # The cluster identifier. This parameter is stored as a lowercase
138
+ # string.
139
+ #
140
+ # **Constraints:**
141
+ #
142
+ # * A name must contain from 1 to 20 alphanumeric characters or
143
+ # hyphens.
144
+ #
145
+ # * The first character must be a letter.
146
+ #
147
+ # * A name cannot end with a hyphen or contain two consecutive
148
+ # hyphens.
149
+ # @return [String]
150
+ #
151
+ # @!attribute [rw] node_type
152
+ # The compute and memory capacity of the nodes in the cluster.
153
+ # @return [String]
154
+ #
155
+ # @!attribute [rw] description
156
+ # A description of the cluster.
157
+ # @return [String]
158
+ #
159
+ # @!attribute [rw] replication_factor
160
+ # The number of nodes in the DAX cluster. A replication factor of 1
161
+ # will create a single-node cluster, without any read replicas. For
162
+ # additional fault tolerance, you can create a multiple node cluster
163
+ # with one or more read replicas. To do this, set *ReplicationFactor*
164
+ # to 2 or more.
165
+ #
166
+ # <note markdown="1"> AWS recommends that you have at least two read replicas per cluster.
167
+ #
168
+ # </note>
169
+ # @return [Integer]
170
+ #
171
+ # @!attribute [rw] availability_zones
172
+ # The Availability Zones (AZs) in which the cluster nodes will be
173
+ # created. All nodes belonging to the cluster are placed in these
174
+ # Availability Zones. Use this parameter if you want to distribute the
175
+ # nodes across multiple AZs.
176
+ # @return [Array<String>]
177
+ #
178
+ # @!attribute [rw] subnet_group_name
179
+ # The name of the subnet group to be used for the replication group.
180
+ #
181
+ # DAX clusters can only run in an Amazon VPC environment. All of the
182
+ # subnets that you specify in a subnet group must exist in the same
183
+ # VPC.
184
+ # @return [String]
185
+ #
186
+ # @!attribute [rw] security_group_ids
187
+ # A list of security group IDs to be assigned to each node in the DAX
188
+ # cluster. (Each of the security group ID is system-generated.)
189
+ #
190
+ # If this parameter is not specified, DAX assigns the default VPC
191
+ # security group to each node.
192
+ # @return [Array<String>]
193
+ #
194
+ # @!attribute [rw] preferred_maintenance_window
195
+ # Specifies the weekly time range during which maintenance on the DAX
196
+ # cluster is performed. It is specified as a range in the format
197
+ # ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance
198
+ # window is a 60 minute period. Valid values for `ddd` are:
199
+ #
200
+ # * `sun`
201
+ #
202
+ # * `mon`
203
+ #
204
+ # * `tue`
205
+ #
206
+ # * `wed`
207
+ #
208
+ # * `thu`
209
+ #
210
+ # * `fri`
211
+ #
212
+ # * `sat`
213
+ #
214
+ # Example: `sun:05:00-sun:09:00`
215
+ #
216
+ # <note markdown="1"> If you don't specify a preferred maintenance window when you create
217
+ # or modify a cache cluster, DAX assigns a 60-minute maintenance
218
+ # window on a randomly selected day of the week.
219
+ #
220
+ # </note>
221
+ # @return [String]
222
+ #
223
+ # @!attribute [rw] notification_topic_arn
224
+ # The Amazon Resource Name (ARN) of the Amazon SNS topic to which
225
+ # notifications will be sent.
226
+ #
227
+ # <note markdown="1"> The Amazon SNS topic owner must be same as the DAX cluster owner.
228
+ #
229
+ # </note>
230
+ # @return [String]
231
+ #
232
+ # @!attribute [rw] iam_role_arn
233
+ # A valid Amazon Resource Name (ARN) that identifies an IAM role. At
234
+ # runtime, DAX will assume this role and use the role's permissions
235
+ # to access DynamoDB on your behalf.
236
+ # @return [String]
237
+ #
238
+ # @!attribute [rw] parameter_group_name
239
+ # The parameter group to be associated with the DAX cluster.
240
+ # @return [String]
241
+ #
242
+ # @!attribute [rw] tags
243
+ # A set of tags to associate with the DAX cluster.
244
+ # @return [Array<Types::Tag>]
245
+ #
246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/CreateClusterRequest AWS API Documentation
247
+ #
248
+ class CreateClusterRequest < Struct.new(
249
+ :cluster_name,
250
+ :node_type,
251
+ :description,
252
+ :replication_factor,
253
+ :availability_zones,
254
+ :subnet_group_name,
255
+ :security_group_ids,
256
+ :preferred_maintenance_window,
257
+ :notification_topic_arn,
258
+ :iam_role_arn,
259
+ :parameter_group_name,
260
+ :tags)
261
+ include Aws::Structure
262
+ end
263
+
264
+ # @!attribute [rw] cluster
265
+ # A description of the DAX cluster that you have created.
266
+ # @return [Types::Cluster]
267
+ #
268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/CreateClusterResponse AWS API Documentation
269
+ #
270
+ class CreateClusterResponse < Struct.new(
271
+ :cluster)
272
+ include Aws::Structure
273
+ end
274
+
275
+ # @note When making an API call, you may pass CreateParameterGroupRequest
276
+ # data as a hash:
277
+ #
278
+ # {
279
+ # parameter_group_name: "String", # required
280
+ # description: "String",
281
+ # }
282
+ #
283
+ # @!attribute [rw] parameter_group_name
284
+ # The name of the parameter group to apply to all of the clusters in
285
+ # this replication group.
286
+ # @return [String]
287
+ #
288
+ # @!attribute [rw] description
289
+ # A description of the parameter group.
290
+ # @return [String]
291
+ #
292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/CreateParameterGroupRequest AWS API Documentation
293
+ #
294
+ class CreateParameterGroupRequest < Struct.new(
295
+ :parameter_group_name,
296
+ :description)
297
+ include Aws::Structure
298
+ end
299
+
300
+ # @!attribute [rw] parameter_group
301
+ # Represents the output of a *CreateParameterGroup* action.
302
+ # @return [Types::ParameterGroup]
303
+ #
304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/CreateParameterGroupResponse AWS API Documentation
305
+ #
306
+ class CreateParameterGroupResponse < Struct.new(
307
+ :parameter_group)
308
+ include Aws::Structure
309
+ end
310
+
311
+ # @note When making an API call, you may pass CreateSubnetGroupRequest
312
+ # data as a hash:
313
+ #
314
+ # {
315
+ # subnet_group_name: "String", # required
316
+ # description: "String",
317
+ # subnet_ids: ["String"], # required
318
+ # }
319
+ #
320
+ # @!attribute [rw] subnet_group_name
321
+ # A name for the subnet group. This value is stored as a lowercase
322
+ # string.
323
+ # @return [String]
324
+ #
325
+ # @!attribute [rw] description
326
+ # A description for the subnet group
327
+ # @return [String]
328
+ #
329
+ # @!attribute [rw] subnet_ids
330
+ # A list of VPC subnet IDs for the subnet group.
331
+ # @return [Array<String>]
332
+ #
333
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/CreateSubnetGroupRequest AWS API Documentation
334
+ #
335
+ class CreateSubnetGroupRequest < Struct.new(
336
+ :subnet_group_name,
337
+ :description,
338
+ :subnet_ids)
339
+ include Aws::Structure
340
+ end
341
+
342
+ # @!attribute [rw] subnet_group
343
+ # Represents the output of a *CreateSubnetGroup* operation.
344
+ # @return [Types::SubnetGroup]
345
+ #
346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/CreateSubnetGroupResponse AWS API Documentation
347
+ #
348
+ class CreateSubnetGroupResponse < Struct.new(
349
+ :subnet_group)
350
+ include Aws::Structure
351
+ end
352
+
353
+ # @note When making an API call, you may pass DecreaseReplicationFactorRequest
354
+ # data as a hash:
355
+ #
356
+ # {
357
+ # cluster_name: "String", # required
358
+ # new_replication_factor: 1, # required
359
+ # availability_zones: ["String"],
360
+ # node_ids_to_remove: ["String"],
361
+ # }
362
+ #
363
+ # @!attribute [rw] cluster_name
364
+ # The name of the DAX cluster from which you want to remove nodes.
365
+ # @return [String]
366
+ #
367
+ # @!attribute [rw] new_replication_factor
368
+ # The new number of nodes for the DAX cluster.
369
+ # @return [Integer]
370
+ #
371
+ # @!attribute [rw] availability_zones
372
+ # The Availability Zone(s) from which to remove nodes.
373
+ # @return [Array<String>]
374
+ #
375
+ # @!attribute [rw] node_ids_to_remove
376
+ # The unique identifiers of the nodes to be removed from the cluster.
377
+ # @return [Array<String>]
378
+ #
379
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DecreaseReplicationFactorRequest AWS API Documentation
380
+ #
381
+ class DecreaseReplicationFactorRequest < Struct.new(
382
+ :cluster_name,
383
+ :new_replication_factor,
384
+ :availability_zones,
385
+ :node_ids_to_remove)
386
+ include Aws::Structure
387
+ end
388
+
389
+ # @!attribute [rw] cluster
390
+ # A description of the DAX cluster, after you have decreased its
391
+ # replication factor.
392
+ # @return [Types::Cluster]
393
+ #
394
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DecreaseReplicationFactorResponse AWS API Documentation
395
+ #
396
+ class DecreaseReplicationFactorResponse < Struct.new(
397
+ :cluster)
398
+ include Aws::Structure
399
+ end
400
+
401
+ # @note When making an API call, you may pass DeleteClusterRequest
402
+ # data as a hash:
403
+ #
404
+ # {
405
+ # cluster_name: "String", # required
406
+ # }
407
+ #
408
+ # @!attribute [rw] cluster_name
409
+ # The name of the cluster to be deleted.
410
+ # @return [String]
411
+ #
412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DeleteClusterRequest AWS API Documentation
413
+ #
414
+ class DeleteClusterRequest < Struct.new(
415
+ :cluster_name)
416
+ include Aws::Structure
417
+ end
418
+
419
+ # @!attribute [rw] cluster
420
+ # A description of the DAX cluster that is being deleted.
421
+ # @return [Types::Cluster]
422
+ #
423
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DeleteClusterResponse AWS API Documentation
424
+ #
425
+ class DeleteClusterResponse < Struct.new(
426
+ :cluster)
427
+ include Aws::Structure
428
+ end
429
+
430
+ # @note When making an API call, you may pass DeleteParameterGroupRequest
431
+ # data as a hash:
432
+ #
433
+ # {
434
+ # parameter_group_name: "String", # required
435
+ # }
436
+ #
437
+ # @!attribute [rw] parameter_group_name
438
+ # The name of the parameter group to delete.
439
+ # @return [String]
440
+ #
441
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DeleteParameterGroupRequest AWS API Documentation
442
+ #
443
+ class DeleteParameterGroupRequest < Struct.new(
444
+ :parameter_group_name)
445
+ include Aws::Structure
446
+ end
447
+
448
+ # @!attribute [rw] deletion_message
449
+ # A user-specified message for this action (i.e., a reason for
450
+ # deleting the parameter group).
451
+ # @return [String]
452
+ #
453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DeleteParameterGroupResponse AWS API Documentation
454
+ #
455
+ class DeleteParameterGroupResponse < Struct.new(
456
+ :deletion_message)
457
+ include Aws::Structure
458
+ end
459
+
460
+ # @note When making an API call, you may pass DeleteSubnetGroupRequest
461
+ # data as a hash:
462
+ #
463
+ # {
464
+ # subnet_group_name: "String", # required
465
+ # }
466
+ #
467
+ # @!attribute [rw] subnet_group_name
468
+ # The name of the subnet group to delete.
469
+ # @return [String]
470
+ #
471
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DeleteSubnetGroupRequest AWS API Documentation
472
+ #
473
+ class DeleteSubnetGroupRequest < Struct.new(
474
+ :subnet_group_name)
475
+ include Aws::Structure
476
+ end
477
+
478
+ # @!attribute [rw] deletion_message
479
+ # A user-specified message for this action (i.e., a reason for
480
+ # deleting the subnet group).
481
+ # @return [String]
482
+ #
483
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DeleteSubnetGroupResponse AWS API Documentation
484
+ #
485
+ class DeleteSubnetGroupResponse < Struct.new(
486
+ :deletion_message)
487
+ include Aws::Structure
488
+ end
489
+
490
+ # @note When making an API call, you may pass DescribeClustersRequest
491
+ # data as a hash:
492
+ #
493
+ # {
494
+ # cluster_names: ["String"],
495
+ # max_results: 1,
496
+ # next_token: "String",
497
+ # }
498
+ #
499
+ # @!attribute [rw] cluster_names
500
+ # The names of the DAX clusters being described.
501
+ # @return [Array<String>]
502
+ #
503
+ # @!attribute [rw] max_results
504
+ # The maximum number of results to include in the response. If more
505
+ # results exist than the specified `MaxResults` value, a token is
506
+ # included in the response so that the remaining results can be
507
+ # retrieved.
508
+ #
509
+ # The value for `MaxResults` must be between 20 and 100.
510
+ # @return [Integer]
511
+ #
512
+ # @!attribute [rw] next_token
513
+ # An optional token returned from a prior request. Use this token for
514
+ # pagination of results from this action. If this parameter is
515
+ # specified, the response includes only results beyond the token, up
516
+ # to the value specified by `MaxResults`.
517
+ # @return [String]
518
+ #
519
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeClustersRequest AWS API Documentation
520
+ #
521
+ class DescribeClustersRequest < Struct.new(
522
+ :cluster_names,
523
+ :max_results,
524
+ :next_token)
525
+ include Aws::Structure
526
+ end
527
+
528
+ # @!attribute [rw] next_token
529
+ # Provides an identifier to allow retrieval of paginated results.
530
+ # @return [String]
531
+ #
532
+ # @!attribute [rw] clusters
533
+ # The descriptions of your DAX clusters, in response to a
534
+ # *DescribeClusters* request.
535
+ # @return [Array<Types::Cluster>]
536
+ #
537
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeClustersResponse AWS API Documentation
538
+ #
539
+ class DescribeClustersResponse < Struct.new(
540
+ :next_token,
541
+ :clusters)
542
+ include Aws::Structure
543
+ end
544
+
545
+ # @note When making an API call, you may pass DescribeDefaultParametersRequest
546
+ # data as a hash:
547
+ #
548
+ # {
549
+ # max_results: 1,
550
+ # next_token: "String",
551
+ # }
552
+ #
553
+ # @!attribute [rw] max_results
554
+ # The maximum number of results to include in the response. If more
555
+ # results exist than the specified `MaxResults` value, a token is
556
+ # included in the response so that the remaining results can be
557
+ # retrieved.
558
+ #
559
+ # The value for `MaxResults` must be between 20 and 100.
560
+ # @return [Integer]
561
+ #
562
+ # @!attribute [rw] next_token
563
+ # An optional token returned from a prior request. Use this token for
564
+ # pagination of results from this action. If this parameter is
565
+ # specified, the response includes only results beyond the token, up
566
+ # to the value specified by `MaxResults`.
567
+ # @return [String]
568
+ #
569
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeDefaultParametersRequest AWS API Documentation
570
+ #
571
+ class DescribeDefaultParametersRequest < Struct.new(
572
+ :max_results,
573
+ :next_token)
574
+ include Aws::Structure
575
+ end
576
+
577
+ # @!attribute [rw] next_token
578
+ # Provides an identifier to allow retrieval of paginated results.
579
+ # @return [String]
580
+ #
581
+ # @!attribute [rw] parameters
582
+ # A list of parameters. Each element in the list represents one
583
+ # parameter.
584
+ # @return [Array<Types::Parameter>]
585
+ #
586
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeDefaultParametersResponse AWS API Documentation
587
+ #
588
+ class DescribeDefaultParametersResponse < Struct.new(
589
+ :next_token,
590
+ :parameters)
591
+ include Aws::Structure
592
+ end
593
+
594
+ # @note When making an API call, you may pass DescribeEventsRequest
595
+ # data as a hash:
596
+ #
597
+ # {
598
+ # source_name: "String",
599
+ # source_type: "CLUSTER", # accepts CLUSTER, PARAMETER_GROUP, SUBNET_GROUP
600
+ # start_time: Time.now,
601
+ # end_time: Time.now,
602
+ # duration: 1,
603
+ # max_results: 1,
604
+ # next_token: "String",
605
+ # }
606
+ #
607
+ # @!attribute [rw] source_name
608
+ # The identifier of the event source for which events will be
609
+ # returned. If not specified, then all sources are included in the
610
+ # response.
611
+ # @return [String]
612
+ #
613
+ # @!attribute [rw] source_type
614
+ # The event source to retrieve events for. If no value is specified,
615
+ # all events are returned.
616
+ # @return [String]
617
+ #
618
+ # @!attribute [rw] start_time
619
+ # The beginning of the time interval to retrieve events for, specified
620
+ # in ISO 8601 format.
621
+ # @return [Time]
622
+ #
623
+ # @!attribute [rw] end_time
624
+ # The end of the time interval for which to retrieve events, specified
625
+ # in ISO 8601 format.
626
+ # @return [Time]
627
+ #
628
+ # @!attribute [rw] duration
629
+ # The number of minutes' worth of events to retrieve.
630
+ # @return [Integer]
631
+ #
632
+ # @!attribute [rw] max_results
633
+ # The maximum number of results to include in the response. If more
634
+ # results exist than the specified `MaxResults` value, a token is
635
+ # included in the response so that the remaining results can be
636
+ # retrieved.
637
+ #
638
+ # The value for `MaxResults` must be between 20 and 100.
639
+ # @return [Integer]
640
+ #
641
+ # @!attribute [rw] next_token
642
+ # An optional token returned from a prior request. Use this token for
643
+ # pagination of results from this action. If this parameter is
644
+ # specified, the response includes only results beyond the token, up
645
+ # to the value specified by `MaxResults`.
646
+ # @return [String]
647
+ #
648
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeEventsRequest AWS API Documentation
649
+ #
650
+ class DescribeEventsRequest < Struct.new(
651
+ :source_name,
652
+ :source_type,
653
+ :start_time,
654
+ :end_time,
655
+ :duration,
656
+ :max_results,
657
+ :next_token)
658
+ include Aws::Structure
659
+ end
660
+
661
+ # @!attribute [rw] next_token
662
+ # Provides an identifier to allow retrieval of paginated results.
663
+ # @return [String]
664
+ #
665
+ # @!attribute [rw] events
666
+ # An array of events. Each element in the array represents one event.
667
+ # @return [Array<Types::Event>]
668
+ #
669
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeEventsResponse AWS API Documentation
670
+ #
671
+ class DescribeEventsResponse < Struct.new(
672
+ :next_token,
673
+ :events)
674
+ include Aws::Structure
675
+ end
676
+
677
+ # @note When making an API call, you may pass DescribeParameterGroupsRequest
678
+ # data as a hash:
679
+ #
680
+ # {
681
+ # parameter_group_names: ["String"],
682
+ # max_results: 1,
683
+ # next_token: "String",
684
+ # }
685
+ #
686
+ # @!attribute [rw] parameter_group_names
687
+ # The names of the parameter groups.
688
+ # @return [Array<String>]
689
+ #
690
+ # @!attribute [rw] max_results
691
+ # The maximum number of results to include in the response. If more
692
+ # results exist than the specified `MaxResults` value, a token is
693
+ # included in the response so that the remaining results can be
694
+ # retrieved.
695
+ #
696
+ # The value for `MaxResults` must be between 20 and 100.
697
+ # @return [Integer]
698
+ #
699
+ # @!attribute [rw] next_token
700
+ # An optional token returned from a prior request. Use this token for
701
+ # pagination of results from this action. If this parameter is
702
+ # specified, the response includes only results beyond the token, up
703
+ # to the value specified by `MaxResults`.
704
+ # @return [String]
705
+ #
706
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeParameterGroupsRequest AWS API Documentation
707
+ #
708
+ class DescribeParameterGroupsRequest < Struct.new(
709
+ :parameter_group_names,
710
+ :max_results,
711
+ :next_token)
712
+ include Aws::Structure
713
+ end
714
+
715
+ # @!attribute [rw] next_token
716
+ # Provides an identifier to allow retrieval of paginated results.
717
+ # @return [String]
718
+ #
719
+ # @!attribute [rw] parameter_groups
720
+ # An array of parameter groups. Each element in the array represents
721
+ # one parameter group.
722
+ # @return [Array<Types::ParameterGroup>]
723
+ #
724
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeParameterGroupsResponse AWS API Documentation
725
+ #
726
+ class DescribeParameterGroupsResponse < Struct.new(
727
+ :next_token,
728
+ :parameter_groups)
729
+ include Aws::Structure
730
+ end
731
+
732
+ # @note When making an API call, you may pass DescribeParametersRequest
733
+ # data as a hash:
734
+ #
735
+ # {
736
+ # parameter_group_name: "String", # required
737
+ # source: "String",
738
+ # max_results: 1,
739
+ # next_token: "String",
740
+ # }
741
+ #
742
+ # @!attribute [rw] parameter_group_name
743
+ # The name of the parameter group.
744
+ # @return [String]
745
+ #
746
+ # @!attribute [rw] source
747
+ # How the parameter is defined. For example, `system` denotes a
748
+ # system-defined parameter.
749
+ # @return [String]
750
+ #
751
+ # @!attribute [rw] max_results
752
+ # The maximum number of results to include in the response. If more
753
+ # results exist than the specified `MaxResults` value, a token is
754
+ # included in the response so that the remaining results can be
755
+ # retrieved.
756
+ #
757
+ # The value for `MaxResults` must be between 20 and 100.
758
+ # @return [Integer]
759
+ #
760
+ # @!attribute [rw] next_token
761
+ # An optional token returned from a prior request. Use this token for
762
+ # pagination of results from this action. If this parameter is
763
+ # specified, the response includes only results beyond the token, up
764
+ # to the value specified by `MaxResults`.
765
+ # @return [String]
766
+ #
767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeParametersRequest AWS API Documentation
768
+ #
769
+ class DescribeParametersRequest < Struct.new(
770
+ :parameter_group_name,
771
+ :source,
772
+ :max_results,
773
+ :next_token)
774
+ include Aws::Structure
775
+ end
776
+
777
+ # @!attribute [rw] next_token
778
+ # Provides an identifier to allow retrieval of paginated results.
779
+ # @return [String]
780
+ #
781
+ # @!attribute [rw] parameters
782
+ # A list of parameters within a parameter group. Each element in the
783
+ # list represents one parameter.
784
+ # @return [Array<Types::Parameter>]
785
+ #
786
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeParametersResponse AWS API Documentation
787
+ #
788
+ class DescribeParametersResponse < Struct.new(
789
+ :next_token,
790
+ :parameters)
791
+ include Aws::Structure
792
+ end
793
+
794
+ # @note When making an API call, you may pass DescribeSubnetGroupsRequest
795
+ # data as a hash:
796
+ #
797
+ # {
798
+ # subnet_group_names: ["String"],
799
+ # max_results: 1,
800
+ # next_token: "String",
801
+ # }
802
+ #
803
+ # @!attribute [rw] subnet_group_names
804
+ # The name of the subnet group.
805
+ # @return [Array<String>]
806
+ #
807
+ # @!attribute [rw] max_results
808
+ # The maximum number of results to include in the response. If more
809
+ # results exist than the specified `MaxResults` value, a token is
810
+ # included in the response so that the remaining results can be
811
+ # retrieved.
812
+ #
813
+ # The value for `MaxResults` must be between 20 and 100.
814
+ # @return [Integer]
815
+ #
816
+ # @!attribute [rw] next_token
817
+ # An optional token returned from a prior request. Use this token for
818
+ # pagination of results from this action. If this parameter is
819
+ # specified, the response includes only results beyond the token, up
820
+ # to the value specified by `MaxResults`.
821
+ # @return [String]
822
+ #
823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeSubnetGroupsRequest AWS API Documentation
824
+ #
825
+ class DescribeSubnetGroupsRequest < Struct.new(
826
+ :subnet_group_names,
827
+ :max_results,
828
+ :next_token)
829
+ include Aws::Structure
830
+ end
831
+
832
+ # @!attribute [rw] next_token
833
+ # Provides an identifier to allow retrieval of paginated results.
834
+ # @return [String]
835
+ #
836
+ # @!attribute [rw] subnet_groups
837
+ # An array of subnet groups. Each element in the array represents a
838
+ # single subnet group.
839
+ # @return [Array<Types::SubnetGroup>]
840
+ #
841
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/DescribeSubnetGroupsResponse AWS API Documentation
842
+ #
843
+ class DescribeSubnetGroupsResponse < Struct.new(
844
+ :next_token,
845
+ :subnet_groups)
846
+ include Aws::Structure
847
+ end
848
+
849
+ # Represents the information required for client programs to connect to
850
+ # the configuration endpoint for a DAX cluster, or to an individual node
851
+ # within the cluster.
852
+ #
853
+ # @!attribute [rw] address
854
+ # The DNS hostname of the endpoint.
855
+ # @return [String]
856
+ #
857
+ # @!attribute [rw] port
858
+ # The port number that applications should use to connect to the
859
+ # endpoint.
860
+ # @return [Integer]
861
+ #
862
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/Endpoint AWS API Documentation
863
+ #
864
+ class Endpoint < Struct.new(
865
+ :address,
866
+ :port)
867
+ include Aws::Structure
868
+ end
869
+
870
+ # Represents a single occurrence of something interesting within the
871
+ # system. Some examples of events are creating a DAX cluster, adding or
872
+ # removing a node, or rebooting a node.
873
+ #
874
+ # @!attribute [rw] source_name
875
+ # The source of the event. For example, if the event occurred at the
876
+ # node level, the source would be the node ID.
877
+ # @return [String]
878
+ #
879
+ # @!attribute [rw] source_type
880
+ # Specifies the origin of this event - a cluster, a parameter group, a
881
+ # node ID, etc.
882
+ # @return [String]
883
+ #
884
+ # @!attribute [rw] message
885
+ # A user-defined message associated with the event.
886
+ # @return [String]
887
+ #
888
+ # @!attribute [rw] date
889
+ # The date and time when the event occurred.
890
+ # @return [Time]
891
+ #
892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/Event AWS API Documentation
893
+ #
894
+ class Event < Struct.new(
895
+ :source_name,
896
+ :source_type,
897
+ :message,
898
+ :date)
899
+ include Aws::Structure
900
+ end
901
+
902
+ # @note When making an API call, you may pass IncreaseReplicationFactorRequest
903
+ # data as a hash:
904
+ #
905
+ # {
906
+ # cluster_name: "String", # required
907
+ # new_replication_factor: 1, # required
908
+ # availability_zones: ["String"],
909
+ # }
910
+ #
911
+ # @!attribute [rw] cluster_name
912
+ # The name of the DAX cluster that will receive additional nodes.
913
+ # @return [String]
914
+ #
915
+ # @!attribute [rw] new_replication_factor
916
+ # The new number of nodes for the DAX cluster.
917
+ # @return [Integer]
918
+ #
919
+ # @!attribute [rw] availability_zones
920
+ # The Availability Zones (AZs) in which the cluster nodes will be
921
+ # created. All nodes belonging to the cluster are placed in these
922
+ # Availability Zones. Use this parameter if you want to distribute the
923
+ # nodes across multiple AZs.
924
+ # @return [Array<String>]
925
+ #
926
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/IncreaseReplicationFactorRequest AWS API Documentation
927
+ #
928
+ class IncreaseReplicationFactorRequest < Struct.new(
929
+ :cluster_name,
930
+ :new_replication_factor,
931
+ :availability_zones)
932
+ include Aws::Structure
933
+ end
934
+
935
+ # @!attribute [rw] cluster
936
+ # A description of the DAX cluster. with its new replication factor.
937
+ # @return [Types::Cluster]
938
+ #
939
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/IncreaseReplicationFactorResponse AWS API Documentation
940
+ #
941
+ class IncreaseReplicationFactorResponse < Struct.new(
942
+ :cluster)
943
+ include Aws::Structure
944
+ end
945
+
946
+ # @note When making an API call, you may pass ListTagsRequest
947
+ # data as a hash:
948
+ #
949
+ # {
950
+ # resource_name: "String", # required
951
+ # next_token: "String",
952
+ # }
953
+ #
954
+ # @!attribute [rw] resource_name
955
+ # The name of the DAX resource to which the tags belong.
956
+ # @return [String]
957
+ #
958
+ # @!attribute [rw] next_token
959
+ # An optional token returned from a prior request. Use this token for
960
+ # pagination of results from this action. If this parameter is
961
+ # specified, the response includes only results beyond the token.
962
+ # @return [String]
963
+ #
964
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/ListTagsRequest AWS API Documentation
965
+ #
966
+ class ListTagsRequest < Struct.new(
967
+ :resource_name,
968
+ :next_token)
969
+ include Aws::Structure
970
+ end
971
+
972
+ # @!attribute [rw] tags
973
+ # A list of tags currently associated with the DAX cluster.
974
+ # @return [Array<Types::Tag>]
975
+ #
976
+ # @!attribute [rw] next_token
977
+ # If this value is present, there are additional results to be
978
+ # displayed. To retrieve them, call `ListTags` again, with `NextToken`
979
+ # set to this value.
980
+ # @return [String]
981
+ #
982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/ListTagsResponse AWS API Documentation
983
+ #
984
+ class ListTagsResponse < Struct.new(
985
+ :tags,
986
+ :next_token)
987
+ include Aws::Structure
988
+ end
989
+
990
+ # Represents an individual node within a DAX cluster.
991
+ #
992
+ # @!attribute [rw] node_id
993
+ # A system-generated identifier for the node.
994
+ # @return [String]
995
+ #
996
+ # @!attribute [rw] endpoint
997
+ # The endpoint for the node, consisting of a DNS name and a port
998
+ # number. Client applications can connect directly to a node endpoint,
999
+ # if desired (as an alternative to allowing DAX client software to
1000
+ # intelligently route requests and responses to nodes in the DAX
1001
+ # cluster.
1002
+ # @return [Types::Endpoint]
1003
+ #
1004
+ # @!attribute [rw] node_create_time
1005
+ # The date and time (in UNIX epoch format) when the node was launched.
1006
+ # @return [Time]
1007
+ #
1008
+ # @!attribute [rw] availability_zone
1009
+ # The Availability Zone (AZ) in which the node has been deployed.
1010
+ # @return [String]
1011
+ #
1012
+ # @!attribute [rw] node_status
1013
+ # The current status of the node. For example: `available`.
1014
+ # @return [String]
1015
+ #
1016
+ # @!attribute [rw] parameter_group_status
1017
+ # The status of the parameter group associated with this node. For
1018
+ # example, `in-sync`.
1019
+ # @return [String]
1020
+ #
1021
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/Node AWS API Documentation
1022
+ #
1023
+ class Node < Struct.new(
1024
+ :node_id,
1025
+ :endpoint,
1026
+ :node_create_time,
1027
+ :availability_zone,
1028
+ :node_status,
1029
+ :parameter_group_status)
1030
+ include Aws::Structure
1031
+ end
1032
+
1033
+ # Represents a parameter value that is applicable to a particular node
1034
+ # type.
1035
+ #
1036
+ # @!attribute [rw] node_type
1037
+ # A node type to which the parameter value applies.
1038
+ # @return [String]
1039
+ #
1040
+ # @!attribute [rw] value
1041
+ # The parameter value for this node type.
1042
+ # @return [String]
1043
+ #
1044
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/NodeTypeSpecificValue AWS API Documentation
1045
+ #
1046
+ class NodeTypeSpecificValue < Struct.new(
1047
+ :node_type,
1048
+ :value)
1049
+ include Aws::Structure
1050
+ end
1051
+
1052
+ # Describes a notification topic and its status. Notification topics are
1053
+ # used for publishing DAX events to subscribers using Amazon Simple
1054
+ # Notification Service (SNS).
1055
+ #
1056
+ # @!attribute [rw] topic_arn
1057
+ # The Amazon Resource Name (ARN) that identifies the topic.
1058
+ # @return [String]
1059
+ #
1060
+ # @!attribute [rw] topic_status
1061
+ # The current state of the topic.
1062
+ # @return [String]
1063
+ #
1064
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/NotificationConfiguration AWS API Documentation
1065
+ #
1066
+ class NotificationConfiguration < Struct.new(
1067
+ :topic_arn,
1068
+ :topic_status)
1069
+ include Aws::Structure
1070
+ end
1071
+
1072
+ # Describes an individual setting that controls some aspect of DAX
1073
+ # behavior.
1074
+ #
1075
+ # @!attribute [rw] parameter_name
1076
+ # The name of the parameter.
1077
+ # @return [String]
1078
+ #
1079
+ # @!attribute [rw] parameter_type
1080
+ # Determines whether the parameter can be applied to any nodes, or
1081
+ # only nodes of a particular type.
1082
+ # @return [String]
1083
+ #
1084
+ # @!attribute [rw] parameter_value
1085
+ # The value for the parameter.
1086
+ # @return [String]
1087
+ #
1088
+ # @!attribute [rw] node_type_specific_values
1089
+ # A list of node types, and specific parameter values for each node.
1090
+ # @return [Array<Types::NodeTypeSpecificValue>]
1091
+ #
1092
+ # @!attribute [rw] description
1093
+ # A description of the parameter
1094
+ # @return [String]
1095
+ #
1096
+ # @!attribute [rw] source
1097
+ # How the parameter is defined. For example, `system` denotes a
1098
+ # system-defined parameter.
1099
+ # @return [String]
1100
+ #
1101
+ # @!attribute [rw] data_type
1102
+ # The data type of the parameter. For example, `integer`\:
1103
+ # @return [String]
1104
+ #
1105
+ # @!attribute [rw] allowed_values
1106
+ # A range of values within which the parameter can be set.
1107
+ # @return [String]
1108
+ #
1109
+ # @!attribute [rw] is_modifiable
1110
+ # Whether the customer is allowed to modify the parameter.
1111
+ # @return [String]
1112
+ #
1113
+ # @!attribute [rw] change_type
1114
+ # The conditions under which changes to this parameter can be applied.
1115
+ # For example, `requires-reboot` indicates that a new value for this
1116
+ # parameter will only take effect if a node is rebooted.
1117
+ # @return [String]
1118
+ #
1119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/Parameter AWS API Documentation
1120
+ #
1121
+ class Parameter < Struct.new(
1122
+ :parameter_name,
1123
+ :parameter_type,
1124
+ :parameter_value,
1125
+ :node_type_specific_values,
1126
+ :description,
1127
+ :source,
1128
+ :data_type,
1129
+ :allowed_values,
1130
+ :is_modifiable,
1131
+ :change_type)
1132
+ include Aws::Structure
1133
+ end
1134
+
1135
+ # A named set of parameters that are applied to all of the nodes in a
1136
+ # DAX cluster.
1137
+ #
1138
+ # @!attribute [rw] parameter_group_name
1139
+ # The name of the parameter group.
1140
+ # @return [String]
1141
+ #
1142
+ # @!attribute [rw] description
1143
+ # A description of the parameter group.
1144
+ # @return [String]
1145
+ #
1146
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/ParameterGroup AWS API Documentation
1147
+ #
1148
+ class ParameterGroup < Struct.new(
1149
+ :parameter_group_name,
1150
+ :description)
1151
+ include Aws::Structure
1152
+ end
1153
+
1154
+ # The status of a parameter group.
1155
+ #
1156
+ # @!attribute [rw] parameter_group_name
1157
+ # The name of the parameter group.
1158
+ # @return [String]
1159
+ #
1160
+ # @!attribute [rw] parameter_apply_status
1161
+ # The status of parameter updates.
1162
+ # @return [String]
1163
+ #
1164
+ # @!attribute [rw] node_ids_to_reboot
1165
+ # The node IDs of one or more nodes to be rebooted.
1166
+ # @return [Array<String>]
1167
+ #
1168
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/ParameterGroupStatus AWS API Documentation
1169
+ #
1170
+ class ParameterGroupStatus < Struct.new(
1171
+ :parameter_group_name,
1172
+ :parameter_apply_status,
1173
+ :node_ids_to_reboot)
1174
+ include Aws::Structure
1175
+ end
1176
+
1177
+ # An individual DAX parameter.
1178
+ #
1179
+ # @note When making an API call, you may pass ParameterNameValue
1180
+ # data as a hash:
1181
+ #
1182
+ # {
1183
+ # parameter_name: "String",
1184
+ # parameter_value: "String",
1185
+ # }
1186
+ #
1187
+ # @!attribute [rw] parameter_name
1188
+ # The name of the parameter.
1189
+ # @return [String]
1190
+ #
1191
+ # @!attribute [rw] parameter_value
1192
+ # The value of the parameter.
1193
+ # @return [String]
1194
+ #
1195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/ParameterNameValue AWS API Documentation
1196
+ #
1197
+ class ParameterNameValue < Struct.new(
1198
+ :parameter_name,
1199
+ :parameter_value)
1200
+ include Aws::Structure
1201
+ end
1202
+
1203
+ # @note When making an API call, you may pass RebootNodeRequest
1204
+ # data as a hash:
1205
+ #
1206
+ # {
1207
+ # cluster_name: "String", # required
1208
+ # node_id: "String", # required
1209
+ # }
1210
+ #
1211
+ # @!attribute [rw] cluster_name
1212
+ # The name of the DAX cluster containing the node to be rebooted.
1213
+ # @return [String]
1214
+ #
1215
+ # @!attribute [rw] node_id
1216
+ # The system-assigned ID of the node to be rebooted.
1217
+ # @return [String]
1218
+ #
1219
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/RebootNodeRequest AWS API Documentation
1220
+ #
1221
+ class RebootNodeRequest < Struct.new(
1222
+ :cluster_name,
1223
+ :node_id)
1224
+ include Aws::Structure
1225
+ end
1226
+
1227
+ # @!attribute [rw] cluster
1228
+ # A description of the DAX cluster after a node has been rebooted.
1229
+ # @return [Types::Cluster]
1230
+ #
1231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/RebootNodeResponse AWS API Documentation
1232
+ #
1233
+ class RebootNodeResponse < Struct.new(
1234
+ :cluster)
1235
+ include Aws::Structure
1236
+ end
1237
+
1238
+ # An individual VPC security group and its status.
1239
+ #
1240
+ # @!attribute [rw] security_group_identifier
1241
+ # The unique ID for this security group.
1242
+ # @return [String]
1243
+ #
1244
+ # @!attribute [rw] status
1245
+ # The status of this security group.
1246
+ # @return [String]
1247
+ #
1248
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/SecurityGroupMembership AWS API Documentation
1249
+ #
1250
+ class SecurityGroupMembership < Struct.new(
1251
+ :security_group_identifier,
1252
+ :status)
1253
+ include Aws::Structure
1254
+ end
1255
+
1256
+ # Represents the subnet associated with a DAX cluster. This parameter
1257
+ # refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC)
1258
+ # and used with DAX.
1259
+ #
1260
+ # @!attribute [rw] subnet_identifier
1261
+ # The system-assigned identifier for the subnet.
1262
+ # @return [String]
1263
+ #
1264
+ # @!attribute [rw] subnet_availability_zone
1265
+ # The Availability Zone (AZ) for subnet subnet.
1266
+ # @return [String]
1267
+ #
1268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/Subnet AWS API Documentation
1269
+ #
1270
+ class Subnet < Struct.new(
1271
+ :subnet_identifier,
1272
+ :subnet_availability_zone)
1273
+ include Aws::Structure
1274
+ end
1275
+
1276
+ # Represents the output of one of the following actions:
1277
+ #
1278
+ # * *CreateSubnetGroup*
1279
+ #
1280
+ # * *ModifySubnetGroup*
1281
+ #
1282
+ # @!attribute [rw] subnet_group_name
1283
+ # The name of the subnet group.
1284
+ # @return [String]
1285
+ #
1286
+ # @!attribute [rw] description
1287
+ # The description of the subnet group.
1288
+ # @return [String]
1289
+ #
1290
+ # @!attribute [rw] vpc_id
1291
+ # The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet
1292
+ # group.
1293
+ # @return [String]
1294
+ #
1295
+ # @!attribute [rw] subnets
1296
+ # A list of subnets associated with the subnet group.
1297
+ # @return [Array<Types::Subnet>]
1298
+ #
1299
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/SubnetGroup AWS API Documentation
1300
+ #
1301
+ class SubnetGroup < Struct.new(
1302
+ :subnet_group_name,
1303
+ :description,
1304
+ :vpc_id,
1305
+ :subnets)
1306
+ include Aws::Structure
1307
+ end
1308
+
1309
+ # A description of a tag. Every tag is a key-value pair. You can add up
1310
+ # to 50 tags to a single DAX cluster.
1311
+ #
1312
+ # AWS-assigned tag names and values are automatically assigned the
1313
+ # `aws:` prefix, which the user cannot assign. AWS-assigned tag names do
1314
+ # not count towards the tag limit of 50. User-assigned tag names have
1315
+ # the prefix `user:`.
1316
+ #
1317
+ # You cannot backdate the application of a tag.
1318
+ #
1319
+ # @note When making an API call, you may pass Tag
1320
+ # data as a hash:
1321
+ #
1322
+ # {
1323
+ # key: "String",
1324
+ # value: "String",
1325
+ # }
1326
+ #
1327
+ # @!attribute [rw] key
1328
+ # The key for the tag. Tag keys are case sensitive. Every DAX cluster
1329
+ # can only have one tag with the same key. If you try to add an
1330
+ # existing tag (same key), the existing tag value will be updated to
1331
+ # the new value.
1332
+ # @return [String]
1333
+ #
1334
+ # @!attribute [rw] value
1335
+ # The value of the tag. Tag values are case-sensitive and can be null.
1336
+ # @return [String]
1337
+ #
1338
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/Tag AWS API Documentation
1339
+ #
1340
+ class Tag < Struct.new(
1341
+ :key,
1342
+ :value)
1343
+ include Aws::Structure
1344
+ end
1345
+
1346
+ # @note When making an API call, you may pass TagResourceRequest
1347
+ # data as a hash:
1348
+ #
1349
+ # {
1350
+ # resource_name: "String", # required
1351
+ # tags: [ # required
1352
+ # {
1353
+ # key: "String",
1354
+ # value: "String",
1355
+ # },
1356
+ # ],
1357
+ # }
1358
+ #
1359
+ # @!attribute [rw] resource_name
1360
+ # The name of the DAX resource to which tags should be added.
1361
+ # @return [String]
1362
+ #
1363
+ # @!attribute [rw] tags
1364
+ # The tags to be assigned to the DAX resource.
1365
+ # @return [Array<Types::Tag>]
1366
+ #
1367
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/TagResourceRequest AWS API Documentation
1368
+ #
1369
+ class TagResourceRequest < Struct.new(
1370
+ :resource_name,
1371
+ :tags)
1372
+ include Aws::Structure
1373
+ end
1374
+
1375
+ # @!attribute [rw] tags
1376
+ # The list of tags that are associated with the DAX resource.
1377
+ # @return [Array<Types::Tag>]
1378
+ #
1379
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/TagResourceResponse AWS API Documentation
1380
+ #
1381
+ class TagResourceResponse < Struct.new(
1382
+ :tags)
1383
+ include Aws::Structure
1384
+ end
1385
+
1386
+ # @note When making an API call, you may pass UntagResourceRequest
1387
+ # data as a hash:
1388
+ #
1389
+ # {
1390
+ # resource_name: "String", # required
1391
+ # tag_keys: ["String"], # required
1392
+ # }
1393
+ #
1394
+ # @!attribute [rw] resource_name
1395
+ # The name of the DAX resource from which the tags should be removed.
1396
+ # @return [String]
1397
+ #
1398
+ # @!attribute [rw] tag_keys
1399
+ # A list of tag keys. If the DAX cluster has any tags with these keys,
1400
+ # then the tags are removed from the cluster.
1401
+ # @return [Array<String>]
1402
+ #
1403
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/UntagResourceRequest AWS API Documentation
1404
+ #
1405
+ class UntagResourceRequest < Struct.new(
1406
+ :resource_name,
1407
+ :tag_keys)
1408
+ include Aws::Structure
1409
+ end
1410
+
1411
+ # @!attribute [rw] tags
1412
+ # The tag keys that have been removed from the cluster.
1413
+ # @return [Array<Types::Tag>]
1414
+ #
1415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/UntagResourceResponse AWS API Documentation
1416
+ #
1417
+ class UntagResourceResponse < Struct.new(
1418
+ :tags)
1419
+ include Aws::Structure
1420
+ end
1421
+
1422
+ # @note When making an API call, you may pass UpdateClusterRequest
1423
+ # data as a hash:
1424
+ #
1425
+ # {
1426
+ # cluster_name: "String", # required
1427
+ # description: "String",
1428
+ # preferred_maintenance_window: "String",
1429
+ # notification_topic_arn: "String",
1430
+ # notification_topic_status: "String",
1431
+ # parameter_group_name: "String",
1432
+ # security_group_ids: ["String"],
1433
+ # }
1434
+ #
1435
+ # @!attribute [rw] cluster_name
1436
+ # The name of the DAX cluster to be modified.
1437
+ # @return [String]
1438
+ #
1439
+ # @!attribute [rw] description
1440
+ # A description of the changes being made to the cluster.
1441
+ # @return [String]
1442
+ #
1443
+ # @!attribute [rw] preferred_maintenance_window
1444
+ # A range of time when maintenance of DAX cluster software will be
1445
+ # performed. For example: `sun:01:00-sun:09:00`. Cluster maintenance
1446
+ # normally takes less than 30 minutes, and is performed automatically
1447
+ # within the maintenance window.
1448
+ # @return [String]
1449
+ #
1450
+ # @!attribute [rw] notification_topic_arn
1451
+ # The Amazon Resource Name (ARN) that identifies the topic.
1452
+ # @return [String]
1453
+ #
1454
+ # @!attribute [rw] notification_topic_status
1455
+ # The current state of the topic.
1456
+ # @return [String]
1457
+ #
1458
+ # @!attribute [rw] parameter_group_name
1459
+ # The name of a parameter group for this cluster.
1460
+ # @return [String]
1461
+ #
1462
+ # @!attribute [rw] security_group_ids
1463
+ # A list of user-specified security group IDs to be assigned to each
1464
+ # node in the DAX cluster. If this parameter is not specified, DAX
1465
+ # assigns the default VPC security group to each node.
1466
+ # @return [Array<String>]
1467
+ #
1468
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/UpdateClusterRequest AWS API Documentation
1469
+ #
1470
+ class UpdateClusterRequest < Struct.new(
1471
+ :cluster_name,
1472
+ :description,
1473
+ :preferred_maintenance_window,
1474
+ :notification_topic_arn,
1475
+ :notification_topic_status,
1476
+ :parameter_group_name,
1477
+ :security_group_ids)
1478
+ include Aws::Structure
1479
+ end
1480
+
1481
+ # @!attribute [rw] cluster
1482
+ # A description of the DAX cluster, after it has been modified.
1483
+ # @return [Types::Cluster]
1484
+ #
1485
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/UpdateClusterResponse AWS API Documentation
1486
+ #
1487
+ class UpdateClusterResponse < Struct.new(
1488
+ :cluster)
1489
+ include Aws::Structure
1490
+ end
1491
+
1492
+ # @note When making an API call, you may pass UpdateParameterGroupRequest
1493
+ # data as a hash:
1494
+ #
1495
+ # {
1496
+ # parameter_group_name: "String", # required
1497
+ # parameter_name_values: [ # required
1498
+ # {
1499
+ # parameter_name: "String",
1500
+ # parameter_value: "String",
1501
+ # },
1502
+ # ],
1503
+ # }
1504
+ #
1505
+ # @!attribute [rw] parameter_group_name
1506
+ # The name of the parameter group.
1507
+ # @return [String]
1508
+ #
1509
+ # @!attribute [rw] parameter_name_values
1510
+ # An array of name-value pairs for the parameters in the group. Each
1511
+ # element in the array represents a single parameter.
1512
+ # @return [Array<Types::ParameterNameValue>]
1513
+ #
1514
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/UpdateParameterGroupRequest AWS API Documentation
1515
+ #
1516
+ class UpdateParameterGroupRequest < Struct.new(
1517
+ :parameter_group_name,
1518
+ :parameter_name_values)
1519
+ include Aws::Structure
1520
+ end
1521
+
1522
+ # @!attribute [rw] parameter_group
1523
+ # The parameter group that has been modified.
1524
+ # @return [Types::ParameterGroup]
1525
+ #
1526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/UpdateParameterGroupResponse AWS API Documentation
1527
+ #
1528
+ class UpdateParameterGroupResponse < Struct.new(
1529
+ :parameter_group)
1530
+ include Aws::Structure
1531
+ end
1532
+
1533
+ # @note When making an API call, you may pass UpdateSubnetGroupRequest
1534
+ # data as a hash:
1535
+ #
1536
+ # {
1537
+ # subnet_group_name: "String", # required
1538
+ # description: "String",
1539
+ # subnet_ids: ["String"],
1540
+ # }
1541
+ #
1542
+ # @!attribute [rw] subnet_group_name
1543
+ # The name of the subnet group.
1544
+ # @return [String]
1545
+ #
1546
+ # @!attribute [rw] description
1547
+ # A description of the subnet group.
1548
+ # @return [String]
1549
+ #
1550
+ # @!attribute [rw] subnet_ids
1551
+ # A list of subnet IDs in the subnet group.
1552
+ # @return [Array<String>]
1553
+ #
1554
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/UpdateSubnetGroupRequest AWS API Documentation
1555
+ #
1556
+ class UpdateSubnetGroupRequest < Struct.new(
1557
+ :subnet_group_name,
1558
+ :description,
1559
+ :subnet_ids)
1560
+ include Aws::Structure
1561
+ end
1562
+
1563
+ # @!attribute [rw] subnet_group
1564
+ # The subnet group that has been modified.
1565
+ # @return [Types::SubnetGroup]
1566
+ #
1567
+ # @see http://docs.aws.amazon.com/goto/WebAPI/dax-2017-04-19/UpdateSubnetGroupResponse AWS API Documentation
1568
+ #
1569
+ class UpdateSubnetGroupResponse < Struct.new(
1570
+ :subnet_group)
1571
+ include Aws::Structure
1572
+ end
1573
+
1574
+ end
1575
+ end