aws-sdk-timestreaminfluxdb 1.19.0 → 1.20.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -49,6 +49,167 @@ module Aws::TimestreamInfluxDB
49
49
  include Aws::Structure
50
50
  end
51
51
 
52
+ # @!attribute [rw] name
53
+ # The name that uniquely identifies the DB cluster 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 cluster
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 Web
66
+ # Services 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 Amazon Web Services Secrets Manager 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] port
91
+ # The port number on which InfluxDB accepts connections.
92
+ #
93
+ # Valid Values: 1024-65535
94
+ #
95
+ # Default: 8086
96
+ #
97
+ # Constraints: The value can't be 2375-2376, 7788-7799, 8090, or
98
+ # 51678-51680
99
+ # @return [Integer]
100
+ #
101
+ # @!attribute [rw] db_parameter_group_identifier
102
+ # The ID of the DB parameter group to assign to your DB cluster. DB
103
+ # parameter groups specify how the database is configured. For
104
+ # example, DB parameter groups can specify the limit for query
105
+ # concurrency.
106
+ # @return [String]
107
+ #
108
+ # @!attribute [rw] db_instance_type
109
+ # The Timestream for InfluxDB DB instance type to run InfluxDB on.
110
+ # @return [String]
111
+ #
112
+ # @!attribute [rw] db_storage_type
113
+ # The Timestream for InfluxDB DB storage type to read and write
114
+ # InfluxDB data.
115
+ #
116
+ # You can choose between three different types of provisioned Influx
117
+ # IOPS Included storage according to your workload requirements:
118
+ #
119
+ # * Influx I/O Included 3000 IOPS
120
+ #
121
+ # * Influx I/O Included 12000 IOPS
122
+ #
123
+ # * Influx I/O Included 16000 IOPS
124
+ # @return [String]
125
+ #
126
+ # @!attribute [rw] allocated_storage
127
+ # The amount of storage to allocate for your DB storage type in GiB
128
+ # (gibibytes).
129
+ # @return [Integer]
130
+ #
131
+ # @!attribute [rw] network_type
132
+ # Specifies whether the network type of the Timestream for InfluxDB
133
+ # cluster is IPv4, which can communicate over IPv4 protocol only, or
134
+ # DUAL, which can communicate over both IPv4 and IPv6 protocols.
135
+ # @return [String]
136
+ #
137
+ # @!attribute [rw] publicly_accessible
138
+ # Configures the Timestream for InfluxDB cluster with a public IP to
139
+ # facilitate access from outside the VPC.
140
+ # @return [Boolean]
141
+ #
142
+ # @!attribute [rw] vpc_subnet_ids
143
+ # A list of VPC subnet IDs to associate with the DB cluster. Provide
144
+ # at least two VPC subnet IDs in different Availability Zones when
145
+ # deploying with a Multi-AZ standby.
146
+ # @return [Array<String>]
147
+ #
148
+ # @!attribute [rw] vpc_security_group_ids
149
+ # A list of VPC security group IDs to associate with the Timestream
150
+ # for InfluxDB cluster.
151
+ # @return [Array<String>]
152
+ #
153
+ # @!attribute [rw] deployment_type
154
+ # Specifies the type of cluster to create.
155
+ # @return [String]
156
+ #
157
+ # @!attribute [rw] failover_mode
158
+ # Specifies the behavior of failure recovery when the primary node of
159
+ # the cluster fails.
160
+ # @return [String]
161
+ #
162
+ # @!attribute [rw] log_delivery_configuration
163
+ # Configuration for sending InfluxDB engine logs to a specified S3
164
+ # bucket.
165
+ # @return [Types::LogDeliveryConfiguration]
166
+ #
167
+ # @!attribute [rw] tags
168
+ # A list of key-value pairs to associate with the DB instance.
169
+ # @return [Hash<String,String>]
170
+ #
171
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/CreateDbClusterInput AWS API Documentation
172
+ #
173
+ class CreateDbClusterInput < Struct.new(
174
+ :name,
175
+ :username,
176
+ :password,
177
+ :organization,
178
+ :bucket,
179
+ :port,
180
+ :db_parameter_group_identifier,
181
+ :db_instance_type,
182
+ :db_storage_type,
183
+ :allocated_storage,
184
+ :network_type,
185
+ :publicly_accessible,
186
+ :vpc_subnet_ids,
187
+ :vpc_security_group_ids,
188
+ :deployment_type,
189
+ :failover_mode,
190
+ :log_delivery_configuration,
191
+ :tags)
192
+ SENSITIVE = [:username, :password]
193
+ include Aws::Structure
194
+ end
195
+
196
+ # @!attribute [rw] db_cluster_id
197
+ # A service-generated unique identifier.
198
+ # @return [String]
199
+ #
200
+ # @!attribute [rw] db_cluster_status
201
+ # The status of the DB cluster.
202
+ # @return [String]
203
+ #
204
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/CreateDbClusterOutput AWS API Documentation
205
+ #
206
+ class CreateDbClusterOutput < Struct.new(
207
+ :db_cluster_id,
208
+ :db_cluster_status)
209
+ SENSITIVE = []
210
+ include Aws::Structure
211
+ end
212
+
52
213
  # @!attribute [rw] name
