aws-sdk-timestreaminfluxdb 1.19.0 → 1.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-timestreaminfluxdb/client.rb +452 -29
- data/lib/aws-sdk-timestreaminfluxdb/client_api.rb +238 -0
- data/lib/aws-sdk-timestreaminfluxdb/types.rb +639 -4
- data/lib/aws-sdk-timestreaminfluxdb.rb +2 -2
- data/sig/client.rbs +124 -0
- data/sig/types.rbs +146 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7b301872cffa5e8e513f9682191a1f9d4f05c60a244df49b478d1be60fa7e324
|
4
|
+
data.tar.gz: 2c493a33fe77dc0cbf350c63cac9f8ba81b2a595533cdc8dd861de3b404002eb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ea845df92d13c77ea4b8fe46b9096877c52709443a0e900e3ed51c63619e1f36214d8ff6654bc1b21ea8854699ec35f019f2355985dc9e0b49a0c66dbc13417c
|
7
|
+
data.tar.gz: cb3f84863dffb951c76ced3e17473df081722dbb64270f5e0bb4e7f5ab11b64e7fec2f0f292288f1250bf284ebf091172c0cbcd6bd5f8d5a883d6147d1cc5e36
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.21.0 (2025-02-18)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.20.0 (2025-02-17)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release introduces APIs to manage DbClusters and adds support for read replicas
|
13
|
+
|
4
14
|
1.19.0 (2025-02-06)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.21.0
|
@@ -7,34 +7,34 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
-
require 'seahorse/client/plugins/content_length
|
11
|
-
require 'aws-sdk-core/plugins/credentials_configuration
|
12
|
-
require 'aws-sdk-core/plugins/logging
|
13
|
-
require 'aws-sdk-core/plugins/param_converter
|
14
|
-
require 'aws-sdk-core/plugins/param_validator
|
15
|
-
require 'aws-sdk-core/plugins/user_agent
|
16
|
-
require 'aws-sdk-core/plugins/helpful_socket_errors
|
17
|
-
require 'aws-sdk-core/plugins/retry_errors
|
18
|
-
require 'aws-sdk-core/plugins/global_configuration
|
19
|
-
require 'aws-sdk-core/plugins/regional_endpoint
|
20
|
-
require 'aws-sdk-core/plugins/endpoint_discovery
|
21
|
-
require 'aws-sdk-core/plugins/endpoint_pattern
|
22
|
-
require 'aws-sdk-core/plugins/response_paging
|
23
|
-
require 'aws-sdk-core/plugins/stub_responses
|
24
|
-
require 'aws-sdk-core/plugins/idempotency_token
|
25
|
-
require 'aws-sdk-core/plugins/invocation_id
|
26
|
-
require 'aws-sdk-core/plugins/jsonvalue_converter
|
27
|
-
require 'aws-sdk-core/plugins/client_metrics_plugin
|
28
|
-
require 'aws-sdk-core/plugins/client_metrics_send_plugin
|
29
|
-
require 'aws-sdk-core/plugins/transfer_encoding
|
30
|
-
require 'aws-sdk-core/plugins/http_checksum
|
31
|
-
require 'aws-sdk-core/plugins/checksum_algorithm
|
32
|
-
require 'aws-sdk-core/plugins/request_compression
|
33
|
-
require 'aws-sdk-core/plugins/defaults_mode
|
34
|
-
require 'aws-sdk-core/plugins/recursion_detection
|
35
|
-
require 'aws-sdk-core/plugins/telemetry
|
36
|
-
require 'aws-sdk-core/plugins/sign
|
37
|
-
require 'aws-sdk-core/plugins/protocols/json_rpc
|
10
|
+
require 'seahorse/client/plugins/content_length'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration'
|
12
|
+
require 'aws-sdk-core/plugins/logging'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token'
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id'
|
26
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin'
|
28
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin'
|
29
|
+
require 'aws-sdk-core/plugins/transfer_encoding'
|
30
|
+
require 'aws-sdk-core/plugins/http_checksum'
|
31
|
+
require 'aws-sdk-core/plugins/checksum_algorithm'
|
32
|
+
require 'aws-sdk-core/plugins/request_compression'
|
33
|
+
require 'aws-sdk-core/plugins/defaults_mode'
|
34
|
+
require 'aws-sdk-core/plugins/recursion_detection'
|
35
|
+
require 'aws-sdk-core/plugins/telemetry'
|
36
|
+
require 'aws-sdk-core/plugins/sign'
|
37
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc'
|
38
38
|
|
39
39
|
module Aws::TimestreamInfluxDB
|
40
40
|
# An API client for TimestreamInfluxDB. To construct a client, you need to configure a `:region` and `:credentials`.
|
@@ -477,6 +477,157 @@ module Aws::TimestreamInfluxDB
|
|
477
477
|
|
478
478
|
# @!group API Operations
|
479
479
|
|
480
|
+
# Creates a new Timestream for InfluxDB cluster.
|
481
|
+
#
|
482
|
+
# @option params [required, String] :name
|
483
|
+
# The name that uniquely identifies the DB cluster when interacting with
|
484
|
+
# the Amazon Timestream for InfluxDB API and CLI commands. This name
|
485
|
+
# will also be a prefix included in the endpoint. DB cluster names must
|
486
|
+
# be unique per customer and per region.
|
487
|
+
#
|
488
|
+
# @option params [String] :username
|
489
|
+
# The username of the initial admin user created in InfluxDB. Must start
|
490
|
+
# with a letter and can't end with a hyphen or contain two consecutive
|
491
|
+
# hyphens. For example, my-user1. This username will allow you to access
|
492
|
+
# the InfluxDB UI to perform various administrative tasks and also use
|
493
|
+
# the InfluxDB CLI to create an operator token. These attributes will be
|
494
|
+
# stored in a secret created in Amazon Web Services Secrets Manager in
|
495
|
+
# your account.
|
496
|
+
#
|
497
|
+
# @option params [required, String] :password
|
498
|
+
# The password of the initial admin user created in InfluxDB. This
|
499
|
+
# password will allow you to access the InfluxDB UI to perform various
|
500
|
+
# administrative tasks and also use the InfluxDB CLI to create an
|
501
|
+
# operator token. These attributes will be stored in a secret created in
|
502
|
+
# Amazon Web Services Secrets Manager in your account.
|
503
|
+
#
|
504
|
+
# @option params [String] :organization
|
505
|
+
# The name of the initial organization for the initial admin user in
|
506
|
+
# InfluxDB. An InfluxDB organization is a workspace for a group of
|
507
|
+
# users.
|
508
|
+
#
|
509
|
+
# @option params [String] :bucket
|
510
|
+
# The name of the initial InfluxDB bucket. All InfluxDB data is stored
|
511
|
+
# in a bucket. A bucket combines the concept of a database and a
|
512
|
+
# retention period (the duration of time that each data point persists).
|
513
|
+
# A bucket belongs to an organization.
|
514
|
+
#
|
515
|
+
# @option params [Integer] :port
|
516
|
+
# The port number on which InfluxDB accepts connections.
|
517
|
+
#
|
518
|
+
# Valid Values: 1024-65535
|
519
|
+
#
|
520
|
+
# Default: 8086
|
521
|
+
#
|
522
|
+
# Constraints: The value can't be 2375-2376, 7788-7799, 8090, or
|
523
|
+
# 51678-51680
|
524
|
+
#
|
525
|
+
# @option params [String] :db_parameter_group_identifier
|
526
|
+
# The ID of the DB parameter group to assign to your DB cluster. DB
|
527
|
+
# parameter groups specify how the database is configured. For example,
|
528
|
+
# DB parameter groups can specify the limit for query concurrency.
|
529
|
+
#
|
530
|
+
# @option params [required, String] :db_instance_type
|
531
|
+
# The Timestream for InfluxDB DB instance type to run InfluxDB on.
|
532
|
+
#
|
533
|
+
# @option params [String] :db_storage_type
|
534
|
+
# The Timestream for InfluxDB DB storage type to read and write InfluxDB
|
535
|
+
# data.
|
536
|
+
#
|
537
|
+
# You can choose between three different types of provisioned Influx
|
538
|
+
# IOPS Included storage according to your workload requirements:
|
539
|
+
#
|
540
|
+
# * Influx I/O Included 3000 IOPS
|
541
|
+
#
|
542
|
+
# * Influx I/O Included 12000 IOPS
|
543
|
+
#
|
544
|
+
# * Influx I/O Included 16000 IOPS
|
545
|
+
#
|
546
|
+
# @option params [required, Integer] :allocated_storage
|
547
|
+
# The amount of storage to allocate for your DB storage type in GiB
|
548
|
+
# (gibibytes).
|
549
|
+
#
|
550
|
+
# @option params [String] :network_type
|
551
|
+
# Specifies whether the network type of the Timestream for InfluxDB
|
552
|
+
# cluster is IPv4, which can communicate over IPv4 protocol only, or
|
553
|
+
# DUAL, which can communicate over both IPv4 and IPv6 protocols.
|
554
|
+
#
|
555
|
+
# @option params [Boolean] :publicly_accessible
|
556
|
+
# Configures the Timestream for InfluxDB cluster with a public IP to
|
557
|
+
# facilitate access from outside the VPC.
|
558
|
+
#
|
559
|
+
# @option params [required, Array<String>] :vpc_subnet_ids
|
560
|
+
# A list of VPC subnet IDs to associate with the DB cluster. Provide at
|
561
|
+
# least two VPC subnet IDs in different Availability Zones when
|
562
|
+
# deploying with a Multi-AZ standby.
|
563
|
+
#
|
564
|
+
# @option params [required, Array<String>] :vpc_security_group_ids
|
565
|
+
# A list of VPC security group IDs to associate with the Timestream for
|
566
|
+
# InfluxDB cluster.
|
567
|
+
#
|
568
|
+
# @option params [required, String] :deployment_type
|
569
|
+
# Specifies the type of cluster to create.
|
570
|
+
#
|
571
|
+
# @option params [String] :failover_mode
|
572
|
+
# Specifies the behavior of failure recovery when the primary node of
|
573
|
+
# the cluster fails.
|
574
|
+
#
|
575
|
+
# @option params [Types::LogDeliveryConfiguration] :log_delivery_configuration
|
576
|
+
# Configuration for sending InfluxDB engine logs to a specified S3
|
577
|
+
# bucket.
|
578
|
+
#
|
579
|
+
# @option params [Hash<String,String>] :tags
|
580
|
+
# A list of key-value pairs to associate with the DB instance.
|
581
|
+
#
|
582
|
+
# @return [Types::CreateDbClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
583
|
+
#
|
584
|
+
# * {Types::CreateDbClusterOutput#db_cluster_id #db_cluster_id} => String
|
585
|
+
# * {Types::CreateDbClusterOutput#db_cluster_status #db_cluster_status} => String
|
586
|
+
#
|
587
|
+
# @example Request syntax with placeholder values
|
588
|
+
#
|
589
|
+
# resp = client.create_db_cluster({
|
590
|
+
# name: "DbClusterName", # required
|
591
|
+
# username: "Username",
|
592
|
+
# password: "Password", # required
|
593
|
+
# organization: "Organization",
|
594
|
+
# bucket: "Bucket",
|
595
|
+
# port: 1,
|
596
|
+
# db_parameter_group_identifier: "DbParameterGroupIdentifier",
|
597
|
+
# db_instance_type: "db.influx.medium", # required, accepts db.influx.medium, db.influx.large, db.influx.xlarge, db.influx.2xlarge, db.influx.4xlarge, db.influx.8xlarge, db.influx.12xlarge, db.influx.16xlarge
|
598
|
+
# db_storage_type: "InfluxIOIncludedT1", # accepts InfluxIOIncludedT1, InfluxIOIncludedT2, InfluxIOIncludedT3
|
599
|
+
# allocated_storage: 1, # required
|
600
|
+
# network_type: "IPV4", # accepts IPV4, DUAL
|
601
|
+
# publicly_accessible: false,
|
602
|
+
# vpc_subnet_ids: ["VpcSubnetId"], # required
|
603
|
+
# vpc_security_group_ids: ["VpcSecurityGroupId"], # required
|
604
|
+
# deployment_type: "MULTI_NODE_READ_REPLICAS", # required, accepts MULTI_NODE_READ_REPLICAS
|
605
|
+
# failover_mode: "AUTOMATIC", # accepts AUTOMATIC, NO_FAILOVER
|
606
|
+
# log_delivery_configuration: {
|
607
|
+
# s3_configuration: { # required
|
608
|
+
# bucket_name: "S3ConfigurationBucketNameString", # required
|
609
|
+
# enabled: false, # required
|
610
|
+
# },
|
611
|
+
# },
|
612
|
+
# tags: {
|
613
|
+
# "TagKey" => "TagValue",
|
614
|
+
# },
|
615
|
+
# })
|
616
|
+
#
|
617
|
+
# @example Response structure
|
618
|
+
#
|
619
|
+
# resp.db_cluster_id #=> String
|
620
|
+
# resp.db_cluster_status #=> String, one of "CREATING", "UPDATING", "DELETING", "AVAILABLE", "FAILED", "DELETED"
|
621
|
+
#
|
622
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/CreateDbCluster AWS API Documentation
|
623
|
+
#
|
624
|
+
# @overload create_db_cluster(params = {})
|
625
|
+
# @param [Hash] params ({})
|
626
|
+
def create_db_cluster(params = {}, options = {})
|
627
|
+
req = build_request(:create_db_cluster, params)
|
628
|
+
req.send_request(options)
|
629
|
+
end
|
630
|
+
|
480
631
|
# Creates a new Timestream for InfluxDB DB instance.
|
481
632
|
#
|
482
633
|
# @option params [required, String] :name
|
@@ -594,6 +745,8 @@ module Aws::TimestreamInfluxDB
|
|
594
745
|
# * {Types::CreateDbInstanceOutput#secondary_availability_zone #secondary_availability_zone} => String
|
595
746
|
# * {Types::CreateDbInstanceOutput#log_delivery_configuration #log_delivery_configuration} => Types::LogDeliveryConfiguration
|
596
747
|
# * {Types::CreateDbInstanceOutput#influx_auth_parameters_secret_arn #influx_auth_parameters_secret_arn} => String
|
748
|
+
# * {Types::CreateDbInstanceOutput#db_cluster_id #db_cluster_id} => String
|
749
|
+
# * {Types::CreateDbInstanceOutput#instance_mode #instance_mode} => String
|
597
750
|
#
|
598
751
|
# @example Request syntax with placeholder values
|
599
752
|
#
|
@@ -648,6 +801,8 @@ module Aws::TimestreamInfluxDB
|
|
648
801
|
# resp.log_delivery_configuration.s3_configuration.bucket_name #=> String
|
649
802
|
# resp.log_delivery_configuration.s3_configuration.enabled #=> Boolean
|
650
803
|
# resp.influx_auth_parameters_secret_arn #=> String
|
804
|
+
# resp.db_cluster_id #=> String
|
805
|
+
# resp.instance_mode #=> String, one of "PRIMARY", "STANDBY", "REPLICA"
|
651
806
|
#
|
652
807
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/CreateDbInstance AWS API Documentation
|
653
808
|
#
|
@@ -812,6 +967,34 @@ module Aws::TimestreamInfluxDB
|
|
812
967
|
req.send_request(options)
|
813
968
|
end
|
814
969
|
|
970
|
+
# Deletes a Timestream for InfluxDB cluster.
|
971
|
+
#
|
972
|
+
# @option params [required, String] :db_cluster_id
|
973
|
+
# Service-generated unique identifier of the DB cluster.
|
974
|
+
#
|
975
|
+
# @return [Types::DeleteDbClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
976
|
+
#
|
977
|
+
# * {Types::DeleteDbClusterOutput#db_cluster_status #db_cluster_status} => String
|
978
|
+
#
|
979
|
+
# @example Request syntax with placeholder values
|
980
|
+
#
|
981
|
+
# resp = client.delete_db_cluster({
|
982
|
+
# db_cluster_id: "DbClusterId", # required
|
983
|
+
# })
|
984
|
+
#
|
985
|
+
# @example Response structure
|
986
|
+
#
|
987
|
+
# resp.db_cluster_status #=> String, one of "CREATING", "UPDATING", "DELETING", "AVAILABLE", "FAILED", "DELETED"
|
988
|
+
#
|
989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/DeleteDbCluster AWS API Documentation
|
990
|
+
#
|
991
|
+
# @overload delete_db_cluster(params = {})
|
992
|
+
# @param [Hash] params ({})
|
993
|
+
def delete_db_cluster(params = {}, options = {})
|
994
|
+
req = build_request(:delete_db_cluster, params)
|
995
|
+
req.send_request(options)
|
996
|
+
end
|
997
|
+
|
815
998
|
# Deletes a Timestream for InfluxDB DB instance.
|
816
999
|
#
|
817
1000
|
# @option params [required, String] :identifier
|
@@ -838,6 +1021,8 @@ module Aws::TimestreamInfluxDB
|
|
838
1021
|
# * {Types::DeleteDbInstanceOutput#secondary_availability_zone #secondary_availability_zone} => String
|
839
1022
|
# * {Types::DeleteDbInstanceOutput#log_delivery_configuration #log_delivery_configuration} => Types::LogDeliveryConfiguration
|
840
1023
|
# * {Types::DeleteDbInstanceOutput#influx_auth_parameters_secret_arn #influx_auth_parameters_secret_arn} => String
|
1024
|
+
# * {Types::DeleteDbInstanceOutput#db_cluster_id #db_cluster_id} => String
|
1025
|
+
# * {Types::DeleteDbInstanceOutput#instance_mode #instance_mode} => String
|
841
1026
|
#
|
842
1027
|
# @example Request syntax with placeholder values
|
843
1028
|
#
|
@@ -869,6 +1054,8 @@ module Aws::TimestreamInfluxDB
|
|
869
1054
|
# resp.log_delivery_configuration.s3_configuration.bucket_name #=> String
|
870
1055
|
# resp.log_delivery_configuration.s3_configuration.enabled #=> Boolean
|
871
1056
|
# resp.influx_auth_parameters_secret_arn #=> String
|
1057
|
+
# resp.db_cluster_id #=> String
|
1058
|
+
# resp.instance_mode #=> String, one of "PRIMARY", "STANDBY", "REPLICA"
|
872
1059
|
#
|
873
1060
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/DeleteDbInstance AWS API Documentation
|
874
1061
|
#
|
@@ -879,6 +1066,73 @@ module Aws::TimestreamInfluxDB
|
|
879
1066
|
req.send_request(options)
|
880
1067
|
end
|
881
1068
|
|
1069
|
+
# Retrieves information about a Timestream for InfluxDB cluster.
|
1070
|
+
#
|
1071
|
+
# @option params [required, String] :db_cluster_id
|
1072
|
+
# Service-generated unique identifier of the DB cluster to retrieve.
|
1073
|
+
#
|
1074
|
+
# @return [Types::GetDbClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1075
|
+
#
|
1076
|
+
# * {Types::GetDbClusterOutput#id #id} => String
|
1077
|
+
# * {Types::GetDbClusterOutput#name #name} => String
|
1078
|
+
# * {Types::GetDbClusterOutput#arn #arn} => String
|
1079
|
+
# * {Types::GetDbClusterOutput#status #status} => String
|
1080
|
+
# * {Types::GetDbClusterOutput#endpoint #endpoint} => String
|
1081
|
+
# * {Types::GetDbClusterOutput#reader_endpoint #reader_endpoint} => String
|
1082
|
+
# * {Types::GetDbClusterOutput#port #port} => Integer
|
1083
|
+
# * {Types::GetDbClusterOutput#deployment_type #deployment_type} => String
|
1084
|
+
# * {Types::GetDbClusterOutput#db_instance_type #db_instance_type} => String
|
1085
|
+
# * {Types::GetDbClusterOutput#network_type #network_type} => String
|
1086
|
+
# * {Types::GetDbClusterOutput#db_storage_type #db_storage_type} => String
|
1087
|
+
# * {Types::GetDbClusterOutput#allocated_storage #allocated_storage} => Integer
|
1088
|
+
# * {Types::GetDbClusterOutput#publicly_accessible #publicly_accessible} => Boolean
|
1089
|
+
# * {Types::GetDbClusterOutput#db_parameter_group_identifier #db_parameter_group_identifier} => String
|
1090
|
+
# * {Types::GetDbClusterOutput#log_delivery_configuration #log_delivery_configuration} => Types::LogDeliveryConfiguration
|
1091
|
+
# * {Types::GetDbClusterOutput#influx_auth_parameters_secret_arn #influx_auth_parameters_secret_arn} => String
|
1092
|
+
# * {Types::GetDbClusterOutput#vpc_subnet_ids #vpc_subnet_ids} => Array<String>
|
1093
|
+
# * {Types::GetDbClusterOutput#vpc_security_group_ids #vpc_security_group_ids} => Array<String>
|
1094
|
+
# * {Types::GetDbClusterOutput#failover_mode #failover_mode} => String
|
1095
|
+
#
|
1096
|
+
# @example Request syntax with placeholder values
|
1097
|
+
#
|
1098
|
+
# resp = client.get_db_cluster({
|
1099
|
+
# db_cluster_id: "DbClusterId", # required
|
1100
|
+
# })
|
1101
|
+
#
|
1102
|
+
# @example Response structure
|
1103
|
+
#
|
1104
|
+
# resp.id #=> String
|
1105
|
+
# resp.name #=> String
|
1106
|
+
# resp.arn #=> String
|
1107
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "AVAILABLE", "FAILED", "DELETED"
|
1108
|
+
# resp.endpoint #=> String
|
1109
|
+
# resp.reader_endpoint #=> String
|
1110
|
+
# resp.port #=> Integer
|
1111
|
+
# resp.deployment_type #=> String, one of "MULTI_NODE_READ_REPLICAS"
|
1112
|
+
# resp.db_instance_type #=> String, one of "db.influx.medium", "db.influx.large", "db.influx.xlarge", "db.influx.2xlarge", "db.influx.4xlarge", "db.influx.8xlarge", "db.influx.12xlarge", "db.influx.16xlarge"
|
1113
|
+
# resp.network_type #=> String, one of "IPV4", "DUAL"
|
1114
|
+
# resp.db_storage_type #=> String, one of "InfluxIOIncludedT1", "InfluxIOIncludedT2", "InfluxIOIncludedT3"
|
1115
|
+
# resp.allocated_storage #=> Integer
|
1116
|
+
# resp.publicly_accessible #=> Boolean
|
1117
|
+
# resp.db_parameter_group_identifier #=> String
|
1118
|
+
# resp.log_delivery_configuration.s3_configuration.bucket_name #=> String
|
1119
|
+
# resp.log_delivery_configuration.s3_configuration.enabled #=> Boolean
|
1120
|
+
# resp.influx_auth_parameters_secret_arn #=> String
|
1121
|
+
# resp.vpc_subnet_ids #=> Array
|
1122
|
+
# resp.vpc_subnet_ids[0] #=> String
|
1123
|
+
# resp.vpc_security_group_ids #=> Array
|
1124
|
+
# resp.vpc_security_group_ids[0] #=> String
|
1125
|
+
# resp.failover_mode #=> String, one of "AUTOMATIC", "NO_FAILOVER"
|
1126
|
+
#
|
1127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbCluster AWS API Documentation
|
1128
|
+
#
|
1129
|
+
# @overload get_db_cluster(params = {})
|
1130
|
+
# @param [Hash] params ({})
|
1131
|
+
def get_db_cluster(params = {}, options = {})
|
1132
|
+
req = build_request(:get_db_cluster, params)
|
1133
|
+
req.send_request(options)
|
1134
|
+
end
|
1135
|
+
|
882
1136
|
# Returns a Timestream for InfluxDB DB instance.
|
883
1137
|
#
|
884
1138
|
# @option params [required, String] :identifier
|
@@ -905,6 +1159,8 @@ module Aws::TimestreamInfluxDB
|
|
905
1159
|
# * {Types::GetDbInstanceOutput#secondary_availability_zone #secondary_availability_zone} => String
|
906
1160
|
# * {Types::GetDbInstanceOutput#log_delivery_configuration #log_delivery_configuration} => Types::LogDeliveryConfiguration
|
907
1161
|
# * {Types::GetDbInstanceOutput#influx_auth_parameters_secret_arn #influx_auth_parameters_secret_arn} => String
|
1162
|
+
# * {Types::GetDbInstanceOutput#db_cluster_id #db_cluster_id} => String
|
1163
|
+
# * {Types::GetDbInstanceOutput#instance_mode #instance_mode} => String
|
908
1164
|
#
|
909
1165
|
# @example Request syntax with placeholder values
|
910
1166
|
#
|
@@ -936,6 +1192,8 @@ module Aws::TimestreamInfluxDB
|
|
936
1192
|
# resp.log_delivery_configuration.s3_configuration.bucket_name #=> String
|
937
1193
|
# resp.log_delivery_configuration.s3_configuration.enabled #=> Boolean
|
938
1194
|
# resp.influx_auth_parameters_secret_arn #=> String
|
1195
|
+
# resp.db_cluster_id #=> String
|
1196
|
+
# resp.instance_mode #=> String, one of "PRIMARY", "STANDBY", "REPLICA"
|
939
1197
|
#
|
940
1198
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbInstance AWS API Documentation
|
941
1199
|
#
|
@@ -1023,6 +1281,58 @@ module Aws::TimestreamInfluxDB
|
|
1023
1281
|
req.send_request(options)
|
1024
1282
|
end
|
1025
1283
|
|
1284
|
+
# Returns a list of Timestream for InfluxDB DB clusters.
|
1285
|
+
#
|
1286
|
+
# @option params [String] :next_token
|
1287
|
+
# The pagination token. To resume pagination, provide the nextToken
|
1288
|
+
# value as an argument of a subsequent API invocation.
|
1289
|
+
#
|
1290
|
+
# @option params [Integer] :max_results
|
1291
|
+
# The maximum number of items to return in the output. If the total
|
1292
|
+
# number of items available is more than the value specified, a
|
1293
|
+
# nextToken is provided in the output. To resume pagination, provide the
|
1294
|
+
# nextToken value as an argument of a subsequent API invocation.
|
1295
|
+
#
|
1296
|
+
# @return [Types::ListDbClustersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1297
|
+
#
|
1298
|
+
# * {Types::ListDbClustersOutput#items #items} => Array<Types::DbClusterSummary>
|
1299
|
+
# * {Types::ListDbClustersOutput#next_token #next_token} => String
|
1300
|
+
#
|
1301
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1302
|
+
#
|
1303
|
+
# @example Request syntax with placeholder values
|
1304
|
+
#
|
1305
|
+
# resp = client.list_db_clusters({
|
1306
|
+
# next_token: "NextToken",
|
1307
|
+
# max_results: 1,
|
1308
|
+
# })
|
1309
|
+
#
|
1310
|
+
# @example Response structure
|
1311
|
+
#
|
1312
|
+
# resp.items #=> Array
|
1313
|
+
# resp.items[0].id #=> String
|
1314
|
+
# resp.items[0].name #=> String
|
1315
|
+
# resp.items[0].arn #=> String
|
1316
|
+
# resp.items[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "AVAILABLE", "FAILED", "DELETED"
|
1317
|
+
# resp.items[0].endpoint #=> String
|
1318
|
+
# resp.items[0].reader_endpoint #=> String
|
1319
|
+
# resp.items[0].port #=> Integer
|
1320
|
+
# resp.items[0].deployment_type #=> String, one of "MULTI_NODE_READ_REPLICAS"
|
1321
|
+
# resp.items[0].db_instance_type #=> String, one of "db.influx.medium", "db.influx.large", "db.influx.xlarge", "db.influx.2xlarge", "db.influx.4xlarge", "db.influx.8xlarge", "db.influx.12xlarge", "db.influx.16xlarge"
|
1322
|
+
# resp.items[0].network_type #=> String, one of "IPV4", "DUAL"
|
1323
|
+
# resp.items[0].db_storage_type #=> String, one of "InfluxIOIncludedT1", "InfluxIOIncludedT2", "InfluxIOIncludedT3"
|
1324
|
+
# resp.items[0].allocated_storage #=> Integer
|
1325
|
+
# resp.next_token #=> String
|
1326
|
+
#
|
1327
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbClusters AWS API Documentation
|
1328
|
+
#
|
1329
|
+
# @overload list_db_clusters(params = {})
|
1330
|
+
# @param [Hash] params ({})
|
1331
|
+
def list_db_clusters(params = {}, options = {})
|
1332
|
+
req = build_request(:list_db_clusters, params)
|
1333
|
+
req.send_request(options)
|
1334
|
+
end
|
1335
|
+
|
1026
1336
|
# Returns a list of Timestream for InfluxDB DB instances.
|
1027
1337
|
#
|
1028
1338
|
# @option params [String] :next_token
|
@@ -1074,6 +1384,62 @@ module Aws::TimestreamInfluxDB
|
|
1074
1384
|
req.send_request(options)
|
1075
1385
|
end
|
1076
1386
|
|
1387
|
+
# Returns a list of Timestream for InfluxDB clusters.
|
1388
|
+
#
|
1389
|
+
# @option params [required, String] :db_cluster_id
|
1390
|
+
# Service-generated unique identifier of the DB cluster.
|
1391
|
+
#
|
1392
|
+
# @option params [String] :next_token
|
1393
|
+
# The pagination token. To resume pagination, provide the nextToken
|
1394
|
+
# value as an argument of a subsequent API invocation.
|
1395
|
+
#
|
1396
|
+
# @option params [Integer] :max_results
|
1397
|
+
# The maximum number of items to return in the output. If the total
|
1398
|
+
# number of items available is more than the value specified, a
|
1399
|
+
# nextToken is provided in the output. To resume pagination, provide the
|
1400
|
+
# nextToken value as an argument of a subsequent API invocation.
|
1401
|
+
#
|
1402
|
+
# @return [Types::ListDbInstancesForClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1403
|
+
#
|
1404
|
+
# * {Types::ListDbInstancesForClusterOutput#items #items} => Array<Types::DbInstanceForClusterSummary>
|
1405
|
+
# * {Types::ListDbInstancesForClusterOutput#next_token #next_token} => String
|
1406
|
+
#
|
1407
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1408
|
+
#
|
1409
|
+
# @example Request syntax with placeholder values
|
1410
|
+
#
|
1411
|
+
# resp = client.list_db_instances_for_cluster({
|
1412
|
+
# db_cluster_id: "DbClusterId", # required
|
1413
|
+
# next_token: "NextToken",
|
1414
|
+
# max_results: 1,
|
1415
|
+
# })
|
1416
|
+
#
|
1417
|
+
# @example Response structure
|
1418
|
+
#
|
1419
|
+
# resp.items #=> Array
|
1420
|
+
# resp.items[0].id #=> String
|
1421
|
+
# resp.items[0].name #=> String
|
1422
|
+
# resp.items[0].arn #=> String
|
1423
|
+
# resp.items[0].status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "MODIFYING", "UPDATING", "DELETED", "FAILED", "UPDATING_DEPLOYMENT_TYPE", "UPDATING_INSTANCE_TYPE"
|
1424
|
+
# resp.items[0].endpoint #=> String
|
1425
|
+
# resp.items[0].port #=> Integer
|
1426
|
+
# resp.items[0].network_type #=> String, one of "IPV4", "DUAL"
|
1427
|
+
# resp.items[0].db_instance_type #=> String, one of "db.influx.medium", "db.influx.large", "db.influx.xlarge", "db.influx.2xlarge", "db.influx.4xlarge", "db.influx.8xlarge", "db.influx.12xlarge", "db.influx.16xlarge"
|
1428
|
+
# resp.items[0].db_storage_type #=> String, one of "InfluxIOIncludedT1", "InfluxIOIncludedT2", "InfluxIOIncludedT3"
|
1429
|
+
# resp.items[0].allocated_storage #=> Integer
|
1430
|
+
# resp.items[0].deployment_type #=> String, one of "SINGLE_AZ", "WITH_MULTIAZ_STANDBY"
|
1431
|
+
# resp.items[0].instance_mode #=> String, one of "PRIMARY", "STANDBY", "REPLICA"
|
1432
|
+
# resp.next_token #=> String
|
1433
|
+
#
|
1434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbInstancesForCluster AWS API Documentation
|
1435
|
+
#
|
1436
|
+
# @overload list_db_instances_for_cluster(params = {})
|
1437
|
+
# @param [Hash] params ({})
|
1438
|
+
def list_db_instances_for_cluster(params = {}, options = {})
|
1439
|
+
req = build_request(:list_db_instances_for_cluster, params)
|
1440
|
+
req.send_request(options)
|
1441
|
+
end
|
1442
|
+
|
1077
1443
|
# Returns a list of Timestream for InfluxDB DB parameter groups.
|
1078
1444
|
#
|
1079
1445
|
# @option params [String] :next_token
|
@@ -1202,6 +1568,59 @@ module Aws::TimestreamInfluxDB
|
|
1202
1568
|
req.send_request(options)
|
1203
1569
|
end
|
1204
1570
|
|
1571
|
+
# Updates a Timestream for InfluxDB cluster.
|
1572
|
+
#
|
1573
|
+
# @option params [required, String] :db_cluster_id
|
1574
|
+
# Service-generated unique identifier of the DB cluster to update.
|
1575
|
+
#
|
1576
|
+
# @option params [Types::LogDeliveryConfiguration] :log_delivery_configuration
|
1577
|
+
# The log delivery configuration to apply to the DB cluster.
|
1578
|
+
#
|
1579
|
+
# @option params [String] :db_parameter_group_identifier
|
1580
|
+
# Update the DB cluster to use the specified DB parameter group.
|
1581
|
+
#
|
1582
|
+
# @option params [Integer] :port
|
1583
|
+
# Update the DB cluster to use the specified port.
|
1584
|
+
#
|
1585
|
+
# @option params [String] :db_instance_type
|
1586
|
+
# Update the DB cluster to use the specified DB instance Type.
|
1587
|
+
#
|
1588
|
+
# @option params [String] :failover_mode
|
1589
|
+
# Update the DB cluster's failover behavior.
|
1590
|
+
#
|
1591
|
+
# @return [Types::UpdateDbClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1592
|
+
#
|
1593
|
+
# * {Types::UpdateDbClusterOutput#db_cluster_status #db_cluster_status} => String
|
1594
|
+
#
|
1595
|
+
# @example Request syntax with placeholder values
|
1596
|
+
#
|
1597
|
+
# resp = client.update_db_cluster({
|
1598
|
+
# db_cluster_id: "DbClusterId", # required
|
1599
|
+
# log_delivery_configuration: {
|
1600
|
+
# s3_configuration: { # required
|
1601
|
+
# bucket_name: "S3ConfigurationBucketNameString", # required
|
1602
|
+
# enabled: false, # required
|
1603
|
+
# },
|
1604
|
+
# },
|
1605
|
+
# db_parameter_group_identifier: "DbParameterGroupIdentifier",
|
1606
|
+
# port: 1,
|
1607
|
+
# db_instance_type: "db.influx.medium", # accepts db.influx.medium, db.influx.large, db.influx.xlarge, db.influx.2xlarge, db.influx.4xlarge, db.influx.8xlarge, db.influx.12xlarge, db.influx.16xlarge
|
1608
|
+
# failover_mode: "AUTOMATIC", # accepts AUTOMATIC, NO_FAILOVER
|
1609
|
+
# })
|
1610
|
+
#
|
1611
|
+
# @example Response structure
|
1612
|
+
#
|
1613
|
+
# resp.db_cluster_status #=> String, one of "CREATING", "UPDATING", "DELETING", "AVAILABLE", "FAILED", "DELETED"
|
1614
|
+
#
|
1615
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/UpdateDbCluster AWS API Documentation
|
1616
|
+
#
|
1617
|
+
# @overload update_db_cluster(params = {})
|
1618
|
+
# @param [Hash] params ({})
|
1619
|
+
def update_db_cluster(params = {}, options = {})
|
1620
|
+
req = build_request(:update_db_cluster, params)
|
1621
|
+
req.send_request(options)
|
1622
|
+
end
|
1623
|
+
|
1205
1624
|
# Updates a Timestream for InfluxDB DB instance.
|
1206
1625
|
#
|
1207
1626
|
# @option params [required, String] :identifier
|
@@ -1264,6 +1683,8 @@ module Aws::TimestreamInfluxDB
|
|
1264
1683
|
# * {Types::UpdateDbInstanceOutput#secondary_availability_zone #secondary_availability_zone} => String
|
1265
1684
|
# * {Types::UpdateDbInstanceOutput#log_delivery_configuration #log_delivery_configuration} => Types::LogDeliveryConfiguration
|
1266
1685
|
# * {Types::UpdateDbInstanceOutput#influx_auth_parameters_secret_arn #influx_auth_parameters_secret_arn} => String
|
1686
|
+
# * {Types::UpdateDbInstanceOutput#db_cluster_id #db_cluster_id} => String
|
1687
|
+
# * {Types::UpdateDbInstanceOutput#instance_mode #instance_mode} => String
|
1267
1688
|
#
|
1268
1689
|
# @example Request syntax with placeholder values
|
1269
1690
|
#
|
@@ -1307,6 +1728,8 @@ module Aws::TimestreamInfluxDB
|
|
1307
1728
|
# resp.log_delivery_configuration.s3_configuration.bucket_name #=> String
|
1308
1729
|
# resp.log_delivery_configuration.s3_configuration.enabled #=> Boolean
|
1309
1730
|
# resp.influx_auth_parameters_secret_arn #=> String
|
1731
|
+
# resp.db_cluster_id #=> String
|
1732
|
+
# resp.instance_mode #=> String, one of "PRIMARY", "STANDBY", "REPLICA"
|
1310
1733
|
#
|
1311
1734
|
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/UpdateDbInstance AWS API Documentation
|
1312
1735
|
#
|
@@ -1335,7 +1758,7 @@ module Aws::TimestreamInfluxDB
|
|
1335
1758
|
tracer: tracer
|
1336
1759
|
)
|
1337
1760
|
context[:gem_name] = 'aws-sdk-timestreaminfluxdb'
|
1338
|
-
context[:gem_version] = '1.
|
1761
|
+
context[:gem_version] = '1.21.0'
|
1339
1762
|
Seahorse::Client::Request.new(handlers, context)
|
1340
1763
|
end
|
1341
1764
|
|