aws-sdk-timestreaminfluxdb 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1182 @@
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::TimestreamInfluxDB
11
+ module Types
12
+
13
+ # You do not have sufficient access to perform this action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # The request conflicts with an existing resource in Timestream for
27
+ # InfluxDB.
28
+ #
29
+ # @!attribute [rw] message
30
+ # @return [String]
31
+ #
32
+ # @!attribute [rw] resource_id
33
+ # The identifier for the Timestream for InfluxDB resource associated
34
+ # with the request.
35
+ # @return [String]
36
+ #
37
+ # @!attribute [rw] resource_type
38
+ # The type of Timestream for InfluxDB resource associated with the
39
+ # request.
40
+ # @return [String]
41
+ #
42
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ConflictException AWS API Documentation
43
+ #
44
+ class ConflictException < Struct.new(
45
+ :message,
46
+ :resource_id,
47
+ :resource_type)
48
+ SENSITIVE = []
49
+ include Aws::Structure
50
+ end
51
+
52
+ # @!attribute [rw] name
53
+ # The name that uniquely identifies the DB instance when interacting
54
+ # with the Amazon Timestream for InfluxDB API and CLI commands. This
55
+ # name will also be a prefix included in the endpoint. DB instance
56
+ # names must be unique per customer and per region.
57
+ # @return [String]
58
+ #
59
+ # @!attribute [rw] username
60
+ # The username of the initial admin user created in InfluxDB. Must
61
+ # start with a letter and can't end with a hyphen or contain two
62
+ # consecutive hyphens. For example, my-user1. This username will allow
63
+ # you to access the InfluxDB UI to perform various administrative
64
+ # tasks and also use the InfluxDB CLI to create an operator token.
65
+ # These attributes will be stored in a Secret created in Amazon
66
+ # Secrets Manager in your account.
67
+ # @return [String]
68
+ #
69
+ # @!attribute [rw] password
70
+ # The password of the initial admin user created in InfluxDB. This
71
+ # password will allow you to access the InfluxDB UI to perform various
72
+ # administrative tasks and also use the InfluxDB CLI to create an
73
+ # operator token. These attributes will be stored in a Secret created
74
+ # in AWS SecretManager in your account.
75
+ # @return [String]
76
+ #
77
+ # @!attribute [rw] organization
78
+ # The name of the initial organization for the initial admin user in
79
+ # InfluxDB. An InfluxDB organization is a workspace for a group of
80
+ # users.
81
+ # @return [String]
82
+ #
83
+ # @!attribute [rw] bucket
84
+ # The name of the initial InfluxDB bucket. All InfluxDB data is stored
85
+ # in a bucket. A bucket combines the concept of a database and a
86
+ # retention period (the duration of time that each data point
87
+ # persists). A bucket belongs to an organization.
88
+ # @return [String]
89
+ #
90
+ # @!attribute [rw] db_instance_type
91
+ # The Timestream for InfluxDB DB instance type to run InfluxDB on.
92
+ # @return [String]
93
+ #
94
+ # @!attribute [rw] vpc_subnet_ids
95
+ # A list of VPC subnet IDs to associate with the DB instance. Provide
96
+ # at least two VPC subnet IDs in different availability zones when
97
+ # deploying with a Multi-AZ standby.
98
+ # @return [Array<String>]
99
+ #
100
+ # @!attribute [rw] vpc_security_group_ids
101
+ # A list of VPC security group IDs to associate with the DB instance.
102
+ # @return [Array<String>]
103
+ #
104
+ # @!attribute [rw] publicly_accessible
105
+ # Configures the DB instance with a public IP to facilitate access.
106
+ # @return [Boolean]
107
+ #
108
+ # @!attribute [rw] db_storage_type
109
+ # The Timestream for InfluxDB DB storage type to read and write
110
+ # InfluxDB data.
111
+ #
112
+ # You can choose between 3 different types of provisioned Influx IOPS
113
+ # included storage according to your workloads requirements:
114
+ #
115
+ # * Influx IO Included 3000 IOPS
116
+ #
117
+ # * Influx IO Included 12000 IOPS
118
+ #
119
+ # * Influx IO Included 16000 IOPS
120
+ # @return [String]
121
+ #
122
+ # @!attribute [rw] allocated_storage
123
+ # The amount of storage to allocate for your DB storage type in GiB
124
+ # (gibibytes).
125
+ # @return [Integer]
126
+ #
127
+ # @!attribute [rw] db_parameter_group_identifier
128
+ # The id of the DB parameter group to assign to your DB instance. DB
129
+ # parameter groups specify how the database is configured. For
130
+ # example, DB parameter groups can specify the limit for query
131
+ # concurrency.
132
+ # @return [String]
133
+ #
134
+ # @!attribute [rw] deployment_type
135
+ # Specifies whether the DB instance will be deployed as a standalone
136
+ # instance or with a Multi-AZ standby for high availability.
137
+ # @return [String]
138
+ #
139
+ # @!attribute [rw] log_delivery_configuration
140
+ # Configuration for sending InfluxDB engine logs to a specified S3
141
+ # bucket.
142
+ # @return [Types::LogDeliveryConfiguration]
143
+ #
144
+ # @!attribute [rw] tags
145
+ # A list of key-value pairs to associate with the DB instance.
146
+ # @return [Hash<String,String>]
147
+ #
148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/CreateDbInstanceInput AWS API Documentation
149
+ #
150
+ class CreateDbInstanceInput < Struct.new(
151
+ :name,
152
+ :username,
153
+ :password,
154
+ :organization,
155
+ :bucket,
156
+ :db_instance_type,
157
+ :vpc_subnet_ids,
158
+ :vpc_security_group_ids,
159
+ :publicly_accessible,
160
+ :db_storage_type,
161
+ :allocated_storage,
162
+ :db_parameter_group_identifier,
163
+ :deployment_type,
164
+ :log_delivery_configuration,
165
+ :tags)
166
+ SENSITIVE = [:username, :password]
167
+ include Aws::Structure
168
+ end
169
+
170
+ # @!attribute [rw] id
171
+ # A service-generated unique identifier.
172
+ # @return [String]
173
+ #
174
+ # @!attribute [rw] name
175
+ # The customer-supplied name that uniquely identifies the DB instance
176
+ # when interacting with the Amazon Timestream for InfluxDB API and CLI
177
+ # commands.
178
+ # @return [String]
179
+ #
180
+ # @!attribute [rw] arn
181
+ # The Amazon Resource Name (ARN) of the DB instance.
182
+ # @return [String]
183
+ #
184
+ # @!attribute [rw] status
185
+ # The status of the DB instance.
186
+ # @return [String]
187
+ #
188
+ # @!attribute [rw] endpoint
189
+ # The endpoint used to connect to InfluxDB. The default InfluxDB port
190
+ # is 8086.
191
+ # @return [String]
192
+ #
193
+ # @!attribute [rw] db_instance_type
194
+ # The Timestream for InfluxDB instance type that InfluxDB runs on.
195
+ # @return [String]
196
+ #
197
+ # @!attribute [rw] db_storage_type
198
+ # The Timestream for InfluxDB DB storage type that InfluxDB stores
199
+ # data on.
200
+ # @return [String]
201
+ #
202
+ # @!attribute [rw] allocated_storage
203
+ # The amount of storage allocated for your DB storage type (in
204
+ # gibibytes).
205
+ # @return [Integer]
206
+ #
207
+ # @!attribute [rw] deployment_type
208
+ # Specifies whether the Timestream for InfluxDB is deployed as
209
+ # Single-AZ or with a MultiAZ Standby for High availability.
210
+ # @return [String]
211
+ #
212
+ # @!attribute [rw] vpc_subnet_ids
213
+ # A list of VPC subnet IDs associated with the DB instance.
214
+ # @return [Array<String>]
215
+ #
216
+ # @!attribute [rw] publicly_accessible
217
+ # Indicates if the DB instance has a public IP to facilitate access.
218
+ # @return [Boolean]
219
+ #
220
+ # @!attribute [rw] vpc_security_group_ids
221
+ # A list of VPC security group IDs associated with the DB instance.
222
+ # @return [Array<String>]
223
+ #
224
+ # @!attribute [rw] db_parameter_group_identifier
225
+ # The id of the DB parameter group assigned to your DB instance.
226
+ # @return [String]
227
+ #
228
+ # @!attribute [rw] availability_zone
229
+ # The Availability Zone in which the DB instance resides.
230
+ # @return [String]
231
+ #
232
+ # @!attribute [rw] secondary_availability_zone
233
+ # The Availability Zone in which the standby instance is located when
234
+ # deploying with a MultiAZ standby instance.
235
+ # @return [String]
236
+ #
237
+ # @!attribute [rw] log_delivery_configuration
238
+ # Configuration for sending InfluxDB engine logs to send to specified
239
+ # S3 bucket.
240
+ # @return [Types::LogDeliveryConfiguration]
241
+ #
242
+ # @!attribute [rw] influx_auth_parameters_secret_arn
243
+ # The Amazon Resource Name (ARN) of the AWS Secrets Manager secret
244
+ # containing the initial InfluxDB authorization parameters. The secret
245
+ # value is a JSON formatted key-value pair holding InfluxDB
246
+ # authorization values: organization, bucket, username, and password.
247
+ # @return [String]
248
+ #
249
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/CreateDbInstanceOutput AWS API Documentation
250
+ #
251
+ class CreateDbInstanceOutput < Struct.new(
252
+ :id,
253
+ :name,
254
+ :arn,
255
+ :status,
256
+ :endpoint,
257
+ :db_instance_type,
258
+ :db_storage_type,
259
+ :allocated_storage,
260
+ :deployment_type,
261
+ :vpc_subnet_ids,
262
+ :publicly_accessible,
263
+ :vpc_security_group_ids,
264
+ :db_parameter_group_identifier,
265
+ :availability_zone,
266
+ :secondary_availability_zone,
267
+ :log_delivery_configuration,
268
+ :influx_auth_parameters_secret_arn)
269
+ SENSITIVE = []
270
+ include Aws::Structure
271
+ end
272
+
273
+ # @!attribute [rw] name
274
+ # The name of the DB parameter group. The name must be unique per
275
+ # customer and per region.
276
+ # @return [String]
277
+ #
278
+ # @!attribute [rw] description
279
+ # A description of the DB parameter group.
280
+ # @return [String]
281
+ #
282
+ # @!attribute [rw] parameters
283
+ # A list of the parameters that comprise the DB parameter group.
284
+ # @return [Types::Parameters]
285
+ #
286
+ # @!attribute [rw] tags
287
+ # A list of key-value pairs to associate with the DB parameter group.
288
+ # @return [Hash<String,String>]
289
+ #
290
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/CreateDbParameterGroupInput AWS API Documentation
291
+ #
292
+ class CreateDbParameterGroupInput < Struct.new(
293
+ :name,
294
+ :description,
295
+ :parameters,
296
+ :tags)
297
+ SENSITIVE = []
298
+ include Aws::Structure
299
+ end
300
+
301
+ # @!attribute [rw] id
302
+ # A service-generated unique identifier.
303
+ # @return [String]
304
+ #
305
+ # @!attribute [rw] name
306
+ # The customer-supplied name that uniquely identifies the DB parameter
307
+ # group when interacting with the Amazon Timestream for InfluxDB API
308
+ # and CLI commands.
309
+ # @return [String]
310
+ #
311
+ # @!attribute [rw] arn
312
+ # The Amazon Resource Name (ARM) of the DB parameter group.
313
+ # @return [String]
314
+ #
315
+ # @!attribute [rw] description
316
+ # The description of the DB parameter group.
317
+ # @return [String]
318
+ #
319
+ # @!attribute [rw] parameters
320
+ # A list of the parameters that comprise the DB parameter group.
321
+ # @return [Types::Parameters]
322
+ #
323
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/CreateDbParameterGroupOutput AWS API Documentation
324
+ #
325
+ class CreateDbParameterGroupOutput < Struct.new(
326
+ :id,
327
+ :name,
328
+ :arn,
329
+ :description,
330
+ :parameters)
331
+ SENSITIVE = []
332
+ include Aws::Structure
333
+ end
334
+
335
+ # Contains a summary of a DB instance.
336
+ #
337
+ # @!attribute [rw] id
338
+ # The service-generated unique identifier of the DB instance.
339
+ # @return [String]
340
+ #
341
+ # @!attribute [rw] name
342
+ # This customer-supplied name uniquely identifies the DB instance when
343
+ # interacting with the Amazon Timestream for InfluxDB API and AWS CLI
344
+ # commands.
345
+ # @return [String]
346
+ #
347
+ # @!attribute [rw] arn
348
+ # The Amazon Resource Name (ARN) of the DB instance.
349
+ # @return [String]
350
+ #
351
+ # @!attribute [rw] status
352
+ # The status of the DB instance.
353
+ # @return [String]
354
+ #
355
+ # @!attribute [rw] endpoint
356
+ # The endpoint used to connect to InfluxDB. The default InfluxDB port
357
+ # is 8086.
358
+ # @return [String]
359
+ #
360
+ # @!attribute [rw] db_instance_type
361
+ # The Timestream for InfluxDB instance type to run InfluxDB on.
362
+ # @return [String]
363
+ #
364
+ # @!attribute [rw] db_storage_type
365
+ # The storage type for your DB instance.
366
+ # @return [String]
367
+ #
368
+ # @!attribute [rw] allocated_storage
369
+ # The amount of storage to allocate for your DbStorageType in GiB
370
+ # (gibibytes).
371
+ # @return [Integer]
372
+ #
373
+ # @!attribute [rw] deployment_type
374
+ # Single-Instance or with a MultiAZ Standby for High availability.
375
+ # @return [String]
376
+ #
377
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/DbInstanceSummary AWS API Documentation
378
+ #
379
+ class DbInstanceSummary < Struct.new(
380
+ :id,
381
+ :name,
382
+ :arn,
383
+ :status,
384
+ :endpoint,
385
+ :db_instance_type,
386
+ :db_storage_type,
387
+ :allocated_storage,
388
+ :deployment_type)
389
+ SENSITIVE = []
390
+ include Aws::Structure
391
+ end
392
+
393
+ # Contains a summary of a DB parameter group.
394
+ #
395
+ # @!attribute [rw] id
396
+ # A service-generated unique identifier.
397
+ # @return [String]
398
+ #
399
+ # @!attribute [rw] name
400
+ # This customer-supplied name uniquely identifies the parameter group.
401
+ # @return [String]
402
+ #
403
+ # @!attribute [rw] arn
404
+ # The Amazon Resource Name (ARN) of the DB parameter group.
405
+ # @return [String]
406
+ #
407
+ # @!attribute [rw] description
408
+ # A description of the DB parameter group.
409
+ # @return [String]
410
+ #
411
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/DbParameterGroupSummary AWS API Documentation
412
+ #
413
+ class DbParameterGroupSummary < Struct.new(
414
+ :id,
415
+ :name,
416
+ :arn,
417
+ :description)
418
+ SENSITIVE = []
419
+ include Aws::Structure
420
+ end
421
+
422
+ # @!attribute [rw] identifier
423
+ # The id of the DB instance.
424
+ # @return [String]
425
+ #
426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/DeleteDbInstanceInput AWS API Documentation
427
+ #
428
+ class DeleteDbInstanceInput < Struct.new(
429
+ :identifier)
430
+ SENSITIVE = []
431
+ include Aws::Structure
432
+ end
433
+
434
+ # @!attribute [rw] id
435
+ # A service-generated unique identifier.
436
+ # @return [String]
437
+ #
438
+ # @!attribute [rw] name
439
+ # The customer-supplied name that uniquely identifies the DB instance
440
+ # when interacting with the Amazon Timestream for InfluxDB API and CLI
441
+ # commands.
442
+ # @return [String]
443
+ #
444
+ # @!attribute [rw] arn
445
+ # The Amazon Resource Name (ARN) of the DB instance.
446
+ # @return [String]
447
+ #
448
+ # @!attribute [rw] status
449
+ # The status of the DB instance.
450
+ # @return [String]
451
+ #
452
+ # @!attribute [rw] endpoint
453
+ # The endpoint used to connect to InfluxDB. The default InfluxDB port
454
+ # is 8086.
455
+ # @return [String]
456
+ #
457
+ # @!attribute [rw] db_instance_type
458
+ # The Timestream for InfluxDB instance type that InfluxDB runs on.
459
+ # @return [String]
460
+ #
461
+ # @!attribute [rw] db_storage_type
462
+ # The Timestream for InfluxDB DB storage type that InfluxDB stores
463
+ # data on.
464
+ # @return [String]
465
+ #
466
+ # @!attribute [rw] allocated_storage
467
+ # The amount of storage allocated for your DB storage type (in
468
+ # gibibytes).
469
+ # @return [Integer]
470
+ #
471
+ # @!attribute [rw] deployment_type
472
+ # Specifies whether the Timestream for InfluxDB is deployed as
473
+ # Single-AZ or with a MultiAZ Standby for High availability.
474
+ # @return [String]
475
+ #
476
+ # @!attribute [rw] vpc_subnet_ids
477
+ # A list of VPC subnet IDs associated with the DB instance.
478
+ # @return [Array<String>]
479
+ #
480
+ # @!attribute [rw] publicly_accessible
481
+ # Indicates if the DB instance has a public IP to facilitate access.
482
+ # @return [Boolean]
483
+ #
484
+ # @!attribute [rw] vpc_security_group_ids
485
+ # A list of VPC security group IDs associated with the DB instance.
486
+ # @return [Array<String>]
487
+ #
488
+ # @!attribute [rw] db_parameter_group_identifier
489
+ # The id of the DB parameter group assigned to your DB instance.
490
+ # @return [String]
491
+ #
492
+ # @!attribute [rw] availability_zone
493
+ # The Availability Zone in which the DB instance resides.
494
+ # @return [String]
495
+ #
496
+ # @!attribute [rw] secondary_availability_zone
497
+ # The Availability Zone in which the standby instance is located when
498
+ # deploying with a MultiAZ standby instance.
499
+ # @return [String]
500
+ #
501
+ # @!attribute [rw] log_delivery_configuration
502
+ # Configuration for sending InfluxDB engine logs to send to specified
503
+ # S3 bucket.
504
+ # @return [Types::LogDeliveryConfiguration]
505
+ #
506
+ # @!attribute [rw] influx_auth_parameters_secret_arn
507
+ # The Amazon Resource Name (ARN) of the AWS Secrets Manager secret
508
+ # containing the initial InfluxDB authorization parameters. The secret
509
+ # value is a JSON formatted key-value pair holding InfluxDB
510
+ # authorization values: organization, bucket, username, and password.
511
+ # @return [String]
512
+ #
513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/DeleteDbInstanceOutput AWS API Documentation
514
+ #
515
+ class DeleteDbInstanceOutput < Struct.new(
516
+ :id,
517
+ :name,
518
+ :arn,
519
+ :status,
520
+ :endpoint,
521
+ :db_instance_type,
522
+ :db_storage_type,
523
+ :allocated_storage,
524
+ :deployment_type,
525
+ :vpc_subnet_ids,
526
+ :publicly_accessible,
527
+ :vpc_security_group_ids,
528
+ :db_parameter_group_identifier,
529
+ :availability_zone,
530
+ :secondary_availability_zone,
531
+ :log_delivery_configuration,
532
+ :influx_auth_parameters_secret_arn)
533
+ SENSITIVE = []
534
+ include Aws::Structure
535
+ end
536
+
537
+ # @!attribute [rw] identifier
538
+ # The id of the DB instance.
539
+ # @return [String]
540
+ #
541
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbInstanceInput AWS API Documentation
542
+ #
543
+ class GetDbInstanceInput < Struct.new(
544
+ :identifier)
545
+ SENSITIVE = []
546
+ include Aws::Structure
547
+ end
548
+
549
+ # @!attribute [rw] id
550
+ # A service-generated unique identifier.
551
+ # @return [String]
552
+ #
553
+ # @!attribute [rw] name
554
+ # The customer-supplied name that uniquely identifies the DB instance
555
+ # when interacting with the Amazon Timestream for InfluxDB API and CLI
556
+ # commands.
557
+ # @return [String]
558
+ #
559
+ # @!attribute [rw] arn
560
+ # The Amazon Resource Name (ARN) of the DB instance.
561
+ # @return [String]
562
+ #
563
+ # @!attribute [rw] status
564
+ # The status of the DB instance.
565
+ # @return [String]
566
+ #
567
+ # @!attribute [rw] endpoint
568
+ # The endpoint used to connect to InfluxDB. The default InfluxDB port
569
+ # is 8086.
570
+ # @return [String]
571
+ #
572
+ # @!attribute [rw] db_instance_type
573
+ # The Timestream for InfluxDB instance type that InfluxDB runs on.
574
+ # @return [String]
575
+ #
576
+ # @!attribute [rw] db_storage_type
577
+ # The Timestream for InfluxDB DB storage type that InfluxDB stores
578
+ # data on.
579
+ # @return [String]
580
+ #
581
+ # @!attribute [rw] allocated_storage
582
+ # The amount of storage allocated for your DB storage type (in
583
+ # gibibytes).
584
+ # @return [Integer]
585
+ #
586
+ # @!attribute [rw] deployment_type
587
+ # Specifies whether the Timestream for InfluxDB is deployed as
588
+ # Single-AZ or with a MultiAZ Standby for High availability.
589
+ # @return [String]
590
+ #
591
+ # @!attribute [rw] vpc_subnet_ids
592
+ # A list of VPC subnet IDs associated with the DB instance.
593
+ # @return [Array<String>]
594
+ #
595
+ # @!attribute [rw] publicly_accessible
596
+ # Indicates if the DB instance has a public IP to facilitate access.
597
+ # @return [Boolean]
598
+ #
599
+ # @!attribute [rw] vpc_security_group_ids
600
+ # A list of VPC security group IDs associated with the DB instance.
601
+ # @return [Array<String>]
602
+ #
603
+ # @!attribute [rw] db_parameter_group_identifier
604
+ # The id of the DB parameter group assigned to your DB instance.
605
+ # @return [String]
606
+ #
607
+ # @!attribute [rw] availability_zone
608
+ # The Availability Zone in which the DB instance resides.
609
+ # @return [String]
610
+ #
611
+ # @!attribute [rw] secondary_availability_zone
612
+ # The Availability Zone in which the standby instance is located when
613
+ # deploying with a MultiAZ standby instance.
614
+ # @return [String]
615
+ #
616
+ # @!attribute [rw] log_delivery_configuration
617
+ # Configuration for sending InfluxDB engine logs to send to specified
618
+ # S3 bucket.
619
+ # @return [Types::LogDeliveryConfiguration]
620
+ #
621
+ # @!attribute [rw] influx_auth_parameters_secret_arn
622
+ # The Amazon Resource Name (ARN) of the AWS Secrets Manager secret
623
+ # containing the initial InfluxDB authorization parameters. The secret
624
+ # value is a JSON formatted key-value pair holding InfluxDB
625
+ # authorization values: organization, bucket, username, and password.
626
+ # @return [String]
627
+ #
628
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbInstanceOutput AWS API Documentation
629
+ #
630
+ class GetDbInstanceOutput < Struct.new(
631
+ :id,
632
+ :name,
633
+ :arn,
634
+ :status,
635
+ :endpoint,
636
+ :db_instance_type,
637
+ :db_storage_type,
638
+ :allocated_storage,
639
+ :deployment_type,
640
+ :vpc_subnet_ids,
641
+ :publicly_accessible,
642
+ :vpc_security_group_ids,
643
+ :db_parameter_group_identifier,
644
+ :availability_zone,
645
+ :secondary_availability_zone,
646
+ :log_delivery_configuration,
647
+ :influx_auth_parameters_secret_arn)
648
+ SENSITIVE = []
649
+ include Aws::Structure
650
+ end
651
+
652
+ # @!attribute [rw] identifier
653
+ # The id of the DB parameter group.
654
+ # @return [String]
655
+ #
656
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbParameterGroupInput AWS API Documentation
657
+ #
658
+ class GetDbParameterGroupInput < Struct.new(
659
+ :identifier)
660
+ SENSITIVE = []
661
+ include Aws::Structure
662
+ end
663
+
664
+ # @!attribute [rw] id
665
+ # A service-generated unique identifier.
666
+ # @return [String]
667
+ #
668
+ # @!attribute [rw] name
669
+ # The customer-supplied name that uniquely identifies the DB parameter
670
+ # group when interacting with the Amazon Timestream for InfluxDB API
671
+ # and CLI commands.
672
+ # @return [String]
673
+ #
674
+ # @!attribute [rw] arn
675
+ # The Amazon Resource Name (ARN) of the DB parameter group.
676
+ # @return [String]
677
+ #
678
+ # @!attribute [rw] description
679
+ # A description of the DB parameter group.
680
+ # @return [String]
681
+ #
682
+ # @!attribute [rw] parameters
683
+ # The parameters that comprise the DB parameter group.
684
+ # @return [Types::Parameters]
685
+ #
686
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbParameterGroupOutput AWS API Documentation
687
+ #
688
+ class GetDbParameterGroupOutput < Struct.new(
689
+ :id,
690
+ :name,
691
+ :arn,
692
+ :description,
693
+ :parameters)
694
+ SENSITIVE = []
695
+ include Aws::Structure
696
+ end
697
+
698
+ # All the customer-modifiable InfluxDB v2 parameters in Timestream for
699
+ # InfluxDB.
700
+ #
701
+ # @!attribute [rw] flux_log_enabled
702
+ # Include option to show detailed logs for Flux queries.
703
+ #
704
+ # Default: false
705
+ # @return [Boolean]
706
+ #
707
+ # @!attribute [rw] log_level
708
+ # Log output level. InfluxDB outputs log entries with severity levels
709
+ # greater than or equal to the level specified.
710
+ #
711
+ # Default: info
712
+ # @return [String]
713
+ #
714
+ # @!attribute [rw] no_tasks
715
+ # Disable the task scheduler. If problematic tasks prevent InfluxDB
716
+ # from starting, use this option to start InfluxDB without scheduling
717
+ # or executing tasks.
718
+ #
719
+ # Default: false
720
+ # @return [Boolean]
721
+ #
722
+ # @!attribute [rw] query_concurrency
723
+ # Number of queries allowed to execute concurrently. Setting to 0
724
+ # allows an unlimited number of concurrent queries.
725
+ #
726
+ # Default: 0
727
+ # @return [Integer]
728
+ #
729
+ # @!attribute [rw] query_queue_size
730
+ # Maximum number of queries allowed in execution queue. When queue
731
+ # limit is reached, new queries are rejected. Setting to 0 allows an
732
+ # unlimited number of queries in the queue.
733
+ #
734
+ # Default: 0
735
+ # @return [Integer]
736
+ #
737
+ # @!attribute [rw] tracing_type
738
+ # Enable tracing in InfluxDB and specifies the tracing type. Tracing
739
+ # is disabled by default.
740
+ # @return [String]
741
+ #
742
+ # @!attribute [rw] metrics_disabled
743
+ # Disable the HTTP /metrics endpoint which exposes [internal InfluxDB
744
+ # metrics][1].
745
+ #
746
+ # Default: false
747
+ #
748
+ #
749
+ #
750
+ # [1]: https://docs.influxdata.com/influxdb/v2/reference/internals/metrics/
751
+ # @return [Boolean]
752
+ #
753
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/InfluxDBv2Parameters AWS API Documentation
754
+ #
755
+ class InfluxDBv2Parameters < Struct.new(
756
+ :flux_log_enabled,
757
+ :log_level,
758
+ :no_tasks,
759
+ :query_concurrency,
760
+ :query_queue_size,
761
+ :tracing_type,
762
+ :metrics_disabled)
763
+ SENSITIVE = []
764
+ include Aws::Structure
765
+ end
766
+
767
+ # The request processing has failed because of an unknown error,
768
+ # exception or failure.
769
+ #
770
+ # @!attribute [rw] message
771
+ # @return [String]
772
+ #
773
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/InternalServerException AWS API Documentation
774
+ #
775
+ class InternalServerException < Struct.new(
776
+ :message)
777
+ SENSITIVE = []
778
+ include Aws::Structure
779
+ end
780
+
781
+ # @!attribute [rw] next_token
782
+ # The pagination token. To resume pagination, provide the NextToken
783
+ # value as argument of a subsequent API invocation.
784
+ # @return [String]
785
+ #
786
+ # @!attribute [rw] max_results
787
+ # The maximum number of items to return in the output. If the total
788
+ # number of items available is more than the value specified, a
789
+ # NextToken is provided in the output. To resume pagination, provide
790
+ # the NextToken value as argument of a subsequent API invocation.
791
+ # @return [Integer]
792
+ #
793
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbInstancesInput AWS API Documentation
794
+ #
795
+ class ListDbInstancesInput < Struct.new(
796
+ :next_token,
797
+ :max_results)
798
+ SENSITIVE = []
799
+ include Aws::Structure
800
+ end
801
+
802
+ # @!attribute [rw] items
803
+ # A list of Timestream for InfluxDB DB instance summaries.
804
+ # @return [Array<Types::DbInstanceSummary>]
805
+ #
806
+ # @!attribute [rw] next_token
807
+ # Token from a previous call of the operation. When this value is
808
+ # provided, the service returns results from where the previous
809
+ # response left off.
810
+ # @return [String]
811
+ #
812
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbInstancesOutput AWS API Documentation
813
+ #
814
+ class ListDbInstancesOutput < Struct.new(
815
+ :items,
816
+ :next_token)
817
+ SENSITIVE = []
818
+ include Aws::Structure
819
+ end
820
+
821
+ # @!attribute [rw] next_token
822
+ # The pagination token. To resume pagination, provide the NextToken
823
+ # value as argument of a subsequent API invocation.
824
+ # @return [String]
825
+ #
826
+ # @!attribute [rw] max_results
827
+ # The maximum number of items to return in the output. If the total
828
+ # number of items available is more than the value specified, a
829
+ # NextToken is provided in the output. To resume pagination, provide
830
+ # the NextToken value as argument of a subsequent API invocation.
831
+ # @return [Integer]
832
+ #
833
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbParameterGroupsInput AWS API Documentation
834
+ #
835
+ class ListDbParameterGroupsInput < Struct.new(
836
+ :next_token,
837
+ :max_results)
838
+ SENSITIVE = []
839
+ include Aws::Structure
840
+ end
841
+
842
+ # @!attribute [rw] items
843
+ # A list of Timestream for InfluxDB DB parameter group summaries.
844
+ # @return [Array<Types::DbParameterGroupSummary>]
845
+ #
846
+ # @!attribute [rw] next_token
847
+ # Token from a previous call of the operation. When this value is
848
+ # provided, the service returns results from where the previous
849
+ # response left off.
850
+ # @return [String]
851
+ #
852
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbParameterGroupsOutput AWS API Documentation
853
+ #
854
+ class ListDbParameterGroupsOutput < Struct.new(
855
+ :items,
856
+ :next_token)
857
+ SENSITIVE = []
858
+ include Aws::Structure
859
+ end
860
+
861
+ # @!attribute [rw] resource_arn
862
+ # The Amazon Resource Name (ARN) of the tagged resource.
863
+ # @return [String]
864
+ #
865
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListTagsForResourceRequest AWS API Documentation
866
+ #
867
+ class ListTagsForResourceRequest < Struct.new(
868
+ :resource_arn)
869
+ SENSITIVE = []
870
+ include Aws::Structure
871
+ end
872
+
873
+ # @!attribute [rw] tags
874
+ # A list of tags used to categorize and track resources.
875
+ # @return [Hash<String,String>]
876
+ #
877
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListTagsForResourceResponse AWS API Documentation
878
+ #
879
+ class ListTagsForResourceResponse < Struct.new(
880
+ :tags)
881
+ SENSITIVE = []
882
+ include Aws::Structure
883
+ end
884
+
885
+ # Configuration for sending InfluxDB engine logs to send to specified S3
886
+ # bucket.
887
+ #
888
+ # @!attribute [rw] s3_configuration
889
+ # Configuration for S3 bucket log delivery.
890
+ # @return [Types::S3Configuration]
891
+ #
892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/LogDeliveryConfiguration AWS API Documentation
893
+ #
894
+ class LogDeliveryConfiguration < Struct.new(
895
+ :s3_configuration)
896
+ SENSITIVE = []
897
+ include Aws::Structure
898
+ end
899
+
900
+ # The parameters that comprise the parameter group.
901
+ #
902
+ # @note Parameters is a union - when making an API calls you must set exactly one of the members.
903
+ #
904
+ # @note Parameters is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Parameters corresponding to the set member.
905
+ #
906
+ # @!attribute [rw] influx_d_bv_2
907
+ # All the customer-modifiable InfluxDB v2 parameters in Timestream for
908
+ # InfluxDB.
909
+ # @return [Types::InfluxDBv2Parameters]
910
+ #
911
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/Parameters AWS API Documentation
912
+ #
913
+ class Parameters < Struct.new(
914
+ :influx_d_bv_2,
915
+ :unknown)
916
+ SENSITIVE = []
917
+ include Aws::Structure
918
+ include Aws::Structure::Union
919
+
920
+ class InfluxDBv2 < Parameters; end
921
+ class Unknown < Parameters; end
922
+ end
923
+
924
+ # The requested resource was not found or does not exist.
925
+ #
926
+ # @!attribute [rw] message
927
+ # @return [String]
928
+ #
929
+ # @!attribute [rw] resource_id
930
+ # The identifier for the Timestream for InfluxDB resource associated
931
+ # with the request.
932
+ # @return [String]
933
+ #
934
+ # @!attribute [rw] resource_type
935
+ # The type of Timestream for InfluxDB resource associated with the
936
+ # request.
937
+ # @return [String]
938
+ #
939
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ResourceNotFoundException AWS API Documentation
940
+ #
941
+ class ResourceNotFoundException < Struct.new(
942
+ :message,
943
+ :resource_id,
944
+ :resource_type)
945
+ SENSITIVE = []
946
+ include Aws::Structure
947
+ end
948
+
949
+ # Configuration for S3 bucket log delivery.
950
+ #
951
+ # @!attribute [rw] bucket_name
952
+ # The name of the S3 bucket to deliver logs to.
953
+ # @return [String]
954
+ #
955
+ # @!attribute [rw] enabled
956
+ # Indicates whether log delivery to the S3 bucket is enabled.
957
+ # @return [Boolean]
958
+ #
959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/S3Configuration AWS API Documentation
960
+ #
961
+ class S3Configuration < Struct.new(
962
+ :bucket_name,
963
+ :enabled)
964
+ SENSITIVE = []
965
+ include Aws::Structure
966
+ end
967
+
968
+ # The request exceeds the service quota.
969
+ #
970
+ # @!attribute [rw] message
971
+ # @return [String]
972
+ #
973
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ServiceQuotaExceededException AWS API Documentation
974
+ #
975
+ class ServiceQuotaExceededException < Struct.new(
976
+ :message)
977
+ SENSITIVE = []
978
+ include Aws::Structure
979
+ end
980
+
981
+ # @!attribute [rw] resource_arn
982
+ # The Amazon Resource Name (ARN) of the tagged resource.
983
+ # @return [String]
984
+ #
985
+ # @!attribute [rw] tags
986
+ # A list of tags used to categorize and track resources.
987
+ # @return [Hash<String,String>]
988
+ #
989
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/TagResourceRequest AWS API Documentation
990
+ #
991
+ class TagResourceRequest < Struct.new(
992
+ :resource_arn,
993
+ :tags)
994
+ SENSITIVE = []
995
+ include Aws::Structure
996
+ end
997
+
998
+ # The request was denied due to request throttling.
999
+ #
1000
+ # @!attribute [rw] message
1001
+ # @return [String]
1002
+ #
1003
+ # @!attribute [rw] retry_after_seconds
1004
+ # The number of seconds the caller should wait before retrying.
1005
+ # @return [Integer]
1006
+ #
1007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ThrottlingException AWS API Documentation
1008
+ #
1009
+ class ThrottlingException < Struct.new(
1010
+ :message,
1011
+ :retry_after_seconds)
1012
+ SENSITIVE = []
1013
+ include Aws::Structure
1014
+ end
1015
+
1016
+ # @!attribute [rw] resource_arn
1017
+ # The Amazon Resource Name (ARN) of the tagged resource.
1018
+ # @return [String]
1019
+ #
1020
+ # @!attribute [rw] tag_keys
1021
+ # The keys used to identify the tags.
1022
+ # @return [Array<String>]
1023
+ #
1024
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/UntagResourceRequest AWS API Documentation
1025
+ #
1026
+ class UntagResourceRequest < Struct.new(
1027
+ :resource_arn,
1028
+ :tag_keys)
1029
+ SENSITIVE = []
1030
+ include Aws::Structure
1031
+ end
1032
+
1033
+ # @!attribute [rw] identifier
1034
+ # The id of the DB instance.
1035
+ # @return [String]
1036
+ #
1037
+ # @!attribute [rw] log_delivery_configuration
1038
+ # Configuration for sending InfluxDB engine logs to send to specified
1039
+ # S3 bucket.
1040
+ # @return [Types::LogDeliveryConfiguration]
1041
+ #
1042
+ # @!attribute [rw] db_parameter_group_identifier
1043
+ # The id of the DB parameter group to assign to your DB instance. DB
1044
+ # parameter groups specify how the database is configured. For
1045
+ # example, DB parameter groups can specify the limit for query
1046
+ # concurrency.
1047
+ # @return [String]
1048
+ #
1049
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/UpdateDbInstanceInput AWS API Documentation
1050
+ #
1051
+ class UpdateDbInstanceInput < Struct.new(
1052
+ :identifier,
1053
+ :log_delivery_configuration,
1054
+ :db_parameter_group_identifier)
1055
+ SENSITIVE = []
1056
+ include Aws::Structure
1057
+ end
1058
+
1059
+ # @!attribute [rw] id
1060
+ # A service-generated unique identifier.
1061
+ # @return [String]
1062
+ #
1063
+ # @!attribute [rw] name
1064
+ # This customer-supplied name uniquely identifies the DB instance when
1065
+ # interacting with the Amazon Timestream for InfluxDB API and AWS CLI
1066
+ # commands.
1067
+ # @return [String]
1068
+ #
1069
+ # @!attribute [rw] arn
1070
+ # The Amazon Resource Name (ARN) of the DB instance.
1071
+ # @return [String]
1072
+ #
1073
+ # @!attribute [rw] status
1074
+ # The status of the DB instance.
1075
+ # @return [String]
1076
+ #
1077
+ # @!attribute [rw] endpoint
1078
+ # The endpoint used to connect to InfluxDB. The default InfluxDB port
1079
+ # is 8086.
1080
+ # @return [String]
1081
+ #
1082
+ # @!attribute [rw] db_instance_type
1083
+ # The Timestream for InfluxDB instance type that InfluxDB runs on.
1084
+ # @return [String]
1085
+ #
1086
+ # @!attribute [rw] db_storage_type
1087
+ # The Timestream for InfluxDB DB storage type that InfluxDB stores
1088
+ # data on.
1089
+ # @return [String]
1090
+ #
1091
+ # @!attribute [rw] allocated_storage
1092
+ # The amount of storage allocated for your DB storage type (in
1093
+ # gibibytes).
1094
+ # @return [Integer]
1095
+ #
1096
+ # @!attribute [rw] deployment_type
1097
+ # Specifies whether the Timestream for InfluxDB is deployed as
1098
+ # Single-AZ or with a MultiAZ Standby for High availability.
1099
+ # @return [String]
1100
+ #
1101
+ # @!attribute [rw] vpc_subnet_ids
1102
+ # A list of VPC subnet IDs associated with the DB instance.
1103
+ # @return [Array<String>]
1104
+ #
1105
+ # @!attribute [rw] publicly_accessible
1106
+ # Indicates if the DB instance has a public IP to facilitate access.
1107
+ # @return [Boolean]
1108
+ #
1109
+ # @!attribute [rw] vpc_security_group_ids
1110
+ # A list of VPC security group IDs associated with the DB instance.
1111
+ # @return [Array<String>]
1112
+ #
1113
+ # @!attribute [rw] db_parameter_group_identifier
1114
+ # The id of the DB parameter group assigned to your DB instance.
1115
+ # @return [String]
1116
+ #
1117
+ # @!attribute [rw] availability_zone
1118
+ # The Availability Zone in which the DB instance resides.
1119
+ # @return [String]
1120
+ #
1121
+ # @!attribute [rw] secondary_availability_zone
1122
+ # The Availability Zone in which the standby instance is located when
1123
+ # deploying with a MultiAZ standby instance.
1124
+ # @return [String]
1125
+ #
1126
+ # @!attribute [rw] log_delivery_configuration
1127
+ # Configuration for sending InfluxDB engine logs to send to specified
1128
+ # S3 bucket.
1129
+ # @return [Types::LogDeliveryConfiguration]
1130
+ #
1131
+ # @!attribute [rw] influx_auth_parameters_secret_arn
1132
+ # The Amazon Resource Name (ARN) of the AWS Secrets Manager secret
1133
+ # containing the initial InfluxDB authorization parameters. The secret
1134
+ # value is a JSON formatted key-value pair holding InfluxDB
1135
+ # authorization values: organization, bucket, username, and password.
1136
+ # @return [String]
1137
+ #
1138
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/UpdateDbInstanceOutput AWS API Documentation
1139
+ #
1140
+ class UpdateDbInstanceOutput < Struct.new(
1141
+ :id,
1142
+ :name,
1143
+ :arn,
1144
+ :status,
1145
+ :endpoint,
1146
+ :db_instance_type,
1147
+ :db_storage_type,
1148
+ :allocated_storage,
1149
+ :deployment_type,
1150
+ :vpc_subnet_ids,
1151
+ :publicly_accessible,
1152
+ :vpc_security_group_ids,
1153
+ :db_parameter_group_identifier,
1154
+ :availability_zone,
1155
+ :secondary_availability_zone,
1156
+ :log_delivery_configuration,
1157
+ :influx_auth_parameters_secret_arn)
1158
+ SENSITIVE = []
1159
+ include Aws::Structure
1160
+ end
1161
+
1162
+ # The input fails to satisfy the constraints specified by Timestream for
1163
+ # InfluxDB.
1164
+ #
1165
+ # @!attribute [rw] message
1166
+ # @return [String]
1167
+ #
1168
+ # @!attribute [rw] reason
1169
+ # The reason that validation failed.
1170
+ # @return [String]
1171
+ #
1172
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ValidationException AWS API Documentation
1173
+ #
1174
+ class ValidationException < Struct.new(
1175
+ :message,
1176
+ :reason)
1177
+ SENSITIVE = []
1178
+ include Aws::Structure
1179
+ end
1180
+
1181
+ end
1182
+ end