53
214
  # The name that uniquely identifies the DB instance when interacting
54
215
  # with the Amazon Timestream for InfluxDB API and CLI commands. This
@@ -277,6 +438,14 @@ module Aws::TimestreamInfluxDB
277
438
  # username, and password.
278
439
  # @return [String]
279
440
  #
441
+ # @!attribute [rw] db_cluster_id
442
+ # Specifies the DbCluster to which this DbInstance belongs to.
443
+ # @return [String]
444
+ #
445
+ # @!attribute [rw] instance_mode
446
+ # Specifies the DbInstance's role in the cluster.
447
+ # @return [String]
448
+ #
280
449
  # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/CreateDbInstanceOutput AWS API Documentation
281
450
  #
282
451
  class CreateDbInstanceOutput < Struct.new(
@@ -298,7 +467,9 @@ module Aws::TimestreamInfluxDB
298
467
  :availability_zone,
299
468
  :secondary_availability_zone,
300
469
  :log_delivery_configuration,
301
- :influx_auth_parameters_secret_arn)
470
+ :influx_auth_parameters_secret_arn,
471
+ :db_cluster_id,
472
+ :instance_mode)
302
473
  SENSITIVE = []
303
474
  include Aws::Structure
304
475
  end
@@ -365,6 +536,155 @@ module Aws::TimestreamInfluxDB
365
536
  include Aws::Structure
366
537
  end
367
538
 
