aws-sdk-timestreaminfluxdb 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-timestreaminfluxdb/client.rb +1088 -0
- data/lib/aws-sdk-timestreaminfluxdb/client_api.rb +500 -0
- data/lib/aws-sdk-timestreaminfluxdb/customizations.rb +0 -0
- data/lib/aws-sdk-timestreaminfluxdb/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-timestreaminfluxdb/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-timestreaminfluxdb/endpoints.rb +170 -0
- data/lib/aws-sdk-timestreaminfluxdb/errors.rb +188 -0
- data/lib/aws-sdk-timestreaminfluxdb/plugins/endpoints.rb +92 -0
- data/lib/aws-sdk-timestreaminfluxdb/resource.rb +26 -0
- data/lib/aws-sdk-timestreaminfluxdb/types.rb +1182 -0
- data/lib/aws-sdk-timestreaminfluxdb.rb +57 -0
- data/sig/client.rbs +297 -0
- data/sig/errors.rbs +43 -0
- data/sig/resource.rbs +80 -0
- data/sig/types.rbs +303 -0
- data/sig/waiters.rbs +13 -0
- metadata +99 -0
@@ -0,0 +1,1088 @@
|
|
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
|
+
require 'seahorse/client/plugins/content_length.rb'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
12
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/request_compression.rb'
|
32
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
33
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
34
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
35
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
36
|
+
|
37
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:timestreaminfluxdb)
|
38
|
+
|
39
|
+
module Aws::TimestreamInfluxDB
|
40
|
+
# An API client for TimestreamInfluxDB. To construct a client, you need to configure a `:region` and `:credentials`.
|
41
|
+
#
|
42
|
+
# client = Aws::TimestreamInfluxDB::Client.new(
|
43
|
+
# region: region_name,
|
44
|
+
# credentials: credentials,
|
45
|
+
# # ...
|
46
|
+
# )
|
47
|
+
#
|
48
|
+
# For details on configuring region and credentials see
|
49
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
50
|
+
#
|
51
|
+
# See {#initialize} for a full list of supported configuration options.
|
52
|
+
class Client < Seahorse::Client::Base
|
53
|
+
|
54
|
+
include Aws::ClientStubs
|
55
|
+
|
56
|
+
@identifier = :timestreaminfluxdb
|
57
|
+
|
58
|
+
set_api(ClientApi::API)
|
59
|
+
|
60
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
61
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
62
|
+
add_plugin(Aws::Plugins::Logging)
|
63
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
64
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
65
|
+
add_plugin(Aws::Plugins::UserAgent)
|
66
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
67
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
68
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
69
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
70
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
71
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
72
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
73
|
+
add_plugin(Aws::Plugins::StubResponses)
|
74
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
75
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
76
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
77
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
78
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
79
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
80
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
81
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
82
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
83
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
84
|
+
add_plugin(Aws::Plugins::Sign)
|
85
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
86
|
+
add_plugin(Aws::TimestreamInfluxDB::Plugins::Endpoints)
|
87
|
+
|
88
|
+
# @overload initialize(options)
|
89
|
+
# @param [Hash] options
|
90
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
91
|
+
# Your AWS credentials. This can be an instance of any one of the
|
92
|
+
# following classes:
|
93
|
+
#
|
94
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
95
|
+
# credentials.
|
96
|
+
#
|
97
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
98
|
+
# shared file, such as `~/.aws/config`.
|
99
|
+
#
|
100
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
101
|
+
#
|
102
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
103
|
+
# assume a role after providing credentials via the web.
|
104
|
+
#
|
105
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
106
|
+
# access token generated from `aws login`.
|
107
|
+
#
|
108
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
109
|
+
# process that outputs to stdout.
|
110
|
+
#
|
111
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
112
|
+
# from an EC2 IMDS on an EC2 instance.
|
113
|
+
#
|
114
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
115
|
+
# instances running in ECS.
|
116
|
+
#
|
117
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
118
|
+
# from the Cognito Identity service.
|
119
|
+
#
|
120
|
+
# When `:credentials` are not configured directly, the following
|
121
|
+
# locations will be searched for credentials:
|
122
|
+
#
|
123
|
+
# * `Aws.config[:credentials]`
|
124
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
125
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
126
|
+
# * `~/.aws/credentials`
|
127
|
+
# * `~/.aws/config`
|
128
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
129
|
+
# are very aggressive. Construct and pass an instance of
|
130
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
131
|
+
# enable retries and extended timeouts. Instance profile credential
|
132
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
133
|
+
# to true.
|
134
|
+
#
|
135
|
+
# @option options [required, String] :region
|
136
|
+
# The AWS region to connect to. The configured `:region` is
|
137
|
+
# used to determine the service `:endpoint`. When not passed,
|
138
|
+
# a default `:region` is searched for in the following locations:
|
139
|
+
#
|
140
|
+
# * `Aws.config[:region]`
|
141
|
+
# * `ENV['AWS_REGION']`
|
142
|
+
# * `ENV['AMAZON_REGION']`
|
143
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
144
|
+
# * `~/.aws/credentials`
|
145
|
+
# * `~/.aws/config`
|
146
|
+
#
|
147
|
+
# @option options [String] :access_key_id
|
148
|
+
#
|
149
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
150
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
151
|
+
# the background every 60 secs (default). Defaults to `false`.
|
152
|
+
#
|
153
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
154
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
155
|
+
# until there is sufficent client side capacity to retry the request.
|
156
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
157
|
+
# not retry instead of sleeping.
|
158
|
+
#
|
159
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
160
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
161
|
+
# this client.
|
162
|
+
#
|
163
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
164
|
+
# Allows you to provide an identifier for this client which will be attached to
|
165
|
+
# all generated client side metrics. Defaults to an empty string.
|
166
|
+
#
|
167
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
168
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
169
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
170
|
+
#
|
171
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
172
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
173
|
+
# agent is running on, where client metrics will be published via UDP.
|
174
|
+
#
|
175
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
176
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
177
|
+
# will use the Client Side Monitoring Agent Publisher.
|
178
|
+
#
|
179
|
+
# @option options [Boolean] :convert_params (true)
|
180
|
+
# When `true`, an attempt is made to coerce request parameters into
|
181
|
+
# the required types.
|
182
|
+
#
|
183
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
184
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
185
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
186
|
+
#
|
187
|
+
# @option options [String] :defaults_mode ("legacy")
|
188
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
189
|
+
# accepted modes and the configuration defaults that are included.
|
190
|
+
#
|
191
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
192
|
+
# Set to true to disable SDK automatically adding host prefix
|
193
|
+
# to default service endpoint when available.
|
194
|
+
#
|
195
|
+
# @option options [Boolean] :disable_request_compression (false)
|
196
|
+
# When set to 'true' the request body will not be compressed
|
197
|
+
# for supported operations.
|
198
|
+
#
|
199
|
+
# @option options [String] :endpoint
|
200
|
+
# The client endpoint is normally constructed from the `:region`
|
201
|
+
# option. You should only configure an `:endpoint` when connecting
|
202
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
203
|
+
#
|
204
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
205
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
206
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
207
|
+
#
|
208
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
209
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
210
|
+
#
|
211
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
212
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
213
|
+
# Use this option to config the time interval in seconds for making
|
214
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
215
|
+
#
|
216
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
217
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
218
|
+
#
|
219
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
220
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
221
|
+
# variables and the shared configuration file.
|
222
|
+
#
|
223
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
224
|
+
# The log formatter.
|
225
|
+
#
|
226
|
+
# @option options [Symbol] :log_level (:info)
|
227
|
+
# The log level to send messages to the `:logger` at.
|
228
|
+
#
|
229
|
+
# @option options [Logger] :logger
|
230
|
+
# The Logger instance to send log messages to. If this option
|
231
|
+
# is not set, logging will be disabled.
|
232
|
+
#
|
233
|
+
# @option options [Integer] :max_attempts (3)
|
234
|
+
# An integer representing the maximum number attempts that will be made for
|
235
|
+
# a single request, including the initial attempt. For example,
|
236
|
+
# setting this value to 5 will result in a request being retried up to
|
237
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
238
|
+
#
|
239
|
+
# @option options [String] :profile ("default")
|
240
|
+
# Used when loading credentials from the shared credentials file
|
241
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
242
|
+
#
|
243
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
244
|
+
# The minimum size in bytes that triggers compression for request
|
245
|
+
# bodies. The value must be non-negative integer value between 0
|
246
|
+
# and 10485780 bytes inclusive.
|
247
|
+
#
|
248
|
+
# @option options [Proc] :retry_backoff
|
249
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
250
|
+
# This option is only used in the `legacy` retry mode.
|
251
|
+
#
|
252
|
+
# @option options [Float] :retry_base_delay (0.3)
|
253
|
+
# The base delay in seconds used by the default backoff function. This option
|
254
|
+
# is only used in the `legacy` retry mode.
|
255
|
+
#
|
256
|
+
# @option options [Symbol] :retry_jitter (:none)
|
257
|
+
# A delay randomiser function used by the default backoff function.
|
258
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
259
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
260
|
+
# in the `legacy` retry mode.
|
261
|
+
#
|
262
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
263
|
+
#
|
264
|
+
# @option options [Integer] :retry_limit (3)
|
265
|
+
# The maximum number of times to retry failed requests. Only
|
266
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
267
|
+
# are retried. Generally, these are throttling errors, data
|
268
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
269
|
+
# endpoint discovery, and errors from expired credentials.
|
270
|
+
# This option is only used in the `legacy` retry mode.
|
271
|
+
#
|
272
|
+
# @option options [Integer] :retry_max_delay (0)
|
273
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
274
|
+
# used by the default backoff function. This option is only used in the
|
275
|
+
# `legacy` retry mode.
|
276
|
+
#
|
277
|
+
# @option options [String] :retry_mode ("legacy")
|
278
|
+
# Specifies which retry algorithm to use. Values are:
|
279
|
+
#
|
280
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
281
|
+
# no retry mode is provided.
|
282
|
+
#
|
283
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
284
|
+
# This includes support for retry quotas, which limit the number of
|
285
|
+
# unsuccessful retries a client can make.
|
286
|
+
#
|
287
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
288
|
+
# functionality of `standard` mode along with automatic client side
|
289
|
+
# throttling. This is a provisional mode that may change behavior
|
290
|
+
# in the future.
|
291
|
+
#
|
292
|
+
#
|
293
|
+
# @option options [String] :sdk_ua_app_id
|
294
|
+
# A unique and opaque application ID that is appended to the
|
295
|
+
# User-Agent header as app/<sdk_ua_app_id>. It should have a
|
296
|
+
# maximum length of 50.
|
297
|
+
#
|
298
|
+
# @option options [String] :secret_access_key
|
299
|
+
#
|
300
|
+
# @option options [String] :session_token
|
301
|
+
#
|
302
|
+
# @option options [Boolean] :simple_json (false)
|
303
|
+
# Disables request parameter conversion, validation, and formatting.
|
304
|
+
# Also disable response data type conversions. This option is useful
|
305
|
+
# when you want to ensure the highest level of performance by
|
306
|
+
# avoiding overhead of walking request parameters and response data
|
307
|
+
# structures.
|
308
|
+
#
|
309
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
310
|
+
# be formatted exactly as the DynamoDB API expects.
|
311
|
+
#
|
312
|
+
# @option options [Boolean] :stub_responses (false)
|
313
|
+
# Causes the client to return stubbed responses. By default
|
314
|
+
# fake responses are generated and returned. You can specify
|
315
|
+
# the response data to return or errors to raise by calling
|
316
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
317
|
+
#
|
318
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
319
|
+
# requests are made, and retries are disabled.
|
320
|
+
#
|
321
|
+
# @option options [Aws::TokenProvider] :token_provider
|
322
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
323
|
+
# following classes:
|
324
|
+
#
|
325
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
326
|
+
# tokens.
|
327
|
+
#
|
328
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
329
|
+
# access token generated from `aws login`.
|
330
|
+
#
|
331
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
332
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
333
|
+
#
|
334
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
335
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
336
|
+
# will be used if available.
|
337
|
+
#
|
338
|
+
# @option options [Boolean] :use_fips_endpoint
|
339
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
340
|
+
# When a `fips` region is used, the region is normalized and this config
|
341
|
+
# is set to `true`.
|
342
|
+
#
|
343
|
+
# @option options [Boolean] :validate_params (true)
|
344
|
+
# When `true`, request parameters are validated before
|
345
|
+
# sending the request.
|
346
|
+
#
|
347
|
+
# @option options [Aws::TimestreamInfluxDB::EndpointProvider] :endpoint_provider
|
348
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::TimestreamInfluxDB::EndpointParameters`
|
349
|
+
#
|
350
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
351
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
352
|
+
#
|
353
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
354
|
+
# seconds to wait when opening a HTTP session before raising a
|
355
|
+
# `Timeout::Error`.
|
356
|
+
#
|
357
|
+
# @option options [Float] :http_read_timeout (60) The default
|
358
|
+
# number of seconds to wait for response data. This value can
|
359
|
+
# safely be set per-request on the session.
|
360
|
+
#
|
361
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
362
|
+
# seconds a connection is allowed to sit idle before it is
|
363
|
+
# considered stale. Stale connections are closed and removed
|
364
|
+
# from the pool before making a request.
|
365
|
+
#
|
366
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
367
|
+
# seconds to wait for a 100-continue response before sending the
|
368
|
+
# request body. This option has no effect unless the request has
|
369
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
370
|
+
# disables this behaviour. This value can safely be set per
|
371
|
+
# request on the session.
|
372
|
+
#
|
373
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
374
|
+
# in seconds.
|
375
|
+
#
|
376
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
377
|
+
# HTTP debug output will be sent to the `:logger`.
|
378
|
+
#
|
379
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
380
|
+
# SSL peer certificates are verified when establishing a
|
381
|
+
# connection.
|
382
|
+
#
|
383
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
384
|
+
# certificate authority bundle file that should be used when
|
385
|
+
# verifying peer certificates. If you do not pass
|
386
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
387
|
+
# will be used if available.
|
388
|
+
#
|
389
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
390
|
+
# directory that contains the unbundled SSL certificate
|
391
|
+
# authority files for verifying peer certificates. If you do
|
392
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
393
|
+
# system default will be used if available.
|
394
|
+
#
|
395
|
+
def initialize(*args)
|
396
|
+
super
|
397
|
+
end
|
398
|
+
|
399
|
+
# @!group API Operations
|
400
|
+
|
401
|
+
# Creates a new Timestream for InfluxDB DB instance.
|
402
|
+
#
|
403
|
+
# @option params [required, String] :name
|
404
|
+
# The name that uniquely identifies the DB instance when interacting
|
405
|
+
# with the Amazon Timestream for InfluxDB API and CLI commands. This
|
406
|
+
# name will also be a prefix included in the endpoint. DB instance names
|
407
|
+
# must be unique per customer and per region.
|
408
|
+
#
|
409
|
+
# @option params [String] :username
|
410
|
+
# The username of the initial admin user created in InfluxDB. Must start
|
411
|
+
# with a letter and can't end with a hyphen or contain two consecutive
|
412
|
+
# hyphens. For example, my-user1. This username will allow you to access
|
413
|
+
# the InfluxDB UI to perform various administrative tasks and also use
|
414
|
+
# the InfluxDB CLI to create an operator token. These attributes will be
|
415
|
+
# stored in a Secret created in Amazon Secrets Manager in your account.
|
416
|
+
#
|
417
|
+
# @option params [required, String] :password
|
418
|
+
# The password of the initial admin user created in InfluxDB. This
|
419
|
+
# password will allow you to access the InfluxDB UI to perform various
|
420
|
+
# administrative tasks and also use the InfluxDB CLI to create an
|
421
|
+
# operator token. These attributes will be stored in a Secret created in
|
422
|
+
# AWS SecretManager in your account.
|
423
|
+
#
|
424
|
+
# @option params [String] :organization
|
425
|
+
# The name of the initial organization for the initial admin user in
|
426
|
+
# InfluxDB. An InfluxDB organization is a workspace for a group of
|
427
|
+
# users.
|
428
|
+
#
|
429
|
+
# @option params [String] :bucket
|
430
|
+
# The name of the initial InfluxDB bucket. All InfluxDB data is stored
|
431
|
+
# in a bucket. A bucket combines the concept of a database and a
|
432
|
+
# retention period (the duration of time that each data point persists).
|
433
|
+
# A bucket belongs to an organization.
|
434
|
+
#
|
435
|
+
# @option params [required, String] :db_instance_type
|
436
|
+
# The Timestream for InfluxDB DB instance type to run InfluxDB on.
|
437
|
+
#
|
438
|
+
# @option params [required, Array<String>] :vpc_subnet_ids
|
439
|
+
# A list of VPC subnet IDs to associate with the DB instance. Provide at
|
440
|
+
# least two VPC subnet IDs in different availability zones when
|
441
|
+
# deploying with a Multi-AZ standby.
|
442
|
+
#
|
443
|
+
# @option params [required, Array<String>] :vpc_security_group_ids
|
444
|
+
# A list of VPC security group IDs to associate with the DB instance.
|
445
|
+
#
|
446
|
+
# @option params [Boolean] :publicly_accessible
|
447
|
+
# Configures the DB instance with a public IP to facilitate access.
|
448
|
+
#
|
449
|
+
# @option params [String] :db_storage_type
|
450
|
+
# The Timestream for InfluxDB DB storage type to read and write InfluxDB
|
451
|
+
# data.
|
452
|
+
#
|
453
|
+
# You can choose between 3 different types of provisioned Influx IOPS
|
454
|
+
# included storage according to your workloads requirements:
|
455
|
+
#
|
456
|
+
# * Influx IO Included 3000 IOPS
|
457
|
+
#
|
458
|
+
# * Influx IO Included 12000 IOPS
|
459
|
+
#
|
460
|
+
# * Influx IO Included 16000 IOPS
|
461
|
+
#
|
462
|
+
# @option params [required, Integer] :allocated_storage
|
463
|
+
# The amount of storage to allocate for your DB storage type in GiB
|
464
|
+
# (gibibytes).
|
465
|
+
#
|
466
|
+
# @option params [String] :db_parameter_group_identifier
|
467
|
+
# The id of the DB parameter group to assign to your DB instance. DB
|
468
|
+
# parameter groups specify how the database is configured. For example,
|
469
|
+
# DB parameter groups can specify the limit for query concurrency.
|
470
|
+
#
|
471
|
+
# @option params [String] :deployment_type
|
472
|
+
# Specifies whether the DB instance will be deployed as a standalone
|
473
|
+
# instance or with a Multi-AZ standby for high availability.
|
474
|
+
#
|
475
|
+
# @option params [Types::LogDeliveryConfiguration] :log_delivery_configuration
|
476
|
+
# Configuration for sending InfluxDB engine logs to a specified S3
|
477
|
+
# bucket.
|
478
|
+
#
|
479
|
+
# @option params [Hash<String,String>] :tags
|
480
|
+
# A list of key-value pairs to associate with the DB instance.
|
481
|
+
#
|
482
|
+
# @return [Types::CreateDbInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
483
|
+
#
|
484
|
+
# * {Types::CreateDbInstanceOutput#id #id} => String
|
485
|
+
# * {Types::CreateDbInstanceOutput#name #name} => String
|
486
|
+
# * {Types::CreateDbInstanceOutput#arn #arn} => String
|
487
|
+
# * {Types::CreateDbInstanceOutput#status #status} => String
|
488
|
+
# * {Types::CreateDbInstanceOutput#endpoint #endpoint} => String
|
489
|
+
# * {Types::CreateDbInstanceOutput#db_instance_type #db_instance_type} => String
|
490
|
+
# * {Types::CreateDbInstanceOutput#db_storage_type #db_storage_type} => String
|
491
|
+
# * {Types::CreateDbInstanceOutput#allocated_storage #allocated_storage} => Integer
|
492
|
+
# * {Types::CreateDbInstanceOutput#deployment_type #deployment_type} => String
|
493
|
+
# * {Types::CreateDbInstanceOutput#vpc_subnet_ids #vpc_subnet_ids} => Array<String>
|
494
|
+
# * {Types::CreateDbInstanceOutput#publicly_accessible #publicly_accessible} => Boolean
|
495
|
+
# * {Types::CreateDbInstanceOutput#vpc_security_group_ids #vpc_security_group_ids} => Array<String>
|
496
|
+
# * {Types::CreateDbInstanceOutput#db_parameter_group_identifier #db_parameter_group_identifier} => String
|
497
|
+
# * {Types::CreateDbInstanceOutput#availability_zone #availability_zone} => String
|
498
|
+
# * {Types::CreateDbInstanceOutput#secondary_availability_zone #secondary_availability_zone} => String
|
499
|
+
# * {Types::CreateDbInstanceOutput#log_delivery_configuration #log_delivery_configuration} => Types::LogDeliveryConfiguration
|
500
|
+
# * {Types::CreateDbInstanceOutput#influx_auth_parameters_secret_arn #influx_auth_parameters_secret_arn} => String
|
501
|
+
#
|
502
|
+
# @example Request syntax with placeholder values
|
503
|
+
#
|
504
|
+
# resp = client.create_db_instance({
|
505
|
+
# name: "DbInstanceName", # required
|
506
|
+
# username: "Username",
|
507
|
+
# password: "Password", # required
|
508
|
+
# organization: "Organization",
|
509
|
+
# bucket: "Bucket",
|
510
|
+
# 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
|
511
|
+
# vpc_subnet_ids: ["VpcSubnetId"], # required
|
512
|
+
# vpc_security_group_ids: ["VpcSecurityGroupId"], # required
|
513
|
+
# publicly_accessible: false,
|
514
|
+
# db_storage_type: "InfluxIOIncludedT1", # accepts InfluxIOIncludedT1, InfluxIOIncludedT2, InfluxIOIncludedT3
|
515
|
+
# allocated_storage: 1, # required
|
516
|
+
# db_parameter_group_identifier: "DbParameterGroupIdentifier",
|
517
|
+
# deployment_type: "SINGLE_AZ", # accepts SINGLE_AZ, WITH_MULTIAZ_STANDBY
|
518
|
+
# log_delivery_configuration: {
|
519
|
+
# s3_configuration: { # required
|
520
|
+
# bucket_name: "S3ConfigurationBucketNameString", # required
|
521
|
+
# enabled: false, # required
|
522
|
+
# },
|
523
|
+
# },
|
524
|
+
# tags: {
|
525
|
+
# "TagKey" => "TagValue",
|
526
|
+
# },
|
527
|
+
# })
|
528
|
+
#
|
529
|
+
# @example Response structure
|
530
|
+
#
|
531
|
+
# resp.id #=> String
|
532
|
+
# resp.name #=> String
|
533
|
+
# resp.arn #=> String
|
534
|
+
# resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "MODIFYING", "UPDATING", "DELETED", "FAILED"
|
535
|
+
# resp.endpoint #=> String
|
536
|
+
# 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"
|
537
|
+
# resp.db_storage_type #=> String, one of "InfluxIOIncludedT1", "InfluxIOIncludedT2", "InfluxIOIncludedT3"
|
538
|
+
# resp.allocated_storage #=> Integer
|
539
|
+
# resp.deployment_type #=> String, one of "SINGLE_AZ", "WITH_MULTIAZ_STANDBY"
|
540
|
+
# resp.vpc_subnet_ids #=> Array
|
541
|
+
# resp.vpc_subnet_ids[0] #=> String
|
542
|
+
# resp.publicly_accessible #=> Boolean
|
543
|
+
# resp.vpc_security_group_ids #=> Array
|
544
|
+
# resp.vpc_security_group_ids[0] #=> String
|
545
|
+
# resp.db_parameter_group_identifier #=> String
|
546
|
+
# resp.availability_zone #=> String
|
547
|
+
# resp.secondary_availability_zone #=> String
|
548
|
+
# resp.log_delivery_configuration.s3_configuration.bucket_name #=> String
|
549
|
+
# resp.log_delivery_configuration.s3_configuration.enabled #=> Boolean
|
550
|
+
# resp.influx_auth_parameters_secret_arn #=> String
|
551
|
+
#
|
552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/CreateDbInstance AWS API Documentation
|
553
|
+
#
|
554
|
+
# @overload create_db_instance(params = {})
|
555
|
+
# @param [Hash] params ({})
|
556
|
+
def create_db_instance(params = {}, options = {})
|
557
|
+
req = build_request(:create_db_instance, params)
|
558
|
+
req.send_request(options)
|
559
|
+
end
|
560
|
+
|
561
|
+
# Creates a new Timestream for InfluxDB DB parameter group to associate
|
562
|
+
# with DB instances.
|
563
|
+
#
|
564
|
+
# @option params [required, String] :name
|
565
|
+
# The name of the DB parameter group. The name must be unique per
|
566
|
+
# customer and per region.
|
567
|
+
#
|
568
|
+
# @option params [String] :description
|
569
|
+
# A description of the DB parameter group.
|
570
|
+
#
|
571
|
+
# @option params [Types::Parameters] :parameters
|
572
|
+
# A list of the parameters that comprise the DB parameter group.
|
573
|
+
#
|
574
|
+
# @option params [Hash<String,String>] :tags
|
575
|
+
# A list of key-value pairs to associate with the DB parameter group.
|
576
|
+
#
|
577
|
+
# @return [Types::CreateDbParameterGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
578
|
+
#
|
579
|
+
# * {Types::CreateDbParameterGroupOutput#id #id} => String
|
580
|
+
# * {Types::CreateDbParameterGroupOutput#name #name} => String
|
581
|
+
# * {Types::CreateDbParameterGroupOutput#arn #arn} => String
|
582
|
+
# * {Types::CreateDbParameterGroupOutput#description #description} => String
|
583
|
+
# * {Types::CreateDbParameterGroupOutput#parameters #parameters} => Types::Parameters
|
584
|
+
#
|
585
|
+
# @example Request syntax with placeholder values
|
586
|
+
#
|
587
|
+
# resp = client.create_db_parameter_group({
|
588
|
+
# name: "DbParameterGroupName", # required
|
589
|
+
# description: "CreateDbParameterGroupInputDescriptionString",
|
590
|
+
# parameters: {
|
591
|
+
# influx_d_bv_2: {
|
592
|
+
# flux_log_enabled: false,
|
593
|
+
# log_level: "debug", # accepts debug, info, error
|
594
|
+
# no_tasks: false,
|
595
|
+
# query_concurrency: 1,
|
596
|
+
# query_queue_size: 1,
|
597
|
+
# tracing_type: "log", # accepts log, jaeger
|
598
|
+
# metrics_disabled: false,
|
599
|
+
# },
|
600
|
+
# },
|
601
|
+
# tags: {
|
602
|
+
# "TagKey" => "TagValue",
|
603
|
+
# },
|
604
|
+
# })
|
605
|
+
#
|
606
|
+
# @example Response structure
|
607
|
+
#
|
608
|
+
# resp.id #=> String
|
609
|
+
# resp.name #=> String
|
610
|
+
# resp.arn #=> String
|
611
|
+
# resp.description #=> String
|
612
|
+
# resp.parameters.influx_d_bv_2.flux_log_enabled #=> Boolean
|
613
|
+
# resp.parameters.influx_d_bv_2.log_level #=> String, one of "debug", "info", "error"
|
614
|
+
# resp.parameters.influx_d_bv_2.no_tasks #=> Boolean
|
615
|
+
# resp.parameters.influx_d_bv_2.query_concurrency #=> Integer
|
616
|
+
# resp.parameters.influx_d_bv_2.query_queue_size #=> Integer
|
617
|
+
# resp.parameters.influx_d_bv_2.tracing_type #=> String, one of "log", "jaeger"
|
618
|
+
# resp.parameters.influx_d_bv_2.metrics_disabled #=> Boolean
|
619
|
+
#
|
620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/CreateDbParameterGroup AWS API Documentation
|
621
|
+
#
|
622
|
+
# @overload create_db_parameter_group(params = {})
|
623
|
+
# @param [Hash] params ({})
|
624
|
+
def create_db_parameter_group(params = {}, options = {})
|
625
|
+
req = build_request(:create_db_parameter_group, params)
|
626
|
+
req.send_request(options)
|
627
|
+
end
|
628
|
+
|
629
|
+
# Deletes a Timestream for InfluxDB DB instance.
|
630
|
+
#
|
631
|
+
# @option params [required, String] :identifier
|
632
|
+
# The id of the DB instance.
|
633
|
+
#
|
634
|
+
# @return [Types::DeleteDbInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
635
|
+
#
|
636
|
+
# * {Types::DeleteDbInstanceOutput#id #id} => String
|
637
|
+
# * {Types::DeleteDbInstanceOutput#name #name} => String
|
638
|
+
# * {Types::DeleteDbInstanceOutput#arn #arn} => String
|
639
|
+
# * {Types::DeleteDbInstanceOutput#status #status} => String
|
640
|
+
# * {Types::DeleteDbInstanceOutput#endpoint #endpoint} => String
|
641
|
+
# * {Types::DeleteDbInstanceOutput#db_instance_type #db_instance_type} => String
|
642
|
+
# * {Types::DeleteDbInstanceOutput#db_storage_type #db_storage_type} => String
|
643
|
+
# * {Types::DeleteDbInstanceOutput#allocated_storage #allocated_storage} => Integer
|
644
|
+
# * {Types::DeleteDbInstanceOutput#deployment_type #deployment_type} => String
|
645
|
+
# * {Types::DeleteDbInstanceOutput#vpc_subnet_ids #vpc_subnet_ids} => Array<String>
|
646
|
+
# * {Types::DeleteDbInstanceOutput#publicly_accessible #publicly_accessible} => Boolean
|
647
|
+
# * {Types::DeleteDbInstanceOutput#vpc_security_group_ids #vpc_security_group_ids} => Array<String>
|
648
|
+
# * {Types::DeleteDbInstanceOutput#db_parameter_group_identifier #db_parameter_group_identifier} => String
|
649
|
+
# * {Types::DeleteDbInstanceOutput#availability_zone #availability_zone} => String
|
650
|
+
# * {Types::DeleteDbInstanceOutput#secondary_availability_zone #secondary_availability_zone} => String
|
651
|
+
# * {Types::DeleteDbInstanceOutput#log_delivery_configuration #log_delivery_configuration} => Types::LogDeliveryConfiguration
|
652
|
+
# * {Types::DeleteDbInstanceOutput#influx_auth_parameters_secret_arn #influx_auth_parameters_secret_arn} => String
|
653
|
+
#
|
654
|
+
# @example Request syntax with placeholder values
|
655
|
+
#
|
656
|
+
# resp = client.delete_db_instance({
|
657
|
+
# identifier: "DbInstanceIdentifier", # required
|
658
|
+
# })
|
659
|
+
#
|
660
|
+
# @example Response structure
|
661
|
+
#
|
662
|
+
# resp.id #=> String
|
663
|
+
# resp.name #=> String
|
664
|
+
# resp.arn #=> String
|
665
|
+
# resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "MODIFYING", "UPDATING", "DELETED", "FAILED"
|
666
|
+
# resp.endpoint #=> String
|
667
|
+
# 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"
|
668
|
+
# resp.db_storage_type #=> String, one of "InfluxIOIncludedT1", "InfluxIOIncludedT2", "InfluxIOIncludedT3"
|
669
|
+
# resp.allocated_storage #=> Integer
|
670
|
+
# resp.deployment_type #=> String, one of "SINGLE_AZ", "WITH_MULTIAZ_STANDBY"
|
671
|
+
# resp.vpc_subnet_ids #=> Array
|
672
|
+
# resp.vpc_subnet_ids[0] #=> String
|
673
|
+
# resp.publicly_accessible #=> Boolean
|
674
|
+
# resp.vpc_security_group_ids #=> Array
|
675
|
+
# resp.vpc_security_group_ids[0] #=> String
|
676
|
+
# resp.db_parameter_group_identifier #=> String
|
677
|
+
# resp.availability_zone #=> String
|
678
|
+
# resp.secondary_availability_zone #=> String
|
679
|
+
# resp.log_delivery_configuration.s3_configuration.bucket_name #=> String
|
680
|
+
# resp.log_delivery_configuration.s3_configuration.enabled #=> Boolean
|
681
|
+
# resp.influx_auth_parameters_secret_arn #=> String
|
682
|
+
#
|
683
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/DeleteDbInstance AWS API Documentation
|
684
|
+
#
|
685
|
+
# @overload delete_db_instance(params = {})
|
686
|
+
# @param [Hash] params ({})
|
687
|
+
def delete_db_instance(params = {}, options = {})
|
688
|
+
req = build_request(:delete_db_instance, params)
|
689
|
+
req.send_request(options)
|
690
|
+
end
|
691
|
+
|
692
|
+
# Returns a Timestream for InfluxDB DB instance.
|
693
|
+
#
|
694
|
+
# @option params [required, String] :identifier
|
695
|
+
# The id of the DB instance.
|
696
|
+
#
|
697
|
+
# @return [Types::GetDbInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
698
|
+
#
|
699
|
+
# * {Types::GetDbInstanceOutput#id #id} => String
|
700
|
+
# * {Types::GetDbInstanceOutput#name #name} => String
|
701
|
+
# * {Types::GetDbInstanceOutput#arn #arn} => String
|
702
|
+
# * {Types::GetDbInstanceOutput#status #status} => String
|
703
|
+
# * {Types::GetDbInstanceOutput#endpoint #endpoint} => String
|
704
|
+
# * {Types::GetDbInstanceOutput#db_instance_type #db_instance_type} => String
|
705
|
+
# * {Types::GetDbInstanceOutput#db_storage_type #db_storage_type} => String
|
706
|
+
# * {Types::GetDbInstanceOutput#allocated_storage #allocated_storage} => Integer
|
707
|
+
# * {Types::GetDbInstanceOutput#deployment_type #deployment_type} => String
|
708
|
+
# * {Types::GetDbInstanceOutput#vpc_subnet_ids #vpc_subnet_ids} => Array<String>
|
709
|
+
# * {Types::GetDbInstanceOutput#publicly_accessible #publicly_accessible} => Boolean
|
710
|
+
# * {Types::GetDbInstanceOutput#vpc_security_group_ids #vpc_security_group_ids} => Array<String>
|
711
|
+
# * {Types::GetDbInstanceOutput#db_parameter_group_identifier #db_parameter_group_identifier} => String
|
712
|
+
# * {Types::GetDbInstanceOutput#availability_zone #availability_zone} => String
|
713
|
+
# * {Types::GetDbInstanceOutput#secondary_availability_zone #secondary_availability_zone} => String
|
714
|
+
# * {Types::GetDbInstanceOutput#log_delivery_configuration #log_delivery_configuration} => Types::LogDeliveryConfiguration
|
715
|
+
# * {Types::GetDbInstanceOutput#influx_auth_parameters_secret_arn #influx_auth_parameters_secret_arn} => String
|
716
|
+
#
|
717
|
+
# @example Request syntax with placeholder values
|
718
|
+
#
|
719
|
+
# resp = client.get_db_instance({
|
720
|
+
# identifier: "DbInstanceIdentifier", # required
|
721
|
+
# })
|
722
|
+
#
|
723
|
+
# @example Response structure
|
724
|
+
#
|
725
|
+
# resp.id #=> String
|
726
|
+
# resp.name #=> String
|
727
|
+
# resp.arn #=> String
|
728
|
+
# resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "MODIFYING", "UPDATING", "DELETED", "FAILED"
|
729
|
+
# resp.endpoint #=> String
|
730
|
+
# 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"
|
731
|
+
# resp.db_storage_type #=> String, one of "InfluxIOIncludedT1", "InfluxIOIncludedT2", "InfluxIOIncludedT3"
|
732
|
+
# resp.allocated_storage #=> Integer
|
733
|
+
# resp.deployment_type #=> String, one of "SINGLE_AZ", "WITH_MULTIAZ_STANDBY"
|
734
|
+
# resp.vpc_subnet_ids #=> Array
|
735
|
+
# resp.vpc_subnet_ids[0] #=> String
|
736
|
+
# resp.publicly_accessible #=> Boolean
|
737
|
+
# resp.vpc_security_group_ids #=> Array
|
738
|
+
# resp.vpc_security_group_ids[0] #=> String
|
739
|
+
# resp.db_parameter_group_identifier #=> String
|
740
|
+
# resp.availability_zone #=> String
|
741
|
+
# resp.secondary_availability_zone #=> String
|
742
|
+
# resp.log_delivery_configuration.s3_configuration.bucket_name #=> String
|
743
|
+
# resp.log_delivery_configuration.s3_configuration.enabled #=> Boolean
|
744
|
+
# resp.influx_auth_parameters_secret_arn #=> String
|
745
|
+
#
|
746
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbInstance AWS API Documentation
|
747
|
+
#
|
748
|
+
# @overload get_db_instance(params = {})
|
749
|
+
# @param [Hash] params ({})
|
750
|
+
def get_db_instance(params = {}, options = {})
|
751
|
+
req = build_request(:get_db_instance, params)
|
752
|
+
req.send_request(options)
|
753
|
+
end
|
754
|
+
|
755
|
+
# Returns a Timestream for InfluxDB DB parameter group.
|
756
|
+
#
|
757
|
+
# @option params [required, String] :identifier
|
758
|
+
# The id of the DB parameter group.
|
759
|
+
#
|
760
|
+
# @return [Types::GetDbParameterGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
761
|
+
#
|
762
|
+
# * {Types::GetDbParameterGroupOutput#id #id} => String
|
763
|
+
# * {Types::GetDbParameterGroupOutput#name #name} => String
|
764
|
+
# * {Types::GetDbParameterGroupOutput#arn #arn} => String
|
765
|
+
# * {Types::GetDbParameterGroupOutput#description #description} => String
|
766
|
+
# * {Types::GetDbParameterGroupOutput#parameters #parameters} => Types::Parameters
|
767
|
+
#
|
768
|
+
# @example Request syntax with placeholder values
|
769
|
+
#
|
770
|
+
# resp = client.get_db_parameter_group({
|
771
|
+
# identifier: "DbParameterGroupIdentifier", # required
|
772
|
+
# })
|
773
|
+
#
|
774
|
+
# @example Response structure
|
775
|
+
#
|
776
|
+
# resp.id #=> String
|
777
|
+
# resp.name #=> String
|
778
|
+
# resp.arn #=> String
|
779
|
+
# resp.description #=> String
|
780
|
+
# resp.parameters.influx_d_bv_2.flux_log_enabled #=> Boolean
|
781
|
+
# resp.parameters.influx_d_bv_2.log_level #=> String, one of "debug", "info", "error"
|
782
|
+
# resp.parameters.influx_d_bv_2.no_tasks #=> Boolean
|
783
|
+
# resp.parameters.influx_d_bv_2.query_concurrency #=> Integer
|
784
|
+
# resp.parameters.influx_d_bv_2.query_queue_size #=> Integer
|
785
|
+
# resp.parameters.influx_d_bv_2.tracing_type #=> String, one of "log", "jaeger"
|
786
|
+
# resp.parameters.influx_d_bv_2.metrics_disabled #=> Boolean
|
787
|
+
#
|
788
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbParameterGroup AWS API Documentation
|
789
|
+
#
|
790
|
+
# @overload get_db_parameter_group(params = {})
|
791
|
+
# @param [Hash] params ({})
|
792
|
+
def get_db_parameter_group(params = {}, options = {})
|
793
|
+
req = build_request(:get_db_parameter_group, params)
|
794
|
+
req.send_request(options)
|
795
|
+
end
|
796
|
+
|
797
|
+
# Returns a list of Timestream for InfluxDB DB instances.
|
798
|
+
#
|
799
|
+
# @option params [String] :next_token
|
800
|
+
# The pagination token. To resume pagination, provide the NextToken
|
801
|
+
# value as argument of a subsequent API invocation.
|
802
|
+
#
|
803
|
+
# @option params [Integer] :max_results
|
804
|
+
# The maximum number of items to return in the output. If the total
|
805
|
+
# number of items available is more than the value specified, a
|
806
|
+
# NextToken is provided in the output. To resume pagination, provide the
|
807
|
+
# NextToken value as argument of a subsequent API invocation.
|
808
|
+
#
|
809
|
+
# @return [Types::ListDbInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
810
|
+
#
|
811
|
+
# * {Types::ListDbInstancesOutput#items #items} => Array<Types::DbInstanceSummary>
|
812
|
+
# * {Types::ListDbInstancesOutput#next_token #next_token} => String
|
813
|
+
#
|
814
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
815
|
+
#
|
816
|
+
# @example Request syntax with placeholder values
|
817
|
+
#
|
818
|
+
# resp = client.list_db_instances({
|
819
|
+
# next_token: "NextToken",
|
820
|
+
# max_results: 1,
|
821
|
+
# })
|
822
|
+
#
|
823
|
+
# @example Response structure
|
824
|
+
#
|
825
|
+
# resp.items #=> Array
|
826
|
+
# resp.items[0].id #=> String
|
827
|
+
# resp.items[0].name #=> String
|
828
|
+
# resp.items[0].arn #=> String
|
829
|
+
# resp.items[0].status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "MODIFYING", "UPDATING", "DELETED", "FAILED"
|
830
|
+
# resp.items[0].endpoint #=> String
|
831
|
+
# 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"
|
832
|
+
# resp.items[0].db_storage_type #=> String, one of "InfluxIOIncludedT1", "InfluxIOIncludedT2", "InfluxIOIncludedT3"
|
833
|
+
# resp.items[0].allocated_storage #=> Integer
|
834
|
+
# resp.items[0].deployment_type #=> String, one of "SINGLE_AZ", "WITH_MULTIAZ_STANDBY"
|
835
|
+
# resp.next_token #=> String
|
836
|
+
#
|
837
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbInstances AWS API Documentation
|
838
|
+
#
|
839
|
+
# @overload list_db_instances(params = {})
|
840
|
+
# @param [Hash] params ({})
|
841
|
+
def list_db_instances(params = {}, options = {})
|
842
|
+
req = build_request(:list_db_instances, params)
|
843
|
+
req.send_request(options)
|
844
|
+
end
|
845
|
+
|
846
|
+
# Returns a list of Timestream for InfluxDB DB parameter groups.
|
847
|
+
#
|
848
|
+
# @option params [String] :next_token
|
849
|
+
# The pagination token. To resume pagination, provide the NextToken
|
850
|
+
# value as argument of a subsequent API invocation.
|
851
|
+
#
|
852
|
+
# @option params [Integer] :max_results
|
853
|
+
# The maximum number of items to return in the output. If the total
|
854
|
+
# number of items available is more than the value specified, a
|
855
|
+
# NextToken is provided in the output. To resume pagination, provide the
|
856
|
+
# NextToken value as argument of a subsequent API invocation.
|
857
|
+
#
|
858
|
+
# @return [Types::ListDbParameterGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
859
|
+
#
|
860
|
+
# * {Types::ListDbParameterGroupsOutput#items #items} => Array<Types::DbParameterGroupSummary>
|
861
|
+
# * {Types::ListDbParameterGroupsOutput#next_token #next_token} => String
|
862
|
+
#
|
863
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
864
|
+
#
|
865
|
+
# @example Request syntax with placeholder values
|
866
|
+
#
|
867
|
+
# resp = client.list_db_parameter_groups({
|
868
|
+
# next_token: "NextToken",
|
869
|
+
# max_results: 1,
|
870
|
+
# })
|
871
|
+
#
|
872
|
+
# @example Response structure
|
873
|
+
#
|
874
|
+
# resp.items #=> Array
|
875
|
+
# resp.items[0].id #=> String
|
876
|
+
# resp.items[0].name #=> String
|
877
|
+
# resp.items[0].arn #=> String
|
878
|
+
# resp.items[0].description #=> String
|
879
|
+
# resp.next_token #=> String
|
880
|
+
#
|
881
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListDbParameterGroups AWS API Documentation
|
882
|
+
#
|
883
|
+
# @overload list_db_parameter_groups(params = {})
|
884
|
+
# @param [Hash] params ({})
|
885
|
+
def list_db_parameter_groups(params = {}, options = {})
|
886
|
+
req = build_request(:list_db_parameter_groups, params)
|
887
|
+
req.send_request(options)
|
888
|
+
end
|
889
|
+
|
890
|
+
# A list of tags applied to the resource.
|
891
|
+
#
|
892
|
+
# @option params [required, String] :resource_arn
|
893
|
+
# The Amazon Resource Name (ARN) of the tagged resource.
|
894
|
+
#
|
895
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
896
|
+
#
|
897
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
898
|
+
#
|
899
|
+
# @example Request syntax with placeholder values
|
900
|
+
#
|
901
|
+
# resp = client.list_tags_for_resource({
|
902
|
+
# resource_arn: "Arn", # required
|
903
|
+
# })
|
904
|
+
#
|
905
|
+
# @example Response structure
|
906
|
+
#
|
907
|
+
# resp.tags #=> Hash
|
908
|
+
# resp.tags["TagKey"] #=> String
|
909
|
+
#
|
910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/ListTagsForResource AWS API Documentation
|
911
|
+
#
|
912
|
+
# @overload list_tags_for_resource(params = {})
|
913
|
+
# @param [Hash] params ({})
|
914
|
+
def list_tags_for_resource(params = {}, options = {})
|
915
|
+
req = build_request(:list_tags_for_resource, params)
|
916
|
+
req.send_request(options)
|
917
|
+
end
|
918
|
+
|
919
|
+
# Tags are composed of a Key/Value pairs. You can use tags to categorize
|
920
|
+
# and track your Timestream for InfluxDB resources.
|
921
|
+
#
|
922
|
+
# @option params [required, String] :resource_arn
|
923
|
+
# The Amazon Resource Name (ARN) of the tagged resource.
|
924
|
+
#
|
925
|
+
# @option params [required, Hash<String,String>] :tags
|
926
|
+
# A list of tags used to categorize and track resources.
|
927
|
+
#
|
928
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
929
|
+
#
|
930
|
+
# @example Request syntax with placeholder values
|
931
|
+
#
|
932
|
+
# resp = client.tag_resource({
|
933
|
+
# resource_arn: "Arn", # required
|
934
|
+
# tags: { # required
|
935
|
+
# "TagKey" => "TagValue",
|
936
|
+
# },
|
937
|
+
# })
|
938
|
+
#
|
939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/TagResource AWS API Documentation
|
940
|
+
#
|
941
|
+
# @overload tag_resource(params = {})
|
942
|
+
# @param [Hash] params ({})
|
943
|
+
def tag_resource(params = {}, options = {})
|
944
|
+
req = build_request(:tag_resource, params)
|
945
|
+
req.send_request(options)
|
946
|
+
end
|
947
|
+
|
948
|
+
# Removes the tag from the specified resource.
|
949
|
+
#
|
950
|
+
# @option params [required, String] :resource_arn
|
951
|
+
# The Amazon Resource Name (ARN) of the tagged resource.
|
952
|
+
#
|
953
|
+
# @option params [required, Array<String>] :tag_keys
|
954
|
+
# The keys used to identify the tags.
|
955
|
+
#
|
956
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
957
|
+
#
|
958
|
+
# @example Request syntax with placeholder values
|
959
|
+
#
|
960
|
+
# resp = client.untag_resource({
|
961
|
+
# resource_arn: "Arn", # required
|
962
|
+
# tag_keys: ["TagKey"], # required
|
963
|
+
# })
|
964
|
+
#
|
965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/UntagResource AWS API Documentation
|
966
|
+
#
|
967
|
+
# @overload untag_resource(params = {})
|
968
|
+
# @param [Hash] params ({})
|
969
|
+
def untag_resource(params = {}, options = {})
|
970
|
+
req = build_request(:untag_resource, params)
|
971
|
+
req.send_request(options)
|
972
|
+
end
|
973
|
+
|
974
|
+
# Updates a Timestream for InfluxDB DB instance.
|
975
|
+
#
|
976
|
+
# @option params [required, String] :identifier
|
977
|
+
# The id of the DB instance.
|
978
|
+
#
|
979
|
+
# @option params [Types::LogDeliveryConfiguration] :log_delivery_configuration
|
980
|
+
# Configuration for sending InfluxDB engine logs to send to specified S3
|
981
|
+
# bucket.
|
982
|
+
#
|
983
|
+
# @option params [String] :db_parameter_group_identifier
|
984
|
+
# The id of the DB parameter group to assign to your DB instance. DB
|
985
|
+
# parameter groups specify how the database is configured. For example,
|
986
|
+
# DB parameter groups can specify the limit for query concurrency.
|
987
|
+
#
|
988
|
+
# @return [Types::UpdateDbInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
989
|
+
#
|
990
|
+
# * {Types::UpdateDbInstanceOutput#id #id} => String
|
991
|
+
# * {Types::UpdateDbInstanceOutput#name #name} => String
|
992
|
+
# * {Types::UpdateDbInstanceOutput#arn #arn} => String
|
993
|
+
# * {Types::UpdateDbInstanceOutput#status #status} => String
|
994
|
+
# * {Types::UpdateDbInstanceOutput#endpoint #endpoint} => String
|
995
|
+
# * {Types::UpdateDbInstanceOutput#db_instance_type #db_instance_type} => String
|
996
|
+
# * {Types::UpdateDbInstanceOutput#db_storage_type #db_storage_type} => String
|
997
|
+
# * {Types::UpdateDbInstanceOutput#allocated_storage #allocated_storage} => Integer
|
998
|
+
# * {Types::UpdateDbInstanceOutput#deployment_type #deployment_type} => String
|
999
|
+
# * {Types::UpdateDbInstanceOutput#vpc_subnet_ids #vpc_subnet_ids} => Array<String>
|
1000
|
+
# * {Types::UpdateDbInstanceOutput#publicly_accessible #publicly_accessible} => Boolean
|
1001
|
+
# * {Types::UpdateDbInstanceOutput#vpc_security_group_ids #vpc_security_group_ids} => Array<String>
|
1002
|
+
# * {Types::UpdateDbInstanceOutput#db_parameter_group_identifier #db_parameter_group_identifier} => String
|
1003
|
+
# * {Types::UpdateDbInstanceOutput#availability_zone #availability_zone} => String
|
1004
|
+
# * {Types::UpdateDbInstanceOutput#secondary_availability_zone #secondary_availability_zone} => String
|
1005
|
+
# * {Types::UpdateDbInstanceOutput#log_delivery_configuration #log_delivery_configuration} => Types::LogDeliveryConfiguration
|
1006
|
+
# * {Types::UpdateDbInstanceOutput#influx_auth_parameters_secret_arn #influx_auth_parameters_secret_arn} => String
|
1007
|
+
#
|
1008
|
+
# @example Request syntax with placeholder values
|
1009
|
+
#
|
1010
|
+
# resp = client.update_db_instance({
|
1011
|
+
# identifier: "DbInstanceIdentifier", # required
|
1012
|
+
# log_delivery_configuration: {
|
1013
|
+
# s3_configuration: { # required
|
1014
|
+
# bucket_name: "S3ConfigurationBucketNameString", # required
|
1015
|
+
# enabled: false, # required
|
1016
|
+
# },
|
1017
|
+
# },
|
1018
|
+
# db_parameter_group_identifier: "DbParameterGroupIdentifier",
|
1019
|
+
# })
|
1020
|
+
#
|
1021
|
+
# @example Response structure
|
1022
|
+
#
|
1023
|
+
# resp.id #=> String
|
1024
|
+
# resp.name #=> String
|
1025
|
+
# resp.arn #=> String
|
1026
|
+
# resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "MODIFYING", "UPDATING", "DELETED", "FAILED"
|
1027
|
+
# resp.endpoint #=> String
|
1028
|
+
# 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"
|
1029
|
+
# resp.db_storage_type #=> String, one of "InfluxIOIncludedT1", "InfluxIOIncludedT2", "InfluxIOIncludedT3"
|
1030
|
+
# resp.allocated_storage #=> Integer
|
1031
|
+
# resp.deployment_type #=> String, one of "SINGLE_AZ", "WITH_MULTIAZ_STANDBY"
|
1032
|
+
# resp.vpc_subnet_ids #=> Array
|
1033
|
+
# resp.vpc_subnet_ids[0] #=> String
|
1034
|
+
# resp.publicly_accessible #=> Boolean
|
1035
|
+
# resp.vpc_security_group_ids #=> Array
|
1036
|
+
# resp.vpc_security_group_ids[0] #=> String
|
1037
|
+
# resp.db_parameter_group_identifier #=> String
|
1038
|
+
# resp.availability_zone #=> String
|
1039
|
+
# resp.secondary_availability_zone #=> String
|
1040
|
+
# resp.log_delivery_configuration.s3_configuration.bucket_name #=> String
|
1041
|
+
# resp.log_delivery_configuration.s3_configuration.enabled #=> Boolean
|
1042
|
+
# resp.influx_auth_parameters_secret_arn #=> String
|
1043
|
+
#
|
1044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/UpdateDbInstance AWS API Documentation
|
1045
|
+
#
|
1046
|
+
# @overload update_db_instance(params = {})
|
1047
|
+
# @param [Hash] params ({})
|
1048
|
+
def update_db_instance(params = {}, options = {})
|
1049
|
+
req = build_request(:update_db_instance, params)
|
1050
|
+
req.send_request(options)
|
1051
|
+
end
|
1052
|
+
|
1053
|
+
# @!endgroup
|
1054
|
+
|
1055
|
+
# @param params ({})
|
1056
|
+
# @api private
|
1057
|
+
def build_request(operation_name, params = {})
|
1058
|
+
handlers = @handlers.for(operation_name)
|
1059
|
+
context = Seahorse::Client::RequestContext.new(
|
1060
|
+
operation_name: operation_name,
|
1061
|
+
operation: config.api.operation(operation_name),
|
1062
|
+
client: self,
|
1063
|
+
params: params,
|
1064
|
+
config: config)
|
1065
|
+
context[:gem_name] = 'aws-sdk-timestreaminfluxdb'
|
1066
|
+
context[:gem_version] = '1.0.0'
|
1067
|
+
Seahorse::Client::Request.new(handlers, context)
|
1068
|
+
end
|
1069
|
+
|
1070
|
+
# @api private
|
1071
|
+
# @deprecated
|
1072
|
+
def waiter_names
|
1073
|
+
[]
|
1074
|
+
end
|
1075
|
+
|
1076
|
+
class << self
|
1077
|
+
|
1078
|
+
# @api private
|
1079
|
+
attr_reader :identifier
|
1080
|
+
|
1081
|
+
# @api private
|
1082
|
+
def errors_module
|
1083
|
+
Errors
|
1084
|
+
end
|
1085
|
+
|
1086
|
+
end
|
1087
|
+
end
|
1088
|
+
end
|