539
+ # Describes a summary of a Timestream for InfluxDB cluster.
540
+ #
541
+ # @!attribute [rw] id
542
+ # Service-generated unique identifier of the DB cluster to retrieve.
543
+ # @return [String]
544
+ #
545
+ # @!attribute [rw] name
546
+ # Customer supplied name of the Timestream for InfluxDB cluster.
547
+ # @return [String]
548
+ #
549
+ # @!attribute [rw] arn
550
+ # The Amazon Resource Name (ARN) of the DB cluster.
551
+ # @return [String]
552
+ #
553
+ # @!attribute [rw] status
554
+ # The status of the DB cluster.
555
+ # @return [String]
556
+ #
557
+ # @!attribute [rw] endpoint
558
+ # The endpoint used to connect to the Timestream for InfluxDB cluster
559
+ # for write and read operations.
560
+ # @return [String]
561
+ #
562
+ # @!attribute [rw] reader_endpoint
563
+ # The endpoint used to connect to the Timestream for InfluxDB cluster
564
+ # for read-only operations.
565
+ # @return [String]
566
+ #
567
+ # @!attribute [rw] port
568
+ # The port number on which InfluxDB accepts connections.
569
+ # @return [Integer]
570
+ #
571
+ # @!attribute [rw] deployment_type
572
+ # Deployment type of the DB cluster
573
+ # @return [String]
574
+ #
575
+ # @!attribute [rw] db_instance_type
576
+ # The Timestream for InfluxDB DB instance type that InfluxDB runs on.
577
+ # @return [String]
578
+ #
579
+ # @!attribute [rw] network_type
580
+ # Specifies whether the network type of the Timestream for InfluxDB
581
+ # Cluster is IPv4, which can communicate over IPv4 protocol only, or
582
+ # DUAL, which can communicate over both IPv4 and IPv6 protocols.
583
+ # @return [String]
584
+ #
585
+ # @!attribute [rw] db_storage_type
586
+ # The Timestream for InfluxDB DB storage type that InfluxDB stores
587
+ # data on.
588
+ # @return [String]
589
+ #
590
+ # @!attribute [rw] allocated_storage
591
+ # The amount of storage allocated for your DB storage type (in
592
+ # gibibytes).
593
+ # @return [Integer]
594
+ #
595
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/DbClusterSummary AWS API Documentation
596
+ #
597
+ class DbClusterSummary < Struct.new(
598
+ :id,
599
+ :name,
600
+ :arn,
601
+ :status,
602
+ :endpoint,
603
+ :reader_endpoint,
604
+ :port,
605
+ :deployment_type,
606
+ :db_instance_type,
607
+ :network_type,
608
+ :db_storage_type,
609
+ :allocated_storage)
610
+ SENSITIVE = []
611
+ include Aws::Structure
612
+ end
613
+
614
+ # Contains a summary of a DB instance belonging to a DB cluster.
615
+ #
616
+ # @!attribute [rw] id
617
+ # The service-generated unique identifier of the DB instance.
618
+ # @return [String]
619
+ #
620
+ # @!attribute [rw] name
621
+ # A service-generated name for the DB instance based on the
622
+ # customer-supplied name for the DB cluster.
623
+ # @return [String]
624
+ #
625
+ # @!attribute [rw] arn
626
+ # The Amazon Resource Name (ARN) of the DB instance.
627
+ # @return [String]
628
+ #
629
+ # @!attribute [rw] status
630
+ # The status of the DB instance.
631
+ # @return [String]
632
+ #
633
+ # @!attribute [rw] endpoint
634
+ # The endpoint used to connect to InfluxDB. The default InfluxDB port
635
+ # is 8086.
636
+ # @return [String]
637
+ #
638
+ # @!attribute [rw] port
639
+ # The port number on which InfluxDB accepts connections.
640
+ # @return [Integer]
641
+ #
642
+ # @!attribute [rw] network_type
643
+ # Specifies whether the network type of the Timestream for InfluxDB
644
+ # instance is IPv4, which can communicate over IPv4 protocol only, or
645
+ # DUAL, which can communicate over both IPv4 and IPv6 protocols.
646
+ # @return [String]
647
+ #
648
+ # @!attribute [rw] db_instance_type
649
+ # The Timestream for InfluxDB instance type to run InfluxDB on.
650
+ # @return [String]
651
+ #
652
+ # @!attribute [rw] db_storage_type
653
+ # The storage type for your DB instance.
654
+ # @return [String]
655
+ #
656
+ # @!attribute [rw] allocated_storage
657
+ # The amount of storage allocated for your DB storage type in GiB
658
+ # (gibibytes).
659
+ # @return [Integer]
660
+ #
661
+ # @!attribute [rw] deployment_type
662
+ # Specifies the deployment type if applicable.
663
+ # @return [String]
664
+ #
665
+ # @!attribute [rw] instance_mode
666
+ # Specifies the DB instance's role in the cluster.
667
+ # @return [String]
668
+ #
669
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/DbInstanceForClusterSummary AWS API Documentation
670
+ #
671
+ class DbInstanceForClusterSummary < Struct.new(
672
+ :id,
673
+ :name,
674
+ :arn,
675
+ :status,
676
+ :endpoint,
677
+ :port,
678
+ :network_type,
679
+ :db_instance_type,
680
+ :db_storage_type,
681
+ :allocated_storage,
682
+ :deployment_type,
683
+ :instance_mode)
684
+ SENSITIVE = []
685
+ include Aws::Structure
686
+ end
687
+
368
688
  # Contains a summary of a DB instance.
369
689
  #
370
690
  # @!attribute [rw] id
@@ -464,6 +784,30 @@ module Aws::TimestreamInfluxDB
464
784
  include Aws::Structure
465
785
  end
466
786
 
787
+ # @!attribute [rw] db_cluster_id
788
+ # Service-generated unique identifier of the DB cluster.
789
+ # @return [String]
790
+ #
791
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/DeleteDbClusterInput AWS API Documentation
792
+ #
793
+ class DeleteDbClusterInput < Struct.new(
794
+ :db_cluster_id)
795
+ SENSITIVE = []
796
+ include Aws::Structure
797
+ end
798
+
799
+ # @!attribute [rw] db_cluster_status
800
+ # The status of the DB cluster.
801
+ # @return [String]
802
+ #
803
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/DeleteDbClusterOutput AWS API Documentation
804
+ #
805
+ class DeleteDbClusterOutput < Struct.new(
806
+ :db_cluster_status)
807
+ SENSITIVE = []
808
+ include Aws::Structure
809
+ end
810
+
467
811
  # @!attribute [rw] identifier
468
812
  # The id of the DB instance.
469
813
  # @return [String]
@@ -566,6 +910,14 @@ module Aws::TimestreamInfluxDB
566
910
  # username, and password.
567
911
  # @return [String]
568
912
  #
913
+ # @!attribute [rw] db_cluster_id
914
+ # Specifies the DbCluster to which this DbInstance belongs to.
915
+ # @return [String]
916
+ #
917
+ # @!attribute [rw] instance_mode
918
+ # Specifies the DbInstance's role in the cluster.
919
+ # @return [String]
920
+ #
569
921
  # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/DeleteDbInstanceOutput AWS API Documentation
570
922
  #
571
923
  class DeleteDbInstanceOutput < Struct.new(
@@ -587,7 +939,9 @@ module Aws::TimestreamInfluxDB
587
939
  :availability_zone,
588
940
  :secondary_availability_zone,
589
941
  :log_delivery_configuration,
590
- :influx_auth_parameters_secret_arn)
942
+ :influx_auth_parameters_secret_arn,
943
+ :db_cluster_id,
944
+ :instance_mode)
591
945
  SENSITIVE = []
592
946
  include Aws::Structure
593
947
  end
@@ -611,6 +965,132 @@ module Aws::TimestreamInfluxDB
611
965
  include Aws::Structure
612
966
  end
613
967
 
968
+ # @!attribute [rw] db_cluster_id
969
+ # Service-generated unique identifier of the DB cluster to retrieve.
970
+ # @return [String]
971
+ #
972
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbClusterInput AWS API Documentation
973
+ #
974
+ class GetDbClusterInput < Struct.new(
975
+ :db_cluster_id)
976
+ SENSITIVE = []
977
+ include Aws::Structure
978
+ end
979
+
980
+ # @!attribute [rw] id
981
+ # Service-generated unique identifier of the DB cluster to retrieve.
982
+ # @return [String]
983
+ #
984
+ # @!attribute [rw] name
985
+ # Customer-supplied name of the Timestream for InfluxDB cluster.
986
+ # @return [String]
987
+ #
988
+ # @!attribute [rw] arn
989
+ # The Amazon Resource Name (ARN) of the DB cluster.
990
+ # @return [String]
991
+ #
992
+ # @!attribute [rw] status
993
+ # The status of the DB cluster.
994
+ # @return [String]
995
+ #
996
+ # @!attribute [rw] endpoint
997
+ # The endpoint used to connect to the Timestream for InfluxDB cluster
998
+ # for write and read operations.
999
+ # @return [String]
1000
+ #
1001
+ # @!attribute [rw] reader_endpoint
1002
+ # The endpoint used to connect to the Timestream for InfluxDB cluster
1003
+ # for read-only operations.
1004
+ # @return [String]
1005
+ #
1006
+ # @!attribute [rw] port
1007
+ # The port number on which InfluxDB accepts connections.
1008
+ # @return [Integer]
1009
+ #
1010
+ # @!attribute [rw] deployment_type
1011
+ # Deployment type of the DB cluster.
1012
+ # @return [String]
1013
+ #
1014
+ # @!attribute [rw] db_instance_type
1015
+ # The Timestream for InfluxDB instance type that InfluxDB runs on.
1016
+ # @return [String]
1017
+ #
1018
+ # @!attribute [rw] network_type
1019
+ # Specifies whether the network type of the Timestream for InfluxDB
1020
+ # cluster is IPv4, which can communicate over IPv4 protocol only, or
1021
+ # DUAL, which can communicate over both IPv4 and IPv6 protocols.
1022
+ # @return [String]
1023
+ #
1024
+ # @!attribute [rw] db_storage_type
1025
+ # The Timestream for InfluxDB DB storage type that InfluxDB stores
1026
+ # data on.
1027
+ # @return [String]
1028
+ #
1029
+ # @!attribute [rw] allocated_storage
1030
+ # The amount of storage allocated for your DB storage type (in
1031
+ # gibibytes).
1032
+ # @return [Integer]
1033
+ #
1034
+ # @!attribute [rw] publicly_accessible
1035
+ # Indicates if the DB cluster has a public IP to facilitate access
1036
+ # from outside the VPC.
1037
+ # @return [Boolean]
1038
+ #
1039
+ # @!attribute [rw] db_parameter_group_identifier
1040
+ # The ID of the DB parameter group assigned to your DB cluster.
1041
+ # @return [String]
1042
+ #
1043
+ # @!attribute [rw] log_delivery_configuration
1044
+ # Configuration for sending InfluxDB engine logs to send to specified
1045
+ # S3 bucket.
1046
+ # @return [Types::LogDeliveryConfiguration]
1047
+ #
1048
+ # @!attribute [rw] influx_auth_parameters_secret_arn
1049
+ # The Amazon Resource Name (ARN) of the Amazon Web Services Secrets
1050
+ # Manager secret containing the initial InfluxDB authorization
1051
+ # parameters. The secret value is a JSON formatted key-value pair
1052
+ # holding InfluxDB authorization values: organization, bucket,
1053
+ # username, and password.
1054
+ # @return [String]
1055
+ #
1056
+ # @!attribute [rw] vpc_subnet_ids
1057
+ # A list of VPC subnet IDs associated with the DB cluster.
1058
+ # @return [Array<String>]
1059
+ #
1060
+ # @!attribute [rw] vpc_security_group_ids
1061
+ # A list of VPC security group IDs associated with the DB cluster.
1062
+ # @return [Array<String>]
1063
+ #
1064
+ # @!attribute [rw] failover_mode
1065
+ # The configured failover mode for the DB cluster.
1066
+ # @return [String]
1067
+ #
1068
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbClusterOutput AWS API Documentation
1069
+ #
1070
+ class GetDbClusterOutput < Struct.new(
1071
+ :id,
1072
+ :name,
1073
+ :arn,
1074
+ :status,
1075
+ :endpoint,
1076
+ :reader_endpoint,
1077
+ :port,
1078
+ :deployment_type,
1079
+ :db_instance_type,
1080
+ :network_type,
1081
+ :db_storage_type,
1082
+ :allocated_storage,
1083
+ :publicly_accessible,
1084
+ :db_parameter_group_identifier,
1085
+ :log_delivery_configuration,
1086
+ :influx_auth_parameters_secret_arn,
1087
+ :vpc_subnet_ids,
1088
+ :vpc_security_group_ids,
1089
+ :failover_mode)
1090
+ SENSITIVE = []
1091
+ include Aws::Structure
1092
+ end
1093
+
614
1094
  # @!attribute [rw] identifier
615
1095
  # The id of the DB instance.
616
1096
  # @return [String]
@@ -713,6 +1193,14 @@ module Aws::TimestreamInfluxDB
713
1193
  # username, and password.
714
1194
  # @return [String]
715
1195
  #
1196
+ # @!attribute [rw] db_cluster_id
1197
+ # Specifies the DbCluster to which this DbInstance belongs to.
1198
+ # @return [String]
1199
+ #
1200
+ # @!attribute [rw] instance_mode
1201
+ # Specifies the DbInstance's role in the cluster.
1202
+ # @return [String]
1203
+ #
716
1204
  # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbInstanceOutput AWS API Documentation
717
1205
  #
718
1206
  class GetDbInstanceOutput < Struct.new(
@@ -734,7 +1222,9 @@ module Aws::TimestreamInfluxDB
734
1222
  :availability_zone,
735
1223
  :secondary_availability_zone,
736
1224
  :log_delivery_configuration,
737
- :influx_auth_parameters_secret_arn)
1225
+ :influx_auth_parameters_secret_arn,
1226
+ :db_cluster_id,
1227
+ :instance_mode)
738
1228
  SENSITIVE = []
739
1229
  include Aws::Structure
740
1230
  end
@@ -1110,6 +1600,92 @@ module Aws::TimestreamInfluxDB
1110
1600
  include Aws::Structure
1111
1601
  end
1112
1602
 
1603
+ # @!attribute [rw] next_token
1604
+ # The pagination token. To resume pagination, provide the nextToken
1605
+ # value as an argument of a subsequent API invocation.
1606
+ # @return [String]
1607
+ #
1608
+ # @!attribute [rw] max_results
1609
+ # The maximum number of items to return in the output. If the total
1610
+ # number of items available is more than the value specified, a
1611
+ # nextToken is provided in the output. To resume pagination, provide
1612
+ # the nextToken value as an argument of a subsequent API invocation.
1613
+ # @return [Integer]
1614
+ #
1615
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbClustersInput AWS API Documentation
1616
+ #
1617
+ class ListDbClustersInput < Struct.new(
1618
+ :next_token,
1619
+ :max_results)
1620
+ SENSITIVE = []
1621
+ include Aws::Structure
1622
+ end
1623
+
1624
+ # @!attribute [rw] items
1625
+ # A list of Timestream for InfluxDB cluster summaries.
1626
+ # @return [Array<Types::DbClusterSummary>]
1627
+ #
1628
+ # @!attribute [rw] next_token
1629
+ # Token from a previous call of the operation. When this value is
1630
+ # provided, the service returns results from where the previous
1631
+ # response left off.
1632
+ # @return [String]
1633
+ #
1634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbClustersOutput AWS API Documentation
1635
+ #
1636
+ class ListDbClustersOutput < Struct.new(
1637
+ :items,
1638
+ :next_token)
1639
+ SENSITIVE = []
1640
+ include Aws::Structure
1641
+ end
1642
+
1643
+ # @!attribute [rw] db_cluster_id
1644
+ # Service-generated unique identifier of the DB cluster.
1645
+ # @return [String]
1646
+ #
1647
+ # @!attribute [rw] next_token
1648
+ # The pagination token. To resume pagination, provide the nextToken
1649
+ # value as an argument of a subsequent API invocation.
1650
+ # @return [String]
1651
+ #
1652
+ # @!attribute [rw] max_results
1653
+ # The maximum number of items to return in the output. If the total
1654
+ # number of items available is more than the value specified, a
1655
+ # nextToken is provided in the output. To resume pagination, provide
1656
+ # the nextToken value as an argument of a subsequent API invocation.
1657
+ # @return [Integer]
1658
+ #
1659
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbInstancesForClusterInput AWS API Documentation
1660
+ #
1661
+ class ListDbInstancesForClusterInput < Struct.new(
1662
+ :db_cluster_id,
1663
+ :next_token,
1664
+ :max_results)
1665
+ SENSITIVE = []
1666
+ include Aws::Structure
1667
+ end
1668
+
1669
+ # @!attribute [rw] items
1670
+ # A list of Timestream for InfluxDB instance summaries belonging to
1671
+ # the cluster.
1672
+ # @return [Array<Types::DbInstanceForClusterSummary>]
1673
+ #
1674
+ # @!attribute [rw] next_token
1675
+ # Token from a previous call of the operation. When this value is
1676
+ # provided, the service returns results from where the previous
1677
+ # response left off.
1678
+ # @return [String]
1679
+ #
1680
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbInstancesForClusterOutput AWS API Documentation
1681
+ #
1682
+ class ListDbInstancesForClusterOutput < Struct.new(
1683
+ :items,
1684
+ :next_token)
1685
+ SENSITIVE = []
1686
+ include Aws::Structure
1687
+ end
1688
+
1113
1689
  # @!attribute [rw] next_token
1114
1690
  # The pagination token. To resume pagination, provide the NextToken
1115
1691
  # value as argument of a subsequent API invocation.
@@ -1362,6 +1938,55 @@ module Aws::TimestreamInfluxDB
1362
1938
  include Aws::Structure
1363
1939
  end
1364
1940
 
1941
+ # @!attribute [rw] db_cluster_id
1942
+ # Service-generated unique identifier of the DB cluster to update.
1943
+ # @return [String]
1944
+ #
1945
+ # @!attribute [rw] log_delivery_configuration
1946
+ # The log delivery configuration to apply to the DB cluster.
1947
+ # @return [Types::LogDeliveryConfiguration]
1948
+ #
1949
+ # @!attribute [rw] db_parameter_group_identifier
1950
+ # Update the DB cluster to use the specified DB parameter group.
1951
+ # @return [String]
1952
+ #
1953
+ # @!attribute [rw] port
1954
+ # Update the DB cluster to use the specified port.
1955
+ # @return [Integer]
1956
+ #
1957
+ # @!attribute [rw] db_instance_type
1958
+ # Update the DB cluster to use the specified DB instance Type.
1959
+ # @return [String]
1960
+ #
1961
+ # @!attribute [rw] failover_mode
1962
+ # Update the DB cluster's failover behavior.
1963
+ # @return [String]
1964
+ #
1965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/UpdateDbClusterInput AWS API Documentation
1966
+ #
1967
+ class UpdateDbClusterInput < Struct.new(
1968
+ :db_cluster_id,
1969
+ :log_delivery_configuration,
1970
+ :db_parameter_group_identifier,
1971
+ :port,
1972
+ :db_instance_type,
1973
+ :failover_mode)
1974
+ SENSITIVE = []
1975
+ include Aws::Structure
1976
+ end
1977
+
1978
+ # @!attribute [rw] db_cluster_status
1979
+ # The status of the DB cluster.
1980
+ # @return [String]
1981
+ #
1982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/UpdateDbClusterOutput AWS API Documentation
1983
+ #
1984
+ class UpdateDbClusterOutput < Struct.new(
1985
+ :db_cluster_status)
1986
+ SENSITIVE = []
1987
+ include Aws::Structure
1988
+ end
1989
+
1365
1990
  # @!attribute [rw] identifier
1366
1991
  # The id of the DB instance.
1367
1992
  # @return [String]
@@ -1515,6 +2140,14 @@ module Aws::TimestreamInfluxDB
1515
2140
  # username, and password.
1516
2141
  # @return [String]
1517
2142
  #
2143
+ # @!attribute [rw] db_cluster_id
2144
+ # Specifies the DbCluster to which this DbInstance belongs to.
2145
+ # @return [String]
2146
+ #
2147
+ # @!attribute [rw] instance_mode
2148
+ # Specifies the DbInstance's role in the cluster.
2149
+ # @return [String]
2150
+ #
1518
2151
  # @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/UpdateDbInstanceOutput AWS API Documentation
1519
2152
  #
1520
2153
  class UpdateDbInstanceOutput < Struct.new(
@@ -1536,7 +2169,9 @@ module Aws::TimestreamInfluxDB
1536
2169
  :availability_zone,
1537
2170
  :secondary_availability_zone,
1538
2171
  :log_delivery_configuration,
1539
- :influx_auth_parameters_secret_arn)
2172
+ :influx_auth_parameters_secret_arn,
2173
+ :db_cluster_id,
2174
+ :instance_mode)
1540
2175
  SENSITIVE = []
1541
2176
  include Aws::Structure
1542
2177
  end