aws-sdk-finspace 1.14.0 → 1.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-finspace/client.rb +1671 -67
- data/lib/aws-sdk-finspace/client_api.rb +1062 -4
- data/lib/aws-sdk-finspace/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-finspace/endpoints.rb +364 -0
- data/lib/aws-sdk-finspace/errors.rb +37 -0
- data/lib/aws-sdk-finspace/plugins/endpoints.rb +52 -0
- data/lib/aws-sdk-finspace/types.rb +2869 -119
- data/lib/aws-sdk-finspace.rb +1 -1
- metadata +2 -2
@@ -16,6 +16,180 @@ module Aws::Finspace
|
|
16
16
|
#
|
17
17
|
class AccessDeniedException < Aws::EmptyStructure; end
|
18
18
|
|
19
|
+
# The configuration based on which FinSpace will scale in or scale out
|
20
|
+
# nodes in your cluster.
|
21
|
+
#
|
22
|
+
# @!attribute [rw] min_node_count
|
23
|
+
# The lowest number of nodes to scale. This value must be at least 1
|
24
|
+
# and less than the `maxNodeCount`. If the nodes in a cluster belong
|
25
|
+
# to multiple availability zones, then `minNodeCount` must be at least
|
26
|
+
# 3.
|
27
|
+
# @return [Integer]
|
28
|
+
#
|
29
|
+
# @!attribute [rw] max_node_count
|
30
|
+
# The highest number of nodes to scale. This value cannot be greater
|
31
|
+
# than 5.
|
32
|
+
# @return [Integer]
|
33
|
+
#
|
34
|
+
# @!attribute [rw] auto_scaling_metric
|
35
|
+
# The metric your cluster will track in order to scale in and out. For
|
36
|
+
# example, `CPU_UTILIZATION_PERCENTAGE` is the average CPU usage
|
37
|
+
# across all the nodes in a cluster.
|
38
|
+
# @return [String]
|
39
|
+
#
|
40
|
+
# @!attribute [rw] metric_target
|
41
|
+
# The desired value of the chosen `autoScalingMetric`. When the metric
|
42
|
+
# drops below this value, the cluster will scale in. When the metric
|
43
|
+
# goes above this value, the cluster will scale out. You can set the
|
44
|
+
# target value between 1 and 100 percent.
|
45
|
+
# @return [Float]
|
46
|
+
#
|
47
|
+
# @!attribute [rw] scale_in_cooldown_seconds
|
48
|
+
# The duration in seconds that FinSpace will wait after a scale in
|
49
|
+
# event before initiating another scaling event.
|
50
|
+
# @return [Float]
|
51
|
+
#
|
52
|
+
# @!attribute [rw] scale_out_cooldown_seconds
|
53
|
+
# The duration in seconds that FinSpace will wait after a scale out
|
54
|
+
# event before initiating another scaling event.
|
55
|
+
# @return [Float]
|
56
|
+
#
|
57
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/AutoScalingConfiguration AWS API Documentation
|
58
|
+
#
|
59
|
+
class AutoScalingConfiguration < Struct.new(
|
60
|
+
:min_node_count,
|
61
|
+
:max_node_count,
|
62
|
+
:auto_scaling_metric,
|
63
|
+
:metric_target,
|
64
|
+
:scale_in_cooldown_seconds,
|
65
|
+
:scale_out_cooldown_seconds)
|
66
|
+
SENSITIVE = []
|
67
|
+
include Aws::Structure
|
68
|
+
end
|
69
|
+
|
70
|
+
# A structure for the metadata of a cluster. It includes information
|
71
|
+
# like the CPUs needed, memory of instances, number of instances, and
|
72
|
+
# the port used while establishing a connection.
|
73
|
+
#
|
74
|
+
# @!attribute [rw] node_type
|
75
|
+
# The type that determines the hardware of the host computer used for
|
76
|
+
# your cluster instance. Each node type offers different memory and
|
77
|
+
# storage capabilities. Choose a node type based on the requirements
|
78
|
+
# of the application or software that you plan to run on your
|
79
|
+
# instance.
|
80
|
+
#
|
81
|
+
# You can only specify one of the following values:
|
82
|
+
#
|
83
|
+
# * `kx.s.large` – The node type with a configuration of 12 GiB memory
|
84
|
+
# and 2 vCPUs.
|
85
|
+
#
|
86
|
+
# * `kx.s.xlarge` – The node type with a configuration of 27 GiB
|
87
|
+
# memory and 4 vCPUs.
|
88
|
+
#
|
89
|
+
# * `kx.s.2xlarge` – The node type with a configuration of 54 GiB
|
90
|
+
# memory and 8 vCPUs.
|
91
|
+
#
|
92
|
+
# * `kx.s.4xlarge` – The node type with a configuration of 108 GiB
|
93
|
+
# memory and 16 vCPUs.
|
94
|
+
#
|
95
|
+
# * `kx.s.8xlarge` – The node type with a configuration of 216 GiB
|
96
|
+
# memory and 32 vCPUs.
|
97
|
+
#
|
98
|
+
# * `kx.s.16xlarge` – The node type with a configuration of 432 GiB
|
99
|
+
# memory and 64 vCPUs.
|
100
|
+
#
|
101
|
+
# * `kx.s.32xlarge` – The node type with a configuration of 864 GiB
|
102
|
+
# memory and 128 vCPUs.
|
103
|
+
# @return [String]
|
104
|
+
#
|
105
|
+
# @!attribute [rw] node_count
|
106
|
+
# The number of instances running in a cluster.
|
107
|
+
# @return [Integer]
|
108
|
+
#
|
109
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CapacityConfiguration AWS API Documentation
|
110
|
+
#
|
111
|
+
class CapacityConfiguration < Struct.new(
|
112
|
+
:node_type,
|
113
|
+
:node_count)
|
114
|
+
SENSITIVE = []
|
115
|
+
include Aws::Structure
|
116
|
+
end
|
117
|
+
|
118
|
+
# A list of change request objects.
|
119
|
+
#
|
120
|
+
# @!attribute [rw] change_type
|
121
|
+
# Defines the type of change request. A `changeType` can have the
|
122
|
+
# following values:
|
123
|
+
#
|
124
|
+
# * PUT – Adds or updates files in a database.
|
125
|
+
#
|
126
|
+
# * DELETE – Deletes files in a database.
|
127
|
+
# @return [String]
|
128
|
+
#
|
129
|
+
# @!attribute [rw] s3_path
|
130
|
+
# Defines the S3 path of the source file that is required to add or
|
131
|
+
# update files in a database.
|
132
|
+
# @return [String]
|
133
|
+
#
|
134
|
+
# @!attribute [rw] db_path
|
135
|
+
# Defines the path within the database directory.
|
136
|
+
# @return [String]
|
137
|
+
#
|
138
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ChangeRequest AWS API Documentation
|
139
|
+
#
|
140
|
+
class ChangeRequest < Struct.new(
|
141
|
+
:change_type,
|
142
|
+
:s3_path,
|
143
|
+
:db_path)
|
144
|
+
SENSITIVE = []
|
145
|
+
include Aws::Structure
|
146
|
+
end
|
147
|
+
|
148
|
+
# The structure of the customer code available within the running
|
149
|
+
# cluster.
|
150
|
+
#
|
151
|
+
# @!attribute [rw] s3_bucket
|
152
|
+
# A unique name for the S3 bucket.
|
153
|
+
# @return [String]
|
154
|
+
#
|
155
|
+
# @!attribute [rw] s3_key
|
156
|
+
# The full S3 path (excluding bucket) to the .zip file. This file
|
157
|
+
# contains the code that is loaded onto the cluster when it's
|
158
|
+
# started.
|
159
|
+
# @return [String]
|
160
|
+
#
|
161
|
+
# @!attribute [rw] s3_object_version
|
162
|
+
# The version of an S3 object.
|
163
|
+
# @return [String]
|
164
|
+
#
|
165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CodeConfiguration AWS API Documentation
|
166
|
+
#
|
167
|
+
class CodeConfiguration < Struct.new(
|
168
|
+
:s3_bucket,
|
169
|
+
:s3_key,
|
170
|
+
:s3_object_version)
|
171
|
+
SENSITIVE = []
|
172
|
+
include Aws::Structure
|
173
|
+
end
|
174
|
+
|
175
|
+
# There was a conflict with this action, and it could not be completed.
|
176
|
+
#
|
177
|
+
# @!attribute [rw] message
|
178
|
+
# @return [String]
|
179
|
+
#
|
180
|
+
# @!attribute [rw] reason
|
181
|
+
# The reason for the conflict exception.
|
182
|
+
# @return [String]
|
183
|
+
#
|
184
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ConflictException AWS API Documentation
|
185
|
+
#
|
186
|
+
class ConflictException < Struct.new(
|
187
|
+
:message,
|
188
|
+
:reason)
|
189
|
+
SENSITIVE = []
|
190
|
+
include Aws::Structure
|
191
|
+
end
|
192
|
+
|
19
193
|
# @!attribute [rw] name
|
20
194
|
# The name of the FinSpace environment to be created.
|
21
195
|
# @return [String]
|
@@ -88,7 +262,7 @@ module Aws::Finspace
|
|
88
262
|
# @return [String]
|
89
263
|
#
|
90
264
|
# @!attribute [rw] environment_url
|
91
|
-
# The sign-in
|
265
|
+
# The sign-in URL for the web application of the FinSpace environment
|
92
266
|
# you created.
|
93
267
|
# @return [String]
|
94
268
|
#
|
@@ -103,189 +277,2043 @@ module Aws::Finspace
|
|
103
277
|
end
|
104
278
|
|
105
279
|
# @!attribute [rw] environment_id
|
106
|
-
#
|
280
|
+
# A unique identifier of the kdb environment.
|
107
281
|
# @return [String]
|
108
282
|
#
|
109
|
-
#
|
283
|
+
# @!attribute [rw] database_name
|
284
|
+
# The name of the kdb database.
|
285
|
+
# @return [String]
|
110
286
|
#
|
111
|
-
|
112
|
-
|
287
|
+
# @!attribute [rw] change_requests
|
288
|
+
# A list of change request objects that are run in order. A change
|
289
|
+
# request object consists of changeType , s3Path, and a dbPath. A
|
290
|
+
# changeType can has the following values:
|
291
|
+
#
|
292
|
+
# * PUT – Adds or updates files in a database.
|
293
|
+
#
|
294
|
+
# * DELETE – Deletes files in a database.
|
295
|
+
#
|
296
|
+
# All the change requests require a mandatory *dbPath* attribute that
|
297
|
+
# defines the path within the database directory. The *s3Path*
|
298
|
+
# attribute defines the s3 source file path and is required for a PUT
|
299
|
+
# change type.
|
300
|
+
#
|
301
|
+
# Here is an example of how you can use the change request object:
|
302
|
+
#
|
303
|
+
# `[ \{ "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/",
|
304
|
+
# "dbPath":"/2020.01.02/"\}, \{ "changeType": "PUT",
|
305
|
+
# "s3Path":"s3://bucket/db/sym", "dbPath":"/"\}, \{ "changeType":
|
306
|
+
# "DELETE", "dbPath": "/2020.01.01/"\} ]`
|
307
|
+
#
|
308
|
+
# In this example, the first request with *PUT* change type allows you
|
309
|
+
# to add files in the given s3Path under the *2020.01.02* partition of
|
310
|
+
# the database. The second request with *PUT* change type allows you
|
311
|
+
# to add a single sym file at database root location. The last request
|
312
|
+
# with *DELETE* change type allows you to delete the files under the
|
313
|
+
# *2020.01.01* partition of the database.
|
314
|
+
# @return [Array<Types::ChangeRequest>]
|
315
|
+
#
|
316
|
+
# @!attribute [rw] client_token
|
317
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
318
|
+
#
|
319
|
+
# **A suitable default value is auto-generated.** You should normally
|
320
|
+
# not need to pass this option.
|
321
|
+
# @return [String]
|
322
|
+
#
|
323
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxChangesetRequest AWS API Documentation
|
324
|
+
#
|
325
|
+
class CreateKxChangesetRequest < Struct.new(
|
326
|
+
:environment_id,
|
327
|
+
:database_name,
|
328
|
+
:change_requests,
|
329
|
+
:client_token)
|
113
330
|
SENSITIVE = []
|
114
331
|
include Aws::Structure
|
115
332
|
end
|
116
333
|
|
117
|
-
#
|
334
|
+
# @!attribute [rw] changeset_id
|
335
|
+
# A unique identifier for the changeset.
|
336
|
+
# @return [String]
|
118
337
|
#
|
119
|
-
|
338
|
+
# @!attribute [rw] database_name
|
339
|
+
# The name of the kdb database.
|
340
|
+
# @return [String]
|
341
|
+
#
|
342
|
+
# @!attribute [rw] environment_id
|
343
|
+
# A unique identifier for the kdb environment.
|
344
|
+
# @return [String]
|
345
|
+
#
|
346
|
+
# @!attribute [rw] change_requests
|
347
|
+
# A list of change requests.
|
348
|
+
# @return [Array<Types::ChangeRequest>]
|
349
|
+
#
|
350
|
+
# @!attribute [rw] created_timestamp
|
351
|
+
# The timestamp at which the changeset was created in FinSpace. The
|
352
|
+
# value is determined as epoch time in milliseconds. For example, the
|
353
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
354
|
+
# 1635768000000.
|
355
|
+
# @return [Time]
|
356
|
+
#
|
357
|
+
# @!attribute [rw] last_modified_timestamp
|
358
|
+
# The timestamp at which the changeset was updated in FinSpace. The
|
359
|
+
# value is determined as epoch time in milliseconds. For example, the
|
360
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
361
|
+
# 1635768000000.
|
362
|
+
# @return [Time]
|
363
|
+
#
|
364
|
+
# @!attribute [rw] status
|
365
|
+
# Status of the changeset creation process.
|
366
|
+
#
|
367
|
+
# * Pending – Changeset creation is pending.
|
368
|
+
#
|
369
|
+
# * Processing – Changeset creation is running.
|
370
|
+
#
|
371
|
+
# * Failed – Changeset creation has failed.
|
372
|
+
#
|
373
|
+
# * Complete – Changeset creation has succeeded.
|
374
|
+
# @return [String]
|
375
|
+
#
|
376
|
+
# @!attribute [rw] error_info
|
377
|
+
# The details of the error that you receive when creating a changeset.
|
378
|
+
# It consists of the type of error and the error message.
|
379
|
+
# @return [Types::ErrorInfo]
|
380
|
+
#
|
381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxChangesetResponse AWS API Documentation
|
382
|
+
#
|
383
|
+
class CreateKxChangesetResponse < Struct.new(
|
384
|
+
:changeset_id,
|
385
|
+
:database_name,
|
386
|
+
:environment_id,
|
387
|
+
:change_requests,
|
388
|
+
:created_timestamp,
|
389
|
+
:last_modified_timestamp,
|
390
|
+
:status,
|
391
|
+
:error_info)
|
392
|
+
SENSITIVE = []
|
393
|
+
include Aws::Structure
|
394
|
+
end
|
120
395
|
|
121
|
-
#
|
396
|
+
# @!attribute [rw] client_token
|
397
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
122
398
|
#
|
123
|
-
#
|
124
|
-
#
|
399
|
+
# **A suitable default value is auto-generated.** You should normally
|
400
|
+
# not need to pass this option.
|
125
401
|
# @return [String]
|
126
402
|
#
|
127
403
|
# @!attribute [rw] environment_id
|
128
|
-
#
|
404
|
+
# A unique identifier for the kdb environment.
|
129
405
|
# @return [String]
|
130
406
|
#
|
131
|
-
# @!attribute [rw]
|
132
|
-
#
|
133
|
-
# created.
|
407
|
+
# @!attribute [rw] cluster_name
|
408
|
+
# A unique name for the cluster that you want to create.
|
134
409
|
# @return [String]
|
135
410
|
#
|
136
|
-
# @!attribute [rw]
|
137
|
-
#
|
411
|
+
# @!attribute [rw] cluster_type
|
412
|
+
# Specifies the type of KDB database that is being created. The
|
413
|
+
# following types are available:
|
414
|
+
#
|
415
|
+
# * HDB – A Historical Database. The data is only accessible with
|
416
|
+
# read-only permissions from one of the FinSpace managed kdb
|
417
|
+
# databases mounted to the cluster.
|
418
|
+
#
|
419
|
+
# * RDB – A Realtime Database. This type of database captures all the
|
420
|
+
# data from a ticker plant and stores it in memory until the end of
|
421
|
+
# day, after which it writes all of its data to a disk and reloads
|
422
|
+
# the HDB. This cluster type requires local storage for temporary
|
423
|
+
# storage of data during the savedown process. If you specify this
|
424
|
+
# field in your request, you must provide the
|
425
|
+
# `savedownStorageConfiguration` parameter.
|
426
|
+
#
|
427
|
+
# * GATEWAY – A gateway cluster allows you to access data across
|
428
|
+
# processes in kdb systems. It allows you to create your own routing
|
429
|
+
# logic using the initialization scripts and custom code. This type
|
430
|
+
# of cluster does not require a writable local storage.
|
138
431
|
# @return [String]
|
139
432
|
#
|
140
|
-
# @!attribute [rw]
|
141
|
-
#
|
142
|
-
#
|
143
|
-
# @return [String]
|
433
|
+
# @!attribute [rw] databases
|
434
|
+
# A list of databases that will be available for querying.
|
435
|
+
# @return [Array<Types::KxDatabaseConfiguration>]
|
144
436
|
#
|
145
|
-
# @!attribute [rw]
|
146
|
-
# The
|
437
|
+
# @!attribute [rw] cache_storage_configurations
|
438
|
+
# The configurations for a read only cache storage associated with a
|
439
|
+
# cluster. This cache will be stored as an FSx Lustre that reads from
|
440
|
+
# the S3 store.
|
441
|
+
# @return [Array<Types::KxCacheStorageConfiguration>]
|
442
|
+
#
|
443
|
+
# @!attribute [rw] auto_scaling_configuration
|
444
|
+
# The configuration based on which FinSpace will scale in or scale out
|
445
|
+
# nodes in your cluster.
|
446
|
+
# @return [Types::AutoScalingConfiguration]
|
447
|
+
#
|
448
|
+
# @!attribute [rw] cluster_description
|
449
|
+
# A description of the cluster.
|
147
450
|
# @return [String]
|
148
451
|
#
|
149
|
-
# @!attribute [rw]
|
150
|
-
#
|
452
|
+
# @!attribute [rw] capacity_configuration
|
453
|
+
# A structure for the metadata of a cluster. It includes information
|
454
|
+
# about like the CPUs needed, memory of instances, number of
|
455
|
+
# instances, and the port used while establishing a connection.
|
456
|
+
# @return [Types::CapacityConfiguration]
|
457
|
+
#
|
458
|
+
# @!attribute [rw] release_label
|
459
|
+
# The version of FinSpace managed kdb to run.
|
151
460
|
# @return [String]
|
152
461
|
#
|
153
|
-
# @!attribute [rw]
|
154
|
-
#
|
155
|
-
#
|
462
|
+
# @!attribute [rw] vpc_configuration
|
463
|
+
# Configuration details about the network where the Privatelink
|
464
|
+
# endpoint of the cluster resides.
|
465
|
+
# @return [Types::VpcConfiguration]
|
466
|
+
#
|
467
|
+
# @!attribute [rw] initialization_script
|
468
|
+
# Specifies a Q program that will be run at launch of a cluster. It is
|
469
|
+
# a relative path within *.zip* file that contains the custom code,
|
470
|
+
# which will be loaded on the cluster. It must include the file name
|
471
|
+
# itself. For example, `somedir/init.q`.
|
156
472
|
# @return [String]
|
157
473
|
#
|
158
|
-
# @!attribute [rw]
|
159
|
-
#
|
474
|
+
# @!attribute [rw] command_line_arguments
|
475
|
+
# Defines the key-value pairs to make them available inside the
|
476
|
+
# cluster.
|
477
|
+
# @return [Array<Types::KxCommandLineArgument>]
|
478
|
+
#
|
479
|
+
# @!attribute [rw] code
|
480
|
+
# The details of the custom code that you want to use inside a cluster
|
481
|
+
# when analyzing a data. It consists of the S3 source bucket,
|
482
|
+
# location, S3 object version, and the relative path from where the
|
483
|
+
# custom code is loaded into the cluster.
|
484
|
+
# @return [Types::CodeConfiguration]
|
485
|
+
#
|
486
|
+
# @!attribute [rw] execution_role
|
487
|
+
# An IAM role that defines a set of permissions associated with a
|
488
|
+
# cluster. These permissions are assumed when a cluster attempts to
|
489
|
+
# access another cluster.
|
160
490
|
# @return [String]
|
161
491
|
#
|
162
|
-
# @!attribute [rw]
|
163
|
-
# The
|
164
|
-
#
|
492
|
+
# @!attribute [rw] savedown_storage_configuration
|
493
|
+
# The size and type of the temporary storage that is used to hold data
|
494
|
+
# during the savedown process. This parameter is required when you
|
495
|
+
# choose `clusterType` as RDB. All the data written to this storage
|
496
|
+
# space is lost when the cluster node is restarted.
|
497
|
+
# @return [Types::KxSavedownStorageConfiguration]
|
498
|
+
#
|
499
|
+
# @!attribute [rw] az_mode
|
500
|
+
# The number of availability zones you want to assign per cluster.
|
501
|
+
# This can be one of the following
|
502
|
+
#
|
503
|
+
# * `SINGLE` – Assigns one availability zone per cluster.
|
504
|
+
#
|
505
|
+
# * `MULTI` – Assigns all the availability zones per cluster.
|
165
506
|
# @return [String]
|
166
507
|
#
|
167
|
-
# @!attribute [rw]
|
168
|
-
# The
|
508
|
+
# @!attribute [rw] availability_zone_id
|
509
|
+
# The availability zone identifiers for the requested regions.
|
169
510
|
# @return [String]
|
170
511
|
#
|
171
|
-
# @!attribute [rw]
|
172
|
-
#
|
173
|
-
#
|
512
|
+
# @!attribute [rw] tags
|
513
|
+
# A list of key-value pairs to label the cluster. You can add up to 50
|
514
|
+
# tags to a cluster.
|
515
|
+
# @return [Hash<String,String>]
|
174
516
|
#
|
175
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/
|
517
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxClusterRequest AWS API Documentation
|
176
518
|
#
|
177
|
-
class
|
178
|
-
:
|
519
|
+
class CreateKxClusterRequest < Struct.new(
|
520
|
+
:client_token,
|
179
521
|
:environment_id,
|
180
|
-
:
|
181
|
-
:
|
182
|
-
:
|
183
|
-
:
|
184
|
-
:
|
185
|
-
:
|
186
|
-
:
|
187
|
-
:
|
188
|
-
:
|
189
|
-
:
|
522
|
+
:cluster_name,
|
523
|
+
:cluster_type,
|
524
|
+
:databases,
|
525
|
+
:cache_storage_configurations,
|
526
|
+
:auto_scaling_configuration,
|
527
|
+
:cluster_description,
|
528
|
+
:capacity_configuration,
|
529
|
+
:release_label,
|
530
|
+
:vpc_configuration,
|
531
|
+
:initialization_script,
|
532
|
+
:command_line_arguments,
|
533
|
+
:code,
|
534
|
+
:execution_role,
|
535
|
+
:savedown_storage_configuration,
|
536
|
+
:az_mode,
|
537
|
+
:availability_zone_id,
|
538
|
+
:tags)
|
190
539
|
SENSITIVE = []
|
191
540
|
include Aws::Structure
|
192
541
|
end
|
193
542
|
|
194
|
-
#
|
543
|
+
# @!attribute [rw] environment_id
|
544
|
+
# A unique identifier for the kdb environment.
|
545
|
+
# @return [String]
|
195
546
|
#
|
196
|
-
# @!attribute [rw]
|
197
|
-
#
|
547
|
+
# @!attribute [rw] status
|
548
|
+
# The status of cluster creation.
|
549
|
+
#
|
550
|
+
# * PENDING – The cluster is pending creation.
|
551
|
+
#
|
552
|
+
# * CREATING – The cluster creation process is in progress.
|
553
|
+
#
|
554
|
+
# * CREATE\_FAILED – The cluster creation process has failed.
|
555
|
+
#
|
556
|
+
# * RUNNING – The cluster creation process is running.
|
557
|
+
#
|
558
|
+
# * UPDATING – The cluster is in the process of being updated.
|
559
|
+
#
|
560
|
+
# * DELETING – The cluster is in the process of being deleted.
|
561
|
+
#
|
562
|
+
# * DELETED – The cluster has been deleted.
|
563
|
+
#
|
564
|
+
# * DELETE\_FAILED – The cluster failed to delete.
|
198
565
|
# @return [String]
|
199
566
|
#
|
200
|
-
# @!attribute [rw]
|
201
|
-
#
|
202
|
-
# provider (IdP).
|
567
|
+
# @!attribute [rw] status_reason
|
568
|
+
# The error message when a failed state occurs.
|
203
569
|
# @return [String]
|
204
570
|
#
|
205
|
-
# @!attribute [rw]
|
206
|
-
#
|
207
|
-
# compliant identity provider configuration (IdP).
|
571
|
+
# @!attribute [rw] cluster_name
|
572
|
+
# A unique name for the cluster.
|
208
573
|
# @return [String]
|
209
574
|
#
|
210
|
-
# @!attribute [rw]
|
211
|
-
#
|
212
|
-
#
|
575
|
+
# @!attribute [rw] cluster_type
|
576
|
+
# Specifies the type of KDB database that is being created. The
|
577
|
+
# following types are available:
|
578
|
+
#
|
579
|
+
# * HDB – A Historical Database. The data is only accessible with
|
580
|
+
# read-only permissions from one of the FinSpace managed kdb
|
581
|
+
# databases mounted to the cluster.
|
582
|
+
#
|
583
|
+
# * RDB – A Realtime Database. This type of database captures all the
|
584
|
+
# data from a ticker plant and stores it in memory until the end of
|
585
|
+
# day, after which it writes all of its data to a disk and reloads
|
586
|
+
# the HDB. This cluster type requires local storage for temporary
|
587
|
+
# storage of data during the savedown process. If you specify this
|
588
|
+
# field in your request, you must provide the
|
589
|
+
# `savedownStorageConfiguration` parameter.
|
590
|
+
#
|
591
|
+
# * GATEWAY – A gateway cluster allows you to access data across
|
592
|
+
# processes in kdb systems. It allows you to create your own routing
|
593
|
+
# logic using the initialization scripts and custom code. This type
|
594
|
+
# of cluster does not require a writable local storage.
|
213
595
|
# @return [String]
|
214
596
|
#
|
215
|
-
# @!attribute [rw]
|
216
|
-
#
|
597
|
+
# @!attribute [rw] databases
|
598
|
+
# A list of databases that will be available for querying.
|
599
|
+
# @return [Array<Types::KxDatabaseConfiguration>]
|
600
|
+
#
|
601
|
+
# @!attribute [rw] cache_storage_configurations
|
602
|
+
# The configurations for a read only cache storage associated with a
|
603
|
+
# cluster. This cache will be stored as an FSx Lustre that reads from
|
604
|
+
# the S3 store.
|
605
|
+
# @return [Array<Types::KxCacheStorageConfiguration>]
|
606
|
+
#
|
607
|
+
# @!attribute [rw] auto_scaling_configuration
|
608
|
+
# The configuration based on which FinSpace will scale in or scale out
|
609
|
+
# nodes in your cluster.
|
610
|
+
# @return [Types::AutoScalingConfiguration]
|
611
|
+
#
|
612
|
+
# @!attribute [rw] cluster_description
|
613
|
+
# A description of the cluster.
|
217
614
|
# @return [String]
|
218
615
|
#
|
219
|
-
# @!attribute [rw]
|
220
|
-
#
|
221
|
-
# the
|
222
|
-
#
|
223
|
-
#
|
224
|
-
# Please check your SAML 2.0 compliant identity provider (IdP)
|
225
|
-
# documentation for details.
|
226
|
-
# @return [Hash<String,String>]
|
616
|
+
# @!attribute [rw] capacity_configuration
|
617
|
+
# A structure for the metadata of a cluster. It includes information
|
618
|
+
# like the CPUs needed, memory of instances, number of instances, and
|
619
|
+
# the port used while establishing a connection.
|
620
|
+
# @return [Types::CapacityConfiguration]
|
227
621
|
#
|
228
|
-
#
|
622
|
+
# @!attribute [rw] release_label
|
623
|
+
# A version of the FinSpace managed kdb to run.
|
624
|
+
# @return [String]
|
229
625
|
#
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
626
|
+
# @!attribute [rw] vpc_configuration
|
627
|
+
# Configuration details about the network where the Privatelink
|
628
|
+
# endpoint of the cluster resides.
|
629
|
+
# @return [Types::VpcConfiguration]
|
630
|
+
#
|
631
|
+
# @!attribute [rw] initialization_script
|
632
|
+
# Specifies a Q program that will be run at launch of a cluster. It is
|
633
|
+
# a relative path within *.zip* file that contains the custom code,
|
634
|
+
# which will be loaded on the cluster. It must include the file name
|
635
|
+
# itself. For example, `somedir/init.q`.
|
636
|
+
# @return [String]
|
637
|
+
#
|
638
|
+
# @!attribute [rw] command_line_arguments
|
639
|
+
# Defines the key-value pairs to make them available inside the
|
640
|
+
# cluster.
|
641
|
+
# @return [Array<Types::KxCommandLineArgument>]
|
642
|
+
#
|
643
|
+
# @!attribute [rw] code
|
644
|
+
# The details of the custom code that you want to use inside a cluster
|
645
|
+
# when analyzing a data. It consists of the S3 source bucket,
|
646
|
+
# location, S3 object version, and the relative path from where the
|
647
|
+
# custom code is loaded into the cluster.
|
648
|
+
# @return [Types::CodeConfiguration]
|
649
|
+
#
|
650
|
+
# @!attribute [rw] execution_role
|
651
|
+
# An IAM role that defines a set of permissions associated with a
|
652
|
+
# cluster. These permissions are assumed when a cluster attempts to
|
653
|
+
# access another cluster.
|
654
|
+
# @return [String]
|
655
|
+
#
|
656
|
+
# @!attribute [rw] last_modified_timestamp
|
657
|
+
# The last time that the cluster was modified. The value is determined
|
658
|
+
# as epoch time in milliseconds. For example, the value for Monday,
|
659
|
+
# November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
|
660
|
+
# @return [Time]
|
661
|
+
#
|
662
|
+
# @!attribute [rw] savedown_storage_configuration
|
663
|
+
# The size and type of the temporary storage that is used to hold data
|
664
|
+
# during the savedown process. This parameter is required when you
|
665
|
+
# choose `clusterType` as RDB. All the data written to this storage
|
666
|
+
# space is lost when the cluster node is restarted.
|
667
|
+
# @return [Types::KxSavedownStorageConfiguration]
|
668
|
+
#
|
669
|
+
# @!attribute [rw] az_mode
|
670
|
+
# The number of availability zones you want to assign per cluster.
|
671
|
+
# This can be one of the following
|
672
|
+
#
|
673
|
+
# * `SINGLE` – Assigns one availability zone per cluster.
|
674
|
+
#
|
675
|
+
# * `MULTI` – Assigns all the availability zones per cluster.
|
676
|
+
# @return [String]
|
677
|
+
#
|
678
|
+
# @!attribute [rw] availability_zone_id
|
679
|
+
# The availability zone identifiers for the requested regions.
|
680
|
+
# @return [String]
|
681
|
+
#
|
682
|
+
# @!attribute [rw] created_timestamp
|
683
|
+
# The timestamp at which the cluster was created in FinSpace. The
|
684
|
+
# value is determined as epoch time in milliseconds. For example, the
|
685
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
686
|
+
# 1635768000000.
|
687
|
+
# @return [Time]
|
688
|
+
#
|
689
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxClusterResponse AWS API Documentation
|
690
|
+
#
|
691
|
+
class CreateKxClusterResponse < Struct.new(
|
692
|
+
:environment_id,
|
693
|
+
:status,
|
694
|
+
:status_reason,
|
695
|
+
:cluster_name,
|
696
|
+
:cluster_type,
|
697
|
+
:databases,
|
698
|
+
:cache_storage_configurations,
|
699
|
+
:auto_scaling_configuration,
|
700
|
+
:cluster_description,
|
701
|
+
:capacity_configuration,
|
702
|
+
:release_label,
|
703
|
+
:vpc_configuration,
|
704
|
+
:initialization_script,
|
705
|
+
:command_line_arguments,
|
706
|
+
:code,
|
707
|
+
:execution_role,
|
708
|
+
:last_modified_timestamp,
|
709
|
+
:savedown_storage_configuration,
|
710
|
+
:az_mode,
|
711
|
+
:availability_zone_id,
|
712
|
+
:created_timestamp)
|
237
713
|
SENSITIVE = []
|
238
714
|
include Aws::Structure
|
239
715
|
end
|
240
716
|
|
241
717
|
# @!attribute [rw] environment_id
|
242
|
-
#
|
718
|
+
# A unique identifier for the kdb environment.
|
243
719
|
# @return [String]
|
244
720
|
#
|
245
|
-
#
|
721
|
+
# @!attribute [rw] database_name
|
722
|
+
# The name of the kdb database.
|
723
|
+
# @return [String]
|
246
724
|
#
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
include Aws::Structure
|
251
|
-
end
|
252
|
-
|
253
|
-
# @!attribute [rw] environment
|
254
|
-
# The name of the FinSpace environment.
|
255
|
-
# @return [Types::Environment]
|
725
|
+
# @!attribute [rw] description
|
726
|
+
# A description of the database.
|
727
|
+
# @return [String]
|
256
728
|
#
|
257
|
-
#
|
729
|
+
# @!attribute [rw] tags
|
730
|
+
# A list of key-value pairs to label the kdb database. You can add up
|
731
|
+
# to 50 tags to your kdb database
|
732
|
+
# @return [Hash<String,String>]
|
258
733
|
#
|
259
|
-
|
260
|
-
|
261
|
-
SENSITIVE = []
|
262
|
-
include Aws::Structure
|
263
|
-
end
|
264
|
-
|
265
|
-
# The request processing has failed because of an unknown error,
|
266
|
-
# exception or failure.
|
734
|
+
# @!attribute [rw] client_token
|
735
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
267
736
|
#
|
268
|
-
#
|
737
|
+
# **A suitable default value is auto-generated.** You should normally
|
738
|
+
# not need to pass this option.
|
269
739
|
# @return [String]
|
270
740
|
#
|
271
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/
|
741
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxDatabaseRequest AWS API Documentation
|
272
742
|
#
|
273
|
-
class
|
274
|
-
:
|
743
|
+
class CreateKxDatabaseRequest < Struct.new(
|
744
|
+
:environment_id,
|
745
|
+
:database_name,
|
746
|
+
:description,
|
747
|
+
:tags,
|
748
|
+
:client_token)
|
275
749
|
SENSITIVE = []
|
276
750
|
include Aws::Structure
|
277
751
|
end
|
278
752
|
|
279
|
-
#
|
280
|
-
#
|
753
|
+
# @!attribute [rw] database_name
|
754
|
+
# The name of the kdb database.
|
755
|
+
# @return [String]
|
281
756
|
#
|
282
|
-
# @!attribute [rw]
|
757
|
+
# @!attribute [rw] database_arn
|
758
|
+
# The ARN identifier of the database.
|
759
|
+
# @return [String]
|
760
|
+
#
|
761
|
+
# @!attribute [rw] environment_id
|
762
|
+
# A unique identifier for the kdb environment.
|
763
|
+
# @return [String]
|
764
|
+
#
|
765
|
+
# @!attribute [rw] description
|
766
|
+
# A description of the database.
|
767
|
+
# @return [String]
|
768
|
+
#
|
769
|
+
# @!attribute [rw] created_timestamp
|
770
|
+
# The timestamp at which the database is created in FinSpace. The
|
771
|
+
# value is determined as epoch time in milliseconds. For example, the
|
772
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
773
|
+
# 1635768000000.
|
774
|
+
# @return [Time]
|
775
|
+
#
|
776
|
+
# @!attribute [rw] last_modified_timestamp
|
777
|
+
# The last time that the database was updated in FinSpace. The value
|
778
|
+
# is determined as epoch time in milliseconds. For example, the value
|
779
|
+
# for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
780
|
+
# 1635768000000.
|
781
|
+
# @return [Time]
|
782
|
+
#
|
783
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxDatabaseResponse AWS API Documentation
|
784
|
+
#
|
785
|
+
class CreateKxDatabaseResponse < Struct.new(
|
786
|
+
:database_name,
|
787
|
+
:database_arn,
|
788
|
+
:environment_id,
|
789
|
+
:description,
|
790
|
+
:created_timestamp,
|
791
|
+
:last_modified_timestamp)
|
792
|
+
SENSITIVE = []
|
793
|
+
include Aws::Structure
|
794
|
+
end
|
795
|
+
|
796
|
+
# @!attribute [rw] name
|
797
|
+
# The name of the kdb environment that you want to create.
|
798
|
+
# @return [String]
|
799
|
+
#
|
800
|
+
# @!attribute [rw] description
|
801
|
+
# A description for the kdb environment.
|
802
|
+
# @return [String]
|
803
|
+
#
|
804
|
+
# @!attribute [rw] kms_key_id
|
805
|
+
# The KMS key ID to encrypt your data in the FinSpace environment.
|
806
|
+
# @return [String]
|
807
|
+
#
|
808
|
+
# @!attribute [rw] tags
|
809
|
+
# A list of key-value pairs to label the kdb environment. You can add
|
810
|
+
# up to 50 tags to your kdb environment.
|
811
|
+
# @return [Hash<String,String>]
|
812
|
+
#
|
813
|
+
# @!attribute [rw] client_token
|
814
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
815
|
+
# @return [String]
|
816
|
+
#
|
817
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxEnvironmentRequest AWS API Documentation
|
818
|
+
#
|
819
|
+
class CreateKxEnvironmentRequest < Struct.new(
|
820
|
+
:name,
|
821
|
+
:description,
|
822
|
+
:kms_key_id,
|
823
|
+
:tags,
|
824
|
+
:client_token)
|
825
|
+
SENSITIVE = []
|
826
|
+
include Aws::Structure
|
827
|
+
end
|
828
|
+
|
829
|
+
# @!attribute [rw] name
|
830
|
+
# The name of the kdb environment.
|
831
|
+
# @return [String]
|
832
|
+
#
|
833
|
+
# @!attribute [rw] status
|
834
|
+
# The status of the kdb environment.
|
835
|
+
# @return [String]
|
836
|
+
#
|
837
|
+
# @!attribute [rw] environment_id
|
838
|
+
# A unique identifier for the kdb environment.
|
839
|
+
# @return [String]
|
840
|
+
#
|
841
|
+
# @!attribute [rw] description
|
842
|
+
# A description for the kdb environment.
|
843
|
+
# @return [String]
|
844
|
+
#
|
845
|
+
# @!attribute [rw] environment_arn
|
846
|
+
# The ARN identifier of the environment.
|
847
|
+
# @return [String]
|
848
|
+
#
|
849
|
+
# @!attribute [rw] kms_key_id
|
850
|
+
# The KMS key ID to encrypt your data in the FinSpace environment.
|
851
|
+
# @return [String]
|
852
|
+
#
|
853
|
+
# @!attribute [rw] creation_timestamp
|
854
|
+
# The timestamp at which the kdb environment was created in FinSpace.
|
855
|
+
# @return [Time]
|
856
|
+
#
|
857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxEnvironmentResponse AWS API Documentation
|
858
|
+
#
|
859
|
+
class CreateKxEnvironmentResponse < Struct.new(
|
860
|
+
:name,
|
861
|
+
:status,
|
862
|
+
:environment_id,
|
863
|
+
:description,
|
864
|
+
:environment_arn,
|
865
|
+
:kms_key_id,
|
866
|
+
:creation_timestamp)
|
867
|
+
SENSITIVE = []
|
868
|
+
include Aws::Structure
|
869
|
+
end
|
870
|
+
|
871
|
+
# @!attribute [rw] environment_id
|
872
|
+
# A unique identifier for the kdb environment where you want to create
|
873
|
+
# a user.
|
874
|
+
# @return [String]
|
875
|
+
#
|
876
|
+
# @!attribute [rw] user_name
|
877
|
+
# A unique identifier for the user.
|
878
|
+
# @return [String]
|
879
|
+
#
|
880
|
+
# @!attribute [rw] iam_role
|
881
|
+
# The IAM role ARN that will be associated with the user.
|
882
|
+
# @return [String]
|
883
|
+
#
|
884
|
+
# @!attribute [rw] tags
|
885
|
+
# A list of key-value pairs to label the user. You can add up to 50
|
886
|
+
# tags to a user.
|
887
|
+
# @return [Hash<String,String>]
|
888
|
+
#
|
889
|
+
# @!attribute [rw] client_token
|
890
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
891
|
+
# @return [String]
|
892
|
+
#
|
893
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxUserRequest AWS API Documentation
|
894
|
+
#
|
895
|
+
class CreateKxUserRequest < Struct.new(
|
896
|
+
:environment_id,
|
897
|
+
:user_name,
|
898
|
+
:iam_role,
|
899
|
+
:tags,
|
900
|
+
:client_token)
|
901
|
+
SENSITIVE = []
|
902
|
+
include Aws::Structure
|
903
|
+
end
|
904
|
+
|
905
|
+
# @!attribute [rw] user_name
|
906
|
+
# A unique identifier for the user.
|
907
|
+
# @return [String]
|
908
|
+
#
|
909
|
+
# @!attribute [rw] user_arn
|
910
|
+
# The Amazon Resource Name (ARN) that identifies the user. For more
|
911
|
+
# information about ARNs and how to use ARNs in policies, see [IAM
|
912
|
+
# Identifiers](IAM/latest/UserGuide/reference_identifiers.html) in the
|
913
|
+
# *IAM User Guide*.
|
914
|
+
# @return [String]
|
915
|
+
#
|
916
|
+
# @!attribute [rw] environment_id
|
917
|
+
# A unique identifier for the kdb environment.
|
918
|
+
# @return [String]
|
919
|
+
#
|
920
|
+
# @!attribute [rw] iam_role
|
921
|
+
# The IAM role ARN that will be associated with the user.
|
922
|
+
# @return [String]
|
923
|
+
#
|
924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxUserResponse AWS API Documentation
|
925
|
+
#
|
926
|
+
class CreateKxUserResponse < Struct.new(
|
927
|
+
:user_name,
|
928
|
+
:user_arn,
|
929
|
+
:environment_id,
|
930
|
+
:iam_role)
|
931
|
+
SENSITIVE = []
|
932
|
+
include Aws::Structure
|
933
|
+
end
|
934
|
+
|
935
|
+
# A list of DNS server name and server IP. This is used to set up
|
936
|
+
# Route-53 outbound resolvers.
|
937
|
+
#
|
938
|
+
# @!attribute [rw] custom_dns_server_name
|
939
|
+
# The name of the DNS server.
|
940
|
+
# @return [String]
|
941
|
+
#
|
942
|
+
# @!attribute [rw] custom_dns_server_ip
|
943
|
+
# The IP address of the DNS server.
|
944
|
+
# @return [String]
|
945
|
+
#
|
946
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CustomDNSServer AWS API Documentation
|
947
|
+
#
|
948
|
+
class CustomDNSServer < Struct.new(
|
949
|
+
:custom_dns_server_name,
|
950
|
+
:custom_dns_server_ip)
|
951
|
+
SENSITIVE = []
|
952
|
+
include Aws::Structure
|
953
|
+
end
|
954
|
+
|
955
|
+
# @!attribute [rw] environment_id
|
956
|
+
# The identifier for the FinSpace environment.
|
957
|
+
# @return [String]
|
958
|
+
#
|
959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteEnvironmentRequest AWS API Documentation
|
960
|
+
#
|
961
|
+
class DeleteEnvironmentRequest < Struct.new(
|
962
|
+
:environment_id)
|
963
|
+
SENSITIVE = []
|
964
|
+
include Aws::Structure
|
965
|
+
end
|
966
|
+
|
967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteEnvironmentResponse AWS API Documentation
|
968
|
+
#
|
969
|
+
class DeleteEnvironmentResponse < Aws::EmptyStructure; end
|
970
|
+
|
971
|
+
# @!attribute [rw] environment_id
|
972
|
+
# A unique identifier for the kdb environment.
|
973
|
+
# @return [String]
|
974
|
+
#
|
975
|
+
# @!attribute [rw] cluster_name
|
976
|
+
# The name of the cluster that you want to delete.
|
977
|
+
# @return [String]
|
978
|
+
#
|
979
|
+
# @!attribute [rw] client_token
|
980
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
981
|
+
#
|
982
|
+
# **A suitable default value is auto-generated.** You should normally
|
983
|
+
# not need to pass this option.
|
984
|
+
# @return [String]
|
985
|
+
#
|
986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxClusterRequest AWS API Documentation
|
987
|
+
#
|
988
|
+
class DeleteKxClusterRequest < Struct.new(
|
989
|
+
:environment_id,
|
990
|
+
:cluster_name,
|
991
|
+
:client_token)
|
992
|
+
SENSITIVE = []
|
993
|
+
include Aws::Structure
|
994
|
+
end
|
995
|
+
|
996
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxClusterResponse AWS API Documentation
|
997
|
+
#
|
998
|
+
class DeleteKxClusterResponse < Aws::EmptyStructure; end
|
999
|
+
|
1000
|
+
# @!attribute [rw] environment_id
|
1001
|
+
# A unique identifier for the kdb environment.
|
1002
|
+
# @return [String]
|
1003
|
+
#
|
1004
|
+
# @!attribute [rw] database_name
|
1005
|
+
# The name of the kdb database that you want to delete.
|
1006
|
+
# @return [String]
|
1007
|
+
#
|
1008
|
+
# @!attribute [rw] client_token
|
1009
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
1010
|
+
#
|
1011
|
+
# **A suitable default value is auto-generated.** You should normally
|
1012
|
+
# not need to pass this option.
|
1013
|
+
# @return [String]
|
1014
|
+
#
|
1015
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxDatabaseRequest AWS API Documentation
|
1016
|
+
#
|
1017
|
+
class DeleteKxDatabaseRequest < Struct.new(
|
1018
|
+
:environment_id,
|
1019
|
+
:database_name,
|
1020
|
+
:client_token)
|
1021
|
+
SENSITIVE = []
|
1022
|
+
include Aws::Structure
|
1023
|
+
end
|
1024
|
+
|
1025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxDatabaseResponse AWS API Documentation
|
1026
|
+
#
|
1027
|
+
class DeleteKxDatabaseResponse < Aws::EmptyStructure; end
|
1028
|
+
|
1029
|
+
# @!attribute [rw] environment_id
|
1030
|
+
# A unique identifier for the kdb environment.
|
1031
|
+
# @return [String]
|
1032
|
+
#
|
1033
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxEnvironmentRequest AWS API Documentation
|
1034
|
+
#
|
1035
|
+
class DeleteKxEnvironmentRequest < Struct.new(
|
1036
|
+
:environment_id)
|
1037
|
+
SENSITIVE = []
|
1038
|
+
include Aws::Structure
|
1039
|
+
end
|
1040
|
+
|
1041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxEnvironmentResponse AWS API Documentation
|
1042
|
+
#
|
1043
|
+
class DeleteKxEnvironmentResponse < Aws::EmptyStructure; end
|
1044
|
+
|
1045
|
+
# @!attribute [rw] user_name
|
1046
|
+
# A unique identifier for the user that you want to delete.
|
1047
|
+
# @return [String]
|
1048
|
+
#
|
1049
|
+
# @!attribute [rw] environment_id
|
1050
|
+
# A unique identifier for the kdb environment.
|
1051
|
+
# @return [String]
|
1052
|
+
#
|
1053
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxUserRequest AWS API Documentation
|
1054
|
+
#
|
1055
|
+
class DeleteKxUserRequest < Struct.new(
|
1056
|
+
:user_name,
|
1057
|
+
:environment_id)
|
1058
|
+
SENSITIVE = []
|
1059
|
+
include Aws::Structure
|
1060
|
+
end
|
1061
|
+
|
1062
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxUserResponse AWS API Documentation
|
1063
|
+
#
|
1064
|
+
class DeleteKxUserResponse < Aws::EmptyStructure; end
|
1065
|
+
|
1066
|
+
# Represents an FinSpace environment.
|
1067
|
+
#
|
1068
|
+
# @!attribute [rw] name
|
1069
|
+
# The name of the FinSpace environment.
|
1070
|
+
# @return [String]
|
1071
|
+
#
|
1072
|
+
# @!attribute [rw] environment_id
|
1073
|
+
# The identifier of the FinSpace environment.
|
1074
|
+
# @return [String]
|
1075
|
+
#
|
1076
|
+
# @!attribute [rw] aws_account_id
|
1077
|
+
# The ID of the AWS account in which the FinSpace environment is
|
1078
|
+
# created.
|
1079
|
+
# @return [String]
|
1080
|
+
#
|
1081
|
+
# @!attribute [rw] status
|
1082
|
+
# The current status of creation of the FinSpace environment.
|
1083
|
+
# @return [String]
|
1084
|
+
#
|
1085
|
+
# @!attribute [rw] environment_url
|
1086
|
+
# The sign-in URL for the web application of your FinSpace
|
1087
|
+
# environment.
|
1088
|
+
# @return [String]
|
1089
|
+
#
|
1090
|
+
# @!attribute [rw] description
|
1091
|
+
# The description of the FinSpace environment.
|
1092
|
+
# @return [String]
|
1093
|
+
#
|
1094
|
+
# @!attribute [rw] environment_arn
|
1095
|
+
# The Amazon Resource Name (ARN) of your FinSpace environment.
|
1096
|
+
# @return [String]
|
1097
|
+
#
|
1098
|
+
# @!attribute [rw] sage_maker_studio_domain_url
|
1099
|
+
# The URL of the integrated FinSpace notebook environment in your web
|
1100
|
+
# application.
|
1101
|
+
# @return [String]
|
1102
|
+
#
|
1103
|
+
# @!attribute [rw] kms_key_id
|
1104
|
+
# The KMS key id used to encrypt in the FinSpace environment.
|
1105
|
+
# @return [String]
|
1106
|
+
#
|
1107
|
+
# @!attribute [rw] dedicated_service_account_id
|
1108
|
+
# The AWS account ID of the dedicated service account associated with
|
1109
|
+
# your FinSpace environment.
|
1110
|
+
# @return [String]
|
1111
|
+
#
|
1112
|
+
# @!attribute [rw] federation_mode
|
1113
|
+
# The authentication mode for the environment.
|
1114
|
+
# @return [String]
|
1115
|
+
#
|
1116
|
+
# @!attribute [rw] federation_parameters
|
1117
|
+
# Configuration information when authentication mode is FEDERATED.
|
1118
|
+
# @return [Types::FederationParameters]
|
1119
|
+
#
|
1120
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/Environment AWS API Documentation
|
1121
|
+
#
|
1122
|
+
class Environment < Struct.new(
|
1123
|
+
:name,
|
1124
|
+
:environment_id,
|
1125
|
+
:aws_account_id,
|
1126
|
+
:status,
|
1127
|
+
:environment_url,
|
1128
|
+
:description,
|
1129
|
+
:environment_arn,
|
1130
|
+
:sage_maker_studio_domain_url,
|
1131
|
+
:kms_key_id,
|
1132
|
+
:dedicated_service_account_id,
|
1133
|
+
:federation_mode,
|
1134
|
+
:federation_parameters)
|
1135
|
+
SENSITIVE = []
|
1136
|
+
include Aws::Structure
|
1137
|
+
end
|
1138
|
+
|
1139
|
+
# Provides details in the event of a failed flow, including the error
|
1140
|
+
# type and the related error message.
|
1141
|
+
#
|
1142
|
+
# @!attribute [rw] error_message
|
1143
|
+
# Specifies the error message that appears if a flow fails.
|
1144
|
+
# @return [String]
|
1145
|
+
#
|
1146
|
+
# @!attribute [rw] error_type
|
1147
|
+
# Specifies the type of error.
|
1148
|
+
# @return [String]
|
1149
|
+
#
|
1150
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ErrorInfo AWS API Documentation
|
1151
|
+
#
|
1152
|
+
class ErrorInfo < Struct.new(
|
1153
|
+
:error_message,
|
1154
|
+
:error_type)
|
1155
|
+
SENSITIVE = []
|
1156
|
+
include Aws::Structure
|
1157
|
+
end
|
1158
|
+
|
1159
|
+
# Configuration information when authentication mode is FEDERATED.
|
1160
|
+
#
|
1161
|
+
# @!attribute [rw] saml_metadata_document
|
1162
|
+
# SAML 2.0 Metadata document from identity provider (IdP).
|
1163
|
+
# @return [String]
|
1164
|
+
#
|
1165
|
+
# @!attribute [rw] saml_metadata_url
|
1166
|
+
# Provide the metadata URL from your SAML 2.0 compliant identity
|
1167
|
+
# provider (IdP).
|
1168
|
+
# @return [String]
|
1169
|
+
#
|
1170
|
+
# @!attribute [rw] application_call_back_url
|
1171
|
+
# The redirect or sign-in URL that should be entered into the SAML 2.0
|
1172
|
+
# compliant identity provider configuration (IdP).
|
1173
|
+
# @return [String]
|
1174
|
+
#
|
1175
|
+
# @!attribute [rw] federation_urn
|
1176
|
+
# The Uniform Resource Name (URN). Also referred as Service Provider
|
1177
|
+
# URN or Audience URI or Service Provider Entity ID.
|
1178
|
+
# @return [String]
|
1179
|
+
#
|
1180
|
+
# @!attribute [rw] federation_provider_name
|
1181
|
+
# Name of the identity provider (IdP).
|
1182
|
+
# @return [String]
|
1183
|
+
#
|
1184
|
+
# @!attribute [rw] attribute_map
|
1185
|
+
# SAML attribute name and value. The name must always be `Email` and
|
1186
|
+
# the value should be set to the attribute definition in which user
|
1187
|
+
# email is set. For example, name would be `Email` and value
|
1188
|
+
# `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress`.
|
1189
|
+
# Please check your SAML 2.0 compliant identity provider (IdP)
|
1190
|
+
# documentation for details.
|
1191
|
+
# @return [Hash<String,String>]
|
1192
|
+
#
|
1193
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/FederationParameters AWS API Documentation
|
1194
|
+
#
|
1195
|
+
class FederationParameters < Struct.new(
|
1196
|
+
:saml_metadata_document,
|
1197
|
+
:saml_metadata_url,
|
1198
|
+
:application_call_back_url,
|
1199
|
+
:federation_urn,
|
1200
|
+
:federation_provider_name,
|
1201
|
+
:attribute_map)
|
1202
|
+
SENSITIVE = []
|
1203
|
+
include Aws::Structure
|
1204
|
+
end
|
1205
|
+
|
1206
|
+
# @!attribute [rw] environment_id
|
1207
|
+
# The identifier of the FinSpace environment.
|
1208
|
+
# @return [String]
|
1209
|
+
#
|
1210
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetEnvironmentRequest AWS API Documentation
|
1211
|
+
#
|
1212
|
+
class GetEnvironmentRequest < Struct.new(
|
1213
|
+
:environment_id)
|
1214
|
+
SENSITIVE = []
|
1215
|
+
include Aws::Structure
|
1216
|
+
end
|
1217
|
+
|
1218
|
+
# @!attribute [rw] environment
|
1219
|
+
# The name of the FinSpace environment.
|
1220
|
+
# @return [Types::Environment]
|
1221
|
+
#
|
1222
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetEnvironmentResponse AWS API Documentation
|
1223
|
+
#
|
1224
|
+
class GetEnvironmentResponse < Struct.new(
|
1225
|
+
:environment)
|
1226
|
+
SENSITIVE = []
|
1227
|
+
include Aws::Structure
|
1228
|
+
end
|
1229
|
+
|
1230
|
+
# @!attribute [rw] environment_id
|
1231
|
+
# A unique identifier for the kdb environment.
|
1232
|
+
# @return [String]
|
1233
|
+
#
|
1234
|
+
# @!attribute [rw] database_name
|
1235
|
+
# The name of the kdb database.
|
1236
|
+
# @return [String]
|
1237
|
+
#
|
1238
|
+
# @!attribute [rw] changeset_id
|
1239
|
+
# A unique identifier of the changeset for which you want to retrieve
|
1240
|
+
# data.
|
1241
|
+
# @return [String]
|
1242
|
+
#
|
1243
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxChangesetRequest AWS API Documentation
|
1244
|
+
#
|
1245
|
+
class GetKxChangesetRequest < Struct.new(
|
1246
|
+
:environment_id,
|
1247
|
+
:database_name,
|
1248
|
+
:changeset_id)
|
1249
|
+
SENSITIVE = []
|
1250
|
+
include Aws::Structure
|
1251
|
+
end
|
1252
|
+
|
1253
|
+
# @!attribute [rw] changeset_id
|
1254
|
+
# A unique identifier for the changeset.
|
1255
|
+
# @return [String]
|
1256
|
+
#
|
1257
|
+
# @!attribute [rw] database_name
|
1258
|
+
# The name of the kdb database.
|
1259
|
+
# @return [String]
|
1260
|
+
#
|
1261
|
+
# @!attribute [rw] environment_id
|
1262
|
+
# A unique identifier for the kdb environment.
|
1263
|
+
# @return [String]
|
1264
|
+
#
|
1265
|
+
# @!attribute [rw] change_requests
|
1266
|
+
# A list of change request objects that are run in order.
|
1267
|
+
# @return [Array<Types::ChangeRequest>]
|
1268
|
+
#
|
1269
|
+
# @!attribute [rw] created_timestamp
|
1270
|
+
# The timestamp at which the changeset was created in FinSpace. The
|
1271
|
+
# value is determined as epoch time in milliseconds. For example, the
|
1272
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
1273
|
+
# 1635768000000.
|
1274
|
+
# @return [Time]
|
1275
|
+
#
|
1276
|
+
# @!attribute [rw] active_from_timestamp
|
1277
|
+
# Beginning time from which the changeset is active. The value is
|
1278
|
+
# determined as epoch time in milliseconds. For example, the value for
|
1279
|
+
# Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
1280
|
+
# 1635768000000.
|
1281
|
+
# @return [Time]
|
1282
|
+
#
|
1283
|
+
# @!attribute [rw] last_modified_timestamp
|
1284
|
+
# The timestamp at which the changeset was updated in FinSpace. The
|
1285
|
+
# value is determined as epoch time in milliseconds. For example, the
|
1286
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
1287
|
+
# 1635768000000.
|
1288
|
+
# @return [Time]
|
1289
|
+
#
|
1290
|
+
# @!attribute [rw] status
|
1291
|
+
# Status of the changeset creation process.
|
1292
|
+
#
|
1293
|
+
# * Pending – Changeset creation is pending.
|
1294
|
+
#
|
1295
|
+
# * Processing – Changeset creation is running.
|
1296
|
+
#
|
1297
|
+
# * Failed – Changeset creation has failed.
|
1298
|
+
#
|
1299
|
+
# * Complete – Changeset creation has succeeded.
|
1300
|
+
# @return [String]
|
1301
|
+
#
|
1302
|
+
# @!attribute [rw] error_info
|
1303
|
+
# Provides details in the event of a failed flow, including the error
|
1304
|
+
# type and the related error message.
|
1305
|
+
# @return [Types::ErrorInfo]
|
1306
|
+
#
|
1307
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxChangesetResponse AWS API Documentation
|
1308
|
+
#
|
1309
|
+
class GetKxChangesetResponse < Struct.new(
|
1310
|
+
:changeset_id,
|
1311
|
+
:database_name,
|
1312
|
+
:environment_id,
|
1313
|
+
:change_requests,
|
1314
|
+
:created_timestamp,
|
1315
|
+
:active_from_timestamp,
|
1316
|
+
:last_modified_timestamp,
|
1317
|
+
:status,
|
1318
|
+
:error_info)
|
1319
|
+
SENSITIVE = []
|
1320
|
+
include Aws::Structure
|
1321
|
+
end
|
1322
|
+
|
1323
|
+
# @!attribute [rw] environment_id
|
1324
|
+
# A unique identifier for the kdb environment.
|
1325
|
+
# @return [String]
|
1326
|
+
#
|
1327
|
+
# @!attribute [rw] cluster_name
|
1328
|
+
# The name of the cluster that you want to retrieve.
|
1329
|
+
# @return [String]
|
1330
|
+
#
|
1331
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxClusterRequest AWS API Documentation
|
1332
|
+
#
|
1333
|
+
class GetKxClusterRequest < Struct.new(
|
1334
|
+
:environment_id,
|
1335
|
+
:cluster_name)
|
1336
|
+
SENSITIVE = []
|
1337
|
+
include Aws::Structure
|
1338
|
+
end
|
1339
|
+
|
1340
|
+
# @!attribute [rw] status
|
1341
|
+
# The status of cluster creation.
|
1342
|
+
#
|
1343
|
+
# * PENDING – The cluster is pending creation.
|
1344
|
+
#
|
1345
|
+
# * CREATING – The cluster creation process is in progress.
|
1346
|
+
#
|
1347
|
+
# * CREATE\_FAILED – The cluster creation process has failed.
|
1348
|
+
#
|
1349
|
+
# * RUNNING – The cluster creation process is running.
|
1350
|
+
#
|
1351
|
+
# * UPDATING – The cluster is in the process of being updated.
|
1352
|
+
#
|
1353
|
+
# * DELETING – The cluster is in the process of being deleted.
|
1354
|
+
#
|
1355
|
+
# * DELETED – The cluster has been deleted.
|
1356
|
+
#
|
1357
|
+
# * DELETE\_FAILED – The cluster failed to delete.
|
1358
|
+
# @return [String]
|
1359
|
+
#
|
1360
|
+
# @!attribute [rw] status_reason
|
1361
|
+
# The error message when a failed state occurs.
|
1362
|
+
# @return [String]
|
1363
|
+
#
|
1364
|
+
# @!attribute [rw] cluster_name
|
1365
|
+
# A unique name for the cluster.
|
1366
|
+
# @return [String]
|
1367
|
+
#
|
1368
|
+
# @!attribute [rw] cluster_type
|
1369
|
+
# Specifies the type of KDB database that is being created. The
|
1370
|
+
# following types are available:
|
1371
|
+
#
|
1372
|
+
# * HDB – A Historical Database. The data is only accessible with
|
1373
|
+
# read-only permissions from one of the FinSpace managed kdb
|
1374
|
+
# databases mounted to the cluster.
|
1375
|
+
#
|
1376
|
+
# * RDB – A Realtime Database. This type of database captures all the
|
1377
|
+
# data from a ticker plant and stores it in memory until the end of
|
1378
|
+
# day, after which it writes all of its data to a disk and reloads
|
1379
|
+
# the HDB. This cluster type requires local storage for temporary
|
1380
|
+
# storage of data during the savedown process. If you specify this
|
1381
|
+
# field in your request, you must provide the
|
1382
|
+
# `savedownStorageConfiguration` parameter.
|
1383
|
+
#
|
1384
|
+
# * GATEWAY – A gateway cluster allows you to access data across
|
1385
|
+
# processes in kdb systems. It allows you to create your own routing
|
1386
|
+
# logic using the initialization scripts and custom code. This type
|
1387
|
+
# of cluster does not require a writable local storage.
|
1388
|
+
# @return [String]
|
1389
|
+
#
|
1390
|
+
# @!attribute [rw] databases
|
1391
|
+
# A list of databases mounted on the cluster.
|
1392
|
+
# @return [Array<Types::KxDatabaseConfiguration>]
|
1393
|
+
#
|
1394
|
+
# @!attribute [rw] cache_storage_configurations
|
1395
|
+
# The configurations for a read only cache storage associated with a
|
1396
|
+
# cluster. This cache will be stored as an FSx Lustre that reads from
|
1397
|
+
# the S3 store.
|
1398
|
+
# @return [Array<Types::KxCacheStorageConfiguration>]
|
1399
|
+
#
|
1400
|
+
# @!attribute [rw] auto_scaling_configuration
|
1401
|
+
# The configuration based on which FinSpace will scale in or scale out
|
1402
|
+
# nodes in your cluster.
|
1403
|
+
# @return [Types::AutoScalingConfiguration]
|
1404
|
+
#
|
1405
|
+
# @!attribute [rw] cluster_description
|
1406
|
+
# A description of the cluster.
|
1407
|
+
# @return [String]
|
1408
|
+
#
|
1409
|
+
# @!attribute [rw] capacity_configuration
|
1410
|
+
# A structure for the metadata of a cluster. It includes information
|
1411
|
+
# like the CPUs needed, memory of instances, number of instances, and
|
1412
|
+
# the port used while establishing a connection.
|
1413
|
+
# @return [Types::CapacityConfiguration]
|
1414
|
+
#
|
1415
|
+
# @!attribute [rw] release_label
|
1416
|
+
# The version of FinSpace managed kdb to run.
|
1417
|
+
# @return [String]
|
1418
|
+
#
|
1419
|
+
# @!attribute [rw] vpc_configuration
|
1420
|
+
# Configuration details about the network where the Privatelink
|
1421
|
+
# endpoint of the cluster resides.
|
1422
|
+
# @return [Types::VpcConfiguration]
|
1423
|
+
#
|
1424
|
+
# @!attribute [rw] initialization_script
|
1425
|
+
# Specifies a Q program that will be run at launch of a cluster. It is
|
1426
|
+
# a relative path within *.zip* file that contains the custom code,
|
1427
|
+
# which will be loaded on the cluster. It must include the file name
|
1428
|
+
# itself. For example, `somedir/init.q`.
|
1429
|
+
# @return [String]
|
1430
|
+
#
|
1431
|
+
# @!attribute [rw] command_line_arguments
|
1432
|
+
# Defines key-value pairs to make them available inside the cluster.
|
1433
|
+
# @return [Array<Types::KxCommandLineArgument>]
|
1434
|
+
#
|
1435
|
+
# @!attribute [rw] code
|
1436
|
+
# The details of the custom code that you want to use inside a cluster
|
1437
|
+
# when analyzing a data. It consists of the S3 source bucket,
|
1438
|
+
# location, S3 object version, and the relative path from where the
|
1439
|
+
# custom code is loaded into the cluster.
|
1440
|
+
# @return [Types::CodeConfiguration]
|
1441
|
+
#
|
1442
|
+
# @!attribute [rw] execution_role
|
1443
|
+
# An IAM role that defines a set of permissions associated with a
|
1444
|
+
# cluster. These permissions are assumed when a cluster attempts to
|
1445
|
+
# access another cluster.
|
1446
|
+
# @return [String]
|
1447
|
+
#
|
1448
|
+
# @!attribute [rw] last_modified_timestamp
|
1449
|
+
# The last time that the cluster was modified. The value is determined
|
1450
|
+
# as epoch time in milliseconds. For example, the value for Monday,
|
1451
|
+
# November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
|
1452
|
+
# @return [Time]
|
1453
|
+
#
|
1454
|
+
# @!attribute [rw] savedown_storage_configuration
|
1455
|
+
# The size and type of the temporary storage that is used to hold data
|
1456
|
+
# during the savedown process. This parameter is required when you
|
1457
|
+
# choose `clusterType` as RDB. All the data written to this storage
|
1458
|
+
# space is lost when the cluster node is restarted.
|
1459
|
+
# @return [Types::KxSavedownStorageConfiguration]
|
1460
|
+
#
|
1461
|
+
# @!attribute [rw] az_mode
|
1462
|
+
# The number of availability zones you want to assign per cluster.
|
1463
|
+
# This can be one of the following
|
1464
|
+
#
|
1465
|
+
# * `SINGLE` – Assigns one availability zone per cluster.
|
1466
|
+
#
|
1467
|
+
# * `MULTI` – Assigns all the availability zones per cluster.
|
1468
|
+
# @return [String]
|
1469
|
+
#
|
1470
|
+
# @!attribute [rw] availability_zone_id
|
1471
|
+
# The availability zone identifiers for the requested regions.
|
1472
|
+
# @return [String]
|
1473
|
+
#
|
1474
|
+
# @!attribute [rw] created_timestamp
|
1475
|
+
# The timestamp at which the cluster was created in FinSpace. The
|
1476
|
+
# value is determined as epoch time in milliseconds. For example, the
|
1477
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
1478
|
+
# 1635768000000.
|
1479
|
+
# @return [Time]
|
1480
|
+
#
|
1481
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxClusterResponse AWS API Documentation
|
1482
|
+
#
|
1483
|
+
class GetKxClusterResponse < Struct.new(
|
1484
|
+
:status,
|
1485
|
+
:status_reason,
|
1486
|
+
:cluster_name,
|
1487
|
+
:cluster_type,
|
1488
|
+
:databases,
|
1489
|
+
:cache_storage_configurations,
|
1490
|
+
:auto_scaling_configuration,
|
1491
|
+
:cluster_description,
|
1492
|
+
:capacity_configuration,
|
1493
|
+
:release_label,
|
1494
|
+
:vpc_configuration,
|
1495
|
+
:initialization_script,
|
1496
|
+
:command_line_arguments,
|
1497
|
+
:code,
|
1498
|
+
:execution_role,
|
1499
|
+
:last_modified_timestamp,
|
1500
|
+
:savedown_storage_configuration,
|
1501
|
+
:az_mode,
|
1502
|
+
:availability_zone_id,
|
1503
|
+
:created_timestamp)
|
1504
|
+
SENSITIVE = []
|
1505
|
+
include Aws::Structure
|
1506
|
+
end
|
1507
|
+
|
1508
|
+
# @!attribute [rw] user_arn
|
1509
|
+
# The Amazon Resource Name (ARN) that identifies the user. For more
|
1510
|
+
# information about ARNs and how to use ARNs in policies, see [IAM
|
1511
|
+
# Identifiers](IAM/latest/UserGuide/reference_identifiers.html) in the
|
1512
|
+
# *IAM User Guide*.
|
1513
|
+
# @return [String]
|
1514
|
+
#
|
1515
|
+
# @!attribute [rw] environment_id
|
1516
|
+
# A unique identifier for the kdb environment.
|
1517
|
+
# @return [String]
|
1518
|
+
#
|
1519
|
+
# @!attribute [rw] cluster_name
|
1520
|
+
# A name of the kdb cluster.
|
1521
|
+
# @return [String]
|
1522
|
+
#
|
1523
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxConnectionStringRequest AWS API Documentation
|
1524
|
+
#
|
1525
|
+
class GetKxConnectionStringRequest < Struct.new(
|
1526
|
+
:user_arn,
|
1527
|
+
:environment_id,
|
1528
|
+
:cluster_name)
|
1529
|
+
SENSITIVE = []
|
1530
|
+
include Aws::Structure
|
1531
|
+
end
|
1532
|
+
|
1533
|
+
# @!attribute [rw] signed_connection_string
|
1534
|
+
# The signed connection string that you can use to connect to
|
1535
|
+
# clusters.
|
1536
|
+
# @return [String]
|
1537
|
+
#
|
1538
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxConnectionStringResponse AWS API Documentation
|
1539
|
+
#
|
1540
|
+
class GetKxConnectionStringResponse < Struct.new(
|
1541
|
+
:signed_connection_string)
|
1542
|
+
SENSITIVE = [:signed_connection_string]
|
1543
|
+
include Aws::Structure
|
1544
|
+
end
|
1545
|
+
|
1546
|
+
# @!attribute [rw] environment_id
|
1547
|
+
# A unique identifier for the kdb environment.
|
1548
|
+
# @return [String]
|
1549
|
+
#
|
1550
|
+
# @!attribute [rw] database_name
|
1551
|
+
# The name of the kdb database.
|
1552
|
+
# @return [String]
|
1553
|
+
#
|
1554
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxDatabaseRequest AWS API Documentation
|
1555
|
+
#
|
1556
|
+
class GetKxDatabaseRequest < Struct.new(
|
1557
|
+
:environment_id,
|
1558
|
+
:database_name)
|
1559
|
+
SENSITIVE = []
|
1560
|
+
include Aws::Structure
|
1561
|
+
end
|
1562
|
+
|
1563
|
+
# @!attribute [rw] database_name
|
1564
|
+
# The name of the kdb database for which the information is retrieved.
|
1565
|
+
# @return [String]
|
1566
|
+
#
|
1567
|
+
# @!attribute [rw] database_arn
|
1568
|
+
# The ARN identifier of the database.
|
1569
|
+
# @return [String]
|
1570
|
+
#
|
1571
|
+
# @!attribute [rw] environment_id
|
1572
|
+
# A unique identifier for the kdb environment.
|
1573
|
+
# @return [String]
|
1574
|
+
#
|
1575
|
+
# @!attribute [rw] description
|
1576
|
+
# A description of the database.
|
1577
|
+
# @return [String]
|
1578
|
+
#
|
1579
|
+
# @!attribute [rw] created_timestamp
|
1580
|
+
# The timestamp at which the database is created in FinSpace. The
|
1581
|
+
# value is determined as epoch time in milliseconds. For example, the
|
1582
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
1583
|
+
# 1635768000000.
|
1584
|
+
# @return [Time]
|
1585
|
+
#
|
1586
|
+
# @!attribute [rw] last_modified_timestamp
|
1587
|
+
# The last time that the database was modified. The value is
|
1588
|
+
# determined as epoch time in milliseconds. For example, the value for
|
1589
|
+
# Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
1590
|
+
# 1635768000000.
|
1591
|
+
# @return [Time]
|
1592
|
+
#
|
1593
|
+
# @!attribute [rw] last_completed_changeset_id
|
1594
|
+
# A unique identifier for the changeset.
|
1595
|
+
# @return [String]
|
1596
|
+
#
|
1597
|
+
# @!attribute [rw] num_bytes
|
1598
|
+
# The total number of bytes in the database.
|
1599
|
+
# @return [Integer]
|
1600
|
+
#
|
1601
|
+
# @!attribute [rw] num_changesets
|
1602
|
+
# The total number of changesets in the database.
|
1603
|
+
# @return [Integer]
|
1604
|
+
#
|
1605
|
+
# @!attribute [rw] num_files
|
1606
|
+
# The total number of files in the database.
|
1607
|
+
# @return [Integer]
|
1608
|
+
#
|
1609
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxDatabaseResponse AWS API Documentation
|
1610
|
+
#
|
1611
|
+
class GetKxDatabaseResponse < Struct.new(
|
1612
|
+
:database_name,
|
1613
|
+
:database_arn,
|
1614
|
+
:environment_id,
|
1615
|
+
:description,
|
1616
|
+
:created_timestamp,
|
1617
|
+
:last_modified_timestamp,
|
1618
|
+
:last_completed_changeset_id,
|
1619
|
+
:num_bytes,
|
1620
|
+
:num_changesets,
|
1621
|
+
:num_files)
|
1622
|
+
SENSITIVE = []
|
1623
|
+
include Aws::Structure
|
1624
|
+
end
|
1625
|
+
|
1626
|
+
# @!attribute [rw] environment_id
|
1627
|
+
# A unique identifier for the kdb environment.
|
1628
|
+
# @return [String]
|
1629
|
+
#
|
1630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxEnvironmentRequest AWS API Documentation
|
1631
|
+
#
|
1632
|
+
class GetKxEnvironmentRequest < Struct.new(
|
1633
|
+
:environment_id)
|
1634
|
+
SENSITIVE = []
|
1635
|
+
include Aws::Structure
|
1636
|
+
end
|
1637
|
+
|
1638
|
+
# @!attribute [rw] name
|
1639
|
+
# The name of the kdb environment.
|
1640
|
+
# @return [String]
|
1641
|
+
#
|
1642
|
+
# @!attribute [rw] environment_id
|
1643
|
+
# A unique identifier for the kdb environment.
|
1644
|
+
# @return [String]
|
1645
|
+
#
|
1646
|
+
# @!attribute [rw] aws_account_id
|
1647
|
+
# The unique identifier of the AWS account that is used to create the
|
1648
|
+
# kdb environment.
|
1649
|
+
# @return [String]
|
1650
|
+
#
|
1651
|
+
# @!attribute [rw] status
|
1652
|
+
# The status of the kdb environment.
|
1653
|
+
# @return [String]
|
1654
|
+
#
|
1655
|
+
# @!attribute [rw] tgw_status
|
1656
|
+
# The status of the network configuration.
|
1657
|
+
# @return [String]
|
1658
|
+
#
|
1659
|
+
# @!attribute [rw] dns_status
|
1660
|
+
# The status of DNS configuration.
|
1661
|
+
# @return [String]
|
1662
|
+
#
|
1663
|
+
# @!attribute [rw] error_message
|
1664
|
+
# Specifies the error message that appears if a flow fails.
|
1665
|
+
# @return [String]
|
1666
|
+
#
|
1667
|
+
# @!attribute [rw] description
|
1668
|
+
# A description for the kdb environment.
|
1669
|
+
# @return [String]
|
1670
|
+
#
|
1671
|
+
# @!attribute [rw] environment_arn
|
1672
|
+
# The ARN identifier of the environment.
|
1673
|
+
# @return [String]
|
1674
|
+
#
|
1675
|
+
# @!attribute [rw] kms_key_id
|
1676
|
+
# The KMS key ID to encrypt your data in the FinSpace environment.
|
1677
|
+
# @return [String]
|
1678
|
+
#
|
1679
|
+
# @!attribute [rw] dedicated_service_account_id
|
1680
|
+
# A unique identifier for the AWS environment infrastructure account.
|
1681
|
+
# @return [String]
|
1682
|
+
#
|
1683
|
+
# @!attribute [rw] transit_gateway_configuration
|
1684
|
+
# The structure of the transit gateway and network configuration that
|
1685
|
+
# is used to connect the kdb environment to an internal network.
|
1686
|
+
# @return [Types::TransitGatewayConfiguration]
|
1687
|
+
#
|
1688
|
+
# @!attribute [rw] custom_dns_configuration
|
1689
|
+
# A list of DNS server name and server IP. This is used to set up
|
1690
|
+
# Route-53 outbound resolvers.
|
1691
|
+
# @return [Array<Types::CustomDNSServer>]
|
1692
|
+
#
|
1693
|
+
# @!attribute [rw] creation_timestamp
|
1694
|
+
# The timestamp at which the kdb environment was created in FinSpace.
|
1695
|
+
# @return [Time]
|
1696
|
+
#
|
1697
|
+
# @!attribute [rw] update_timestamp
|
1698
|
+
# The timestamp at which the kdb environment was updated.
|
1699
|
+
# @return [Time]
|
1700
|
+
#
|
1701
|
+
# @!attribute [rw] availability_zone_ids
|
1702
|
+
# The identifier of the availability zones where subnets for the
|
1703
|
+
# environment are created.
|
1704
|
+
# @return [Array<String>]
|
1705
|
+
#
|
1706
|
+
# @!attribute [rw] certificate_authority_arn
|
1707
|
+
# The Amazon Resource Name (ARN) of the certificate authority of the
|
1708
|
+
# kdb environment.
|
1709
|
+
# @return [String]
|
1710
|
+
#
|
1711
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxEnvironmentResponse AWS API Documentation
|
1712
|
+
#
|
1713
|
+
class GetKxEnvironmentResponse < Struct.new(
|
1714
|
+
:name,
|
1715
|
+
:environment_id,
|
1716
|
+
:aws_account_id,
|
1717
|
+
:status,
|
1718
|
+
:tgw_status,
|
1719
|
+
:dns_status,
|
1720
|
+
:error_message,
|
1721
|
+
:description,
|
1722
|
+
:environment_arn,
|
1723
|
+
:kms_key_id,
|
1724
|
+
:dedicated_service_account_id,
|
1725
|
+
:transit_gateway_configuration,
|
1726
|
+
:custom_dns_configuration,
|
1727
|
+
:creation_timestamp,
|
1728
|
+
:update_timestamp,
|
1729
|
+
:availability_zone_ids,
|
1730
|
+
:certificate_authority_arn)
|
1731
|
+
SENSITIVE = []
|
1732
|
+
include Aws::Structure
|
1733
|
+
end
|
1734
|
+
|
1735
|
+
# @!attribute [rw] user_name
|
1736
|
+
# A unique identifier for the user.
|
1737
|
+
# @return [String]
|
1738
|
+
#
|
1739
|
+
# @!attribute [rw] environment_id
|
1740
|
+
# A unique identifier for the kdb environment.
|
1741
|
+
# @return [String]
|
1742
|
+
#
|
1743
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxUserRequest AWS API Documentation
|
1744
|
+
#
|
1745
|
+
class GetKxUserRequest < Struct.new(
|
1746
|
+
:user_name,
|
1747
|
+
:environment_id)
|
1748
|
+
SENSITIVE = []
|
1749
|
+
include Aws::Structure
|
1750
|
+
end
|
1751
|
+
|
1752
|
+
# @!attribute [rw] user_name
|
1753
|
+
# A unique identifier for the user.
|
1754
|
+
# @return [String]
|
1755
|
+
#
|
1756
|
+
# @!attribute [rw] user_arn
|
1757
|
+
# The Amazon Resource Name (ARN) that identifies the user. For more
|
1758
|
+
# information about ARNs and how to use ARNs in policies, see [IAM
|
1759
|
+
# Identifiers](IAM/latest/UserGuide/reference_identifiers.html) in the
|
1760
|
+
# *IAM User Guide*.
|
1761
|
+
# @return [String]
|
1762
|
+
#
|
1763
|
+
# @!attribute [rw] environment_id
|
1764
|
+
# A unique identifier for the kdb environment.
|
1765
|
+
# @return [String]
|
1766
|
+
#
|
1767
|
+
# @!attribute [rw] iam_role
|
1768
|
+
# The IAM role ARN that is associated with the user.
|
1769
|
+
# @return [String]
|
1770
|
+
#
|
1771
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxUserResponse AWS API Documentation
|
1772
|
+
#
|
1773
|
+
class GetKxUserResponse < Struct.new(
|
1774
|
+
:user_name,
|
1775
|
+
:user_arn,
|
1776
|
+
:environment_id,
|
1777
|
+
:iam_role)
|
1778
|
+
SENSITIVE = []
|
1779
|
+
include Aws::Structure
|
1780
|
+
end
|
1781
|
+
|
1782
|
+
# The request processing has failed because of an unknown error,
|
1783
|
+
# exception or failure.
|
1784
|
+
#
|
1785
|
+
# @!attribute [rw] message
|
1786
|
+
# @return [String]
|
1787
|
+
#
|
1788
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/InternalServerException AWS API Documentation
|
1789
|
+
#
|
1790
|
+
class InternalServerException < Struct.new(
|
1791
|
+
:message)
|
1792
|
+
SENSITIVE = []
|
1793
|
+
include Aws::Structure
|
1794
|
+
end
|
1795
|
+
|
1796
|
+
# The request is invalid. Something is wrong with the input to the
|
1797
|
+
# request.
|
1798
|
+
#
|
1799
|
+
# @!attribute [rw] message
|
283
1800
|
# @return [String]
|
284
1801
|
#
|
285
1802
|
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/InvalidRequestException AWS API Documentation
|
286
1803
|
#
|
287
|
-
class InvalidRequestException < Struct.new(
|
288
|
-
:message)
|
1804
|
+
class InvalidRequestException < Struct.new(
|
1805
|
+
:message)
|
1806
|
+
SENSITIVE = []
|
1807
|
+
include Aws::Structure
|
1808
|
+
end
|
1809
|
+
|
1810
|
+
# The configuration for read only disk cache associated with a cluster.
|
1811
|
+
#
|
1812
|
+
# @!attribute [rw] type
|
1813
|
+
# The type of cache storage . The valid values are:
|
1814
|
+
#
|
1815
|
+
# * CACHE\_1000 – This type provides at least 1000 MB/s disk access
|
1816
|
+
# throughput.
|
1817
|
+
#
|
1818
|
+
# ^
|
1819
|
+
# @return [String]
|
1820
|
+
#
|
1821
|
+
# @!attribute [rw] size
|
1822
|
+
# The size of cache in Gigabytes.
|
1823
|
+
# @return [Integer]
|
1824
|
+
#
|
1825
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxCacheStorageConfiguration AWS API Documentation
|
1826
|
+
#
|
1827
|
+
class KxCacheStorageConfiguration < Struct.new(
|
1828
|
+
:type,
|
1829
|
+
:size)
|
1830
|
+
SENSITIVE = []
|
1831
|
+
include Aws::Structure
|
1832
|
+
end
|
1833
|
+
|
1834
|
+
# Details of changeset.
|
1835
|
+
#
|
1836
|
+
# @!attribute [rw] changeset_id
|
1837
|
+
# A unique identifier for the changeset.
|
1838
|
+
# @return [String]
|
1839
|
+
#
|
1840
|
+
# @!attribute [rw] created_timestamp
|
1841
|
+
# The timestamp at which the changeset was created in FinSpace. The
|
1842
|
+
# value is determined as epoch time in milliseconds. For example, the
|
1843
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
1844
|
+
# 1635768000000.
|
1845
|
+
# @return [Time]
|
1846
|
+
#
|
1847
|
+
# @!attribute [rw] active_from_timestamp
|
1848
|
+
# Beginning time from which the changeset is active. The value is
|
1849
|
+
# determined as epoch time in milliseconds. For example, the value for
|
1850
|
+
# Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
1851
|
+
# 1635768000000.
|
1852
|
+
# @return [Time]
|
1853
|
+
#
|
1854
|
+
# @!attribute [rw] last_modified_timestamp
|
1855
|
+
# The timestamp at which the changeset was modified. The value is
|
1856
|
+
# determined as epoch time in milliseconds. For example, the value for
|
1857
|
+
# Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
1858
|
+
# 1635768000000.
|
1859
|
+
# @return [Time]
|
1860
|
+
#
|
1861
|
+
# @!attribute [rw] status
|
1862
|
+
# Status of the changeset.
|
1863
|
+
#
|
1864
|
+
# * Pending – Changeset creation is pending.
|
1865
|
+
#
|
1866
|
+
# * Processing – Changeset creation is running.
|
1867
|
+
#
|
1868
|
+
# * Failed – Changeset creation has failed.
|
1869
|
+
#
|
1870
|
+
# * Complete – Changeset creation has succeeded.
|
1871
|
+
# @return [String]
|
1872
|
+
#
|
1873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxChangesetListEntry AWS API Documentation
|
1874
|
+
#
|
1875
|
+
class KxChangesetListEntry < Struct.new(
|
1876
|
+
:changeset_id,
|
1877
|
+
:created_timestamp,
|
1878
|
+
:active_from_timestamp,
|
1879
|
+
:last_modified_timestamp,
|
1880
|
+
:status)
|
1881
|
+
SENSITIVE = []
|
1882
|
+
include Aws::Structure
|
1883
|
+
end
|
1884
|
+
|
1885
|
+
# The details of a kdb cluster.
|
1886
|
+
#
|
1887
|
+
# @!attribute [rw] status
|
1888
|
+
# The status of a cluster.
|
1889
|
+
#
|
1890
|
+
# * PENDING – The cluster is pending creation.
|
1891
|
+
#
|
1892
|
+
# * CREATING –The cluster creation process is in progress.
|
1893
|
+
#
|
1894
|
+
# * CREATE\_FAILED– The cluster creation process has failed.
|
1895
|
+
#
|
1896
|
+
# * RUNNING – The cluster creation process is running.
|
1897
|
+
#
|
1898
|
+
# * UPDATING – The cluster is in the process of being updated.
|
1899
|
+
#
|
1900
|
+
# * DELETING – The cluster is in the process of being deleted.
|
1901
|
+
#
|
1902
|
+
# * DELETED – The cluster has been deleted.
|
1903
|
+
#
|
1904
|
+
# * DELETE\_FAILED – The cluster failed to delete.
|
1905
|
+
# @return [String]
|
1906
|
+
#
|
1907
|
+
# @!attribute [rw] status_reason
|
1908
|
+
# The error message when a failed state occurs.
|
1909
|
+
# @return [String]
|
1910
|
+
#
|
1911
|
+
# @!attribute [rw] cluster_name
|
1912
|
+
# A unique name for the cluster.
|
1913
|
+
# @return [String]
|
1914
|
+
#
|
1915
|
+
# @!attribute [rw] cluster_type
|
1916
|
+
# Specifies the type of KDB database that is being created. The
|
1917
|
+
# following types are available:
|
1918
|
+
#
|
1919
|
+
# * HDB – A Historical Database. The data is only accessible with
|
1920
|
+
# read-only permissions from one of the FinSpace managed kdb
|
1921
|
+
# databases mounted to the cluster.
|
1922
|
+
#
|
1923
|
+
# * RDB – A Realtime Database. This type of database captures all the
|
1924
|
+
# data from a ticker plant and stores it in memory until the end of
|
1925
|
+
# day, after which it writes all of its data to a disk and reloads
|
1926
|
+
# the HDB. This cluster type requires local storage for temporary
|
1927
|
+
# storage of data during the savedown process. If you specify this
|
1928
|
+
# field in your request, you must provide the
|
1929
|
+
# `savedownStorageConfiguration` parameter.
|
1930
|
+
#
|
1931
|
+
# * GATEWAY – A gateway cluster allows you to access data across
|
1932
|
+
# processes in kdb systems. It allows you to create your own routing
|
1933
|
+
# logic using the initialization scripts and custom code. This type
|
1934
|
+
# of cluster does not require a writable local storage.
|
1935
|
+
# @return [String]
|
1936
|
+
#
|
1937
|
+
# @!attribute [rw] cluster_description
|
1938
|
+
# A description of the cluster.
|
1939
|
+
# @return [String]
|
1940
|
+
#
|
1941
|
+
# @!attribute [rw] release_label
|
1942
|
+
# A version of the FinSpace managed kdb to run.
|
1943
|
+
# @return [String]
|
1944
|
+
#
|
1945
|
+
# @!attribute [rw] initialization_script
|
1946
|
+
# Specifies a Q program that will be run at launch of a cluster. It is
|
1947
|
+
# a relative path within *.zip* file that contains the custom code,
|
1948
|
+
# which will be loaded on the cluster. It must include the file name
|
1949
|
+
# itself. For example, `somedir/init.q`.
|
1950
|
+
# @return [String]
|
1951
|
+
#
|
1952
|
+
# @!attribute [rw] execution_role
|
1953
|
+
# An IAM role that defines a set of permissions associated with a
|
1954
|
+
# cluster. These permissions are assumed when a cluster attempts to
|
1955
|
+
# access another cluster.
|
1956
|
+
# @return [String]
|
1957
|
+
#
|
1958
|
+
# @!attribute [rw] az_mode
|
1959
|
+
# The number of availability zones assigned per cluster. This can be
|
1960
|
+
# one of the following
|
1961
|
+
#
|
1962
|
+
# * `SINGLE` – Assigns one availability zone per cluster.
|
1963
|
+
#
|
1964
|
+
# * `MULTI` – Assigns all the availability zones per cluster.
|
1965
|
+
# @return [String]
|
1966
|
+
#
|
1967
|
+
# @!attribute [rw] availability_zone_id
|
1968
|
+
# The availability zone identifiers for the requested regions.
|
1969
|
+
# @return [String]
|
1970
|
+
#
|
1971
|
+
# @!attribute [rw] last_modified_timestamp
|
1972
|
+
# The last time that the cluster was modified. The value is determined
|
1973
|
+
# as epoch time in milliseconds. For example, the value for Monday,
|
1974
|
+
# November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
|
1975
|
+
# @return [Time]
|
1976
|
+
#
|
1977
|
+
# @!attribute [rw] created_timestamp
|
1978
|
+
# The timestamp at which the cluster was created in FinSpace. The
|
1979
|
+
# value is determined as epoch time in milliseconds. For example, the
|
1980
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
1981
|
+
# 1635768000000.
|
1982
|
+
# @return [Time]
|
1983
|
+
#
|
1984
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxCluster AWS API Documentation
|
1985
|
+
#
|
1986
|
+
class KxCluster < Struct.new(
|
1987
|
+
:status,
|
1988
|
+
:status_reason,
|
1989
|
+
:cluster_name,
|
1990
|
+
:cluster_type,
|
1991
|
+
:cluster_description,
|
1992
|
+
:release_label,
|
1993
|
+
:initialization_script,
|
1994
|
+
:execution_role,
|
1995
|
+
:az_mode,
|
1996
|
+
:availability_zone_id,
|
1997
|
+
:last_modified_timestamp,
|
1998
|
+
:created_timestamp)
|
1999
|
+
SENSITIVE = []
|
2000
|
+
include Aws::Structure
|
2001
|
+
end
|
2002
|
+
|
2003
|
+
# Defines the key-value pairs to make them available inside the cluster.
|
2004
|
+
#
|
2005
|
+
# @!attribute [rw] key
|
2006
|
+
# The name of the key.
|
2007
|
+
# @return [String]
|
2008
|
+
#
|
2009
|
+
# @!attribute [rw] value
|
2010
|
+
# The value of the key.
|
2011
|
+
# @return [String]
|
2012
|
+
#
|
2013
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxCommandLineArgument AWS API Documentation
|
2014
|
+
#
|
2015
|
+
class KxCommandLineArgument < Struct.new(
|
2016
|
+
:key,
|
2017
|
+
:value)
|
2018
|
+
SENSITIVE = []
|
2019
|
+
include Aws::Structure
|
2020
|
+
end
|
2021
|
+
|
2022
|
+
# The structure of database cache configuration that is used for mapping
|
2023
|
+
# database paths to cache types in clusters.
|
2024
|
+
#
|
2025
|
+
# @!attribute [rw] cache_type
|
2026
|
+
# The type of disk cache. This parameter is used to map the database
|
2027
|
+
# path to cache storage. The valid values are:
|
2028
|
+
#
|
2029
|
+
# * CACHE\_1000 – This type provides at least 1000 MB/s disk access
|
2030
|
+
# throughput.
|
2031
|
+
#
|
2032
|
+
# ^
|
2033
|
+
# @return [String]
|
2034
|
+
#
|
2035
|
+
# @!attribute [rw] db_paths
|
2036
|
+
# Specifies the portions of database that will be loaded into the
|
2037
|
+
# cache for access.
|
2038
|
+
# @return [Array<String>]
|
2039
|
+
#
|
2040
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxDatabaseCacheConfiguration AWS API Documentation
|
2041
|
+
#
|
2042
|
+
class KxDatabaseCacheConfiguration < Struct.new(
|
2043
|
+
:cache_type,
|
2044
|
+
:db_paths)
|
2045
|
+
SENSITIVE = []
|
2046
|
+
include Aws::Structure
|
2047
|
+
end
|
2048
|
+
|
2049
|
+
# The configuration of data that is available for querying from this
|
2050
|
+
# database.
|
2051
|
+
#
|
2052
|
+
# @!attribute [rw] database_name
|
2053
|
+
# The name of the kdb database. When this parameter is specified in
|
2054
|
+
# the structure, S3 with the whole database is included by default.
|
2055
|
+
# @return [String]
|
2056
|
+
#
|
2057
|
+
# @!attribute [rw] cache_configurations
|
2058
|
+
# Configuration details for the disk cache used to increase
|
2059
|
+
# performance reading from a kdb database mounted to the cluster.
|
2060
|
+
# @return [Array<Types::KxDatabaseCacheConfiguration>]
|
2061
|
+
#
|
2062
|
+
# @!attribute [rw] changeset_id
|
2063
|
+
# A unique identifier of the changeset that is associated with the
|
2064
|
+
# cluster.
|
2065
|
+
# @return [String]
|
2066
|
+
#
|
2067
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxDatabaseConfiguration AWS API Documentation
|
2068
|
+
#
|
2069
|
+
class KxDatabaseConfiguration < Struct.new(
|
2070
|
+
:database_name,
|
2071
|
+
:cache_configurations,
|
2072
|
+
:changeset_id)
|
2073
|
+
SENSITIVE = []
|
2074
|
+
include Aws::Structure
|
2075
|
+
end
|
2076
|
+
|
2077
|
+
# Details about a FinSpace managed kdb database
|
2078
|
+
#
|
2079
|
+
# @!attribute [rw] database_name
|
2080
|
+
# The name of the kdb database.
|
2081
|
+
# @return [String]
|
2082
|
+
#
|
2083
|
+
# @!attribute [rw] created_timestamp
|
2084
|
+
# The timestamp at which the database was created in FinSpace. The
|
2085
|
+
# value is determined as epoch time in milliseconds. For example, the
|
2086
|
+
# value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
2087
|
+
# 1635768000000.
|
2088
|
+
# @return [Time]
|
2089
|
+
#
|
2090
|
+
# @!attribute [rw] last_modified_timestamp
|
2091
|
+
# The last time that the database was modified. The value is
|
2092
|
+
# determined as epoch time in milliseconds. For example, the value for
|
2093
|
+
# Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
2094
|
+
# 1635768000000.
|
2095
|
+
# @return [Time]
|
2096
|
+
#
|
2097
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxDatabaseListEntry AWS API Documentation
|
2098
|
+
#
|
2099
|
+
class KxDatabaseListEntry < Struct.new(
|
2100
|
+
:database_name,
|
2101
|
+
:created_timestamp,
|
2102
|
+
:last_modified_timestamp)
|
2103
|
+
SENSITIVE = []
|
2104
|
+
include Aws::Structure
|
2105
|
+
end
|
2106
|
+
|
2107
|
+
# The details of a kdb environment.
|
2108
|
+
#
|
2109
|
+
# @!attribute [rw] name
|
2110
|
+
# The name of the kdb environment.
|
2111
|
+
# @return [String]
|
2112
|
+
#
|
2113
|
+
# @!attribute [rw] environment_id
|
2114
|
+
# A unique identifier for the kdb environment.
|
2115
|
+
# @return [String]
|
2116
|
+
#
|
2117
|
+
# @!attribute [rw] aws_account_id
|
2118
|
+
# The unique identifier of the AWS account in which you create the kdb
|
2119
|
+
# environment.
|
2120
|
+
# @return [String]
|
2121
|
+
#
|
2122
|
+
# @!attribute [rw] status
|
2123
|
+
# The status of the environment creation.
|
2124
|
+
#
|
2125
|
+
# * CREATE\_REQUESTED – Environment creation has been requested.
|
2126
|
+
#
|
2127
|
+
# * CREATING – Environment is in the process of being created.
|
2128
|
+
#
|
2129
|
+
# * FAILED\_CREATION – Environment creation has failed.
|
2130
|
+
#
|
2131
|
+
# * CREATED – Environment is successfully created and is currently
|
2132
|
+
# active.
|
2133
|
+
#
|
2134
|
+
# * DELETE REQUESTED – Environment deletion has been requested.
|
2135
|
+
#
|
2136
|
+
# * DELETING – Environment is in the process of being deleted.
|
2137
|
+
#
|
2138
|
+
# * RETRY\_DELETION – Initial environment deletion failed, system is
|
2139
|
+
# reattempting delete.
|
2140
|
+
#
|
2141
|
+
# * DELETED – Environment has been deleted.
|
2142
|
+
#
|
2143
|
+
# * FAILED\_DELETION – Environment deletion has failed.
|
2144
|
+
# @return [String]
|
2145
|
+
#
|
2146
|
+
# @!attribute [rw] tgw_status
|
2147
|
+
# The status of the network configuration.
|
2148
|
+
# @return [String]
|
2149
|
+
#
|
2150
|
+
# @!attribute [rw] dns_status
|
2151
|
+
# The status of DNS configuration.
|
2152
|
+
# @return [String]
|
2153
|
+
#
|
2154
|
+
# @!attribute [rw] error_message
|
2155
|
+
# Specifies the error message that appears if a flow fails.
|
2156
|
+
# @return [String]
|
2157
|
+
#
|
2158
|
+
# @!attribute [rw] description
|
2159
|
+
# A description of the kdb environment.
|
2160
|
+
# @return [String]
|
2161
|
+
#
|
2162
|
+
# @!attribute [rw] environment_arn
|
2163
|
+
# The Amazon Resource Name (ARN) of your kdb environment.
|
2164
|
+
# @return [String]
|
2165
|
+
#
|
2166
|
+
# @!attribute [rw] kms_key_id
|
2167
|
+
# The unique identifier of the KMS key.
|
2168
|
+
# @return [String]
|
2169
|
+
#
|
2170
|
+
# @!attribute [rw] dedicated_service_account_id
|
2171
|
+
# A unique identifier for the AWS environment infrastructure account.
|
2172
|
+
# @return [String]
|
2173
|
+
#
|
2174
|
+
# @!attribute [rw] transit_gateway_configuration
|
2175
|
+
# Specifies the transit gateway and network configuration to connect
|
2176
|
+
# the kdb environment to an internal network.
|
2177
|
+
# @return [Types::TransitGatewayConfiguration]
|
2178
|
+
#
|
2179
|
+
# @!attribute [rw] custom_dns_configuration
|
2180
|
+
# A list of DNS server name and server IP. This is used to set up
|
2181
|
+
# Route-53 outbound resolvers.
|
2182
|
+
# @return [Array<Types::CustomDNSServer>]
|
2183
|
+
#
|
2184
|
+
# @!attribute [rw] creation_timestamp
|
2185
|
+
# The timestamp at which the kdb environment was created in FinSpace.
|
2186
|
+
# The value is determined as epoch time in milliseconds. For example,
|
2187
|
+
# the value for Monday, November 1, 2021 12:00:00 PM UTC is specified
|
2188
|
+
# as 1635768000000.
|
2189
|
+
# @return [Time]
|
2190
|
+
#
|
2191
|
+
# @!attribute [rw] update_timestamp
|
2192
|
+
# The timestamp at which the kdb environment was modified in FinSpace.
|
2193
|
+
# The value is determined as epoch time in milliseconds. For example,
|
2194
|
+
# the value for Monday, November 1, 2021 12:00:00 PM UTC is specified
|
2195
|
+
# as 1635768000000.
|
2196
|
+
# @return [Time]
|
2197
|
+
#
|
2198
|
+
# @!attribute [rw] availability_zone_ids
|
2199
|
+
# The identifier of the availability zones where subnets for the
|
2200
|
+
# environment are created.
|
2201
|
+
# @return [Array<String>]
|
2202
|
+
#
|
2203
|
+
# @!attribute [rw] certificate_authority_arn
|
2204
|
+
# The Amazon Resource Name (ARN) of the certificate authority:
|
2205
|
+
# @return [String]
|
2206
|
+
#
|
2207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxEnvironment AWS API Documentation
|
2208
|
+
#
|
2209
|
+
class KxEnvironment < Struct.new(
|
2210
|
+
:name,
|
2211
|
+
:environment_id,
|
2212
|
+
:aws_account_id,
|
2213
|
+
:status,
|
2214
|
+
:tgw_status,
|
2215
|
+
:dns_status,
|
2216
|
+
:error_message,
|
2217
|
+
:description,
|
2218
|
+
:environment_arn,
|
2219
|
+
:kms_key_id,
|
2220
|
+
:dedicated_service_account_id,
|
2221
|
+
:transit_gateway_configuration,
|
2222
|
+
:custom_dns_configuration,
|
2223
|
+
:creation_timestamp,
|
2224
|
+
:update_timestamp,
|
2225
|
+
:availability_zone_ids,
|
2226
|
+
:certificate_authority_arn)
|
2227
|
+
SENSITIVE = []
|
2228
|
+
include Aws::Structure
|
2229
|
+
end
|
2230
|
+
|
2231
|
+
# A structure that stores metadata for a kdb node.
|
2232
|
+
#
|
2233
|
+
# @!attribute [rw] node_id
|
2234
|
+
# A unique identifier for the node.
|
2235
|
+
# @return [String]
|
2236
|
+
#
|
2237
|
+
# @!attribute [rw] availability_zone_id
|
2238
|
+
# The identifier of the availability zones where subnets for the
|
2239
|
+
# environment are created.
|
2240
|
+
# @return [String]
|
2241
|
+
#
|
2242
|
+
# @!attribute [rw] launch_time
|
2243
|
+
# The time when a particular node is started. The value is determined
|
2244
|
+
# as epoch time in milliseconds. For example, the value for Monday,
|
2245
|
+
# November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
|
2246
|
+
# @return [Time]
|
2247
|
+
#
|
2248
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxNode AWS API Documentation
|
2249
|
+
#
|
2250
|
+
class KxNode < Struct.new(
|
2251
|
+
:node_id,
|
2252
|
+
:availability_zone_id,
|
2253
|
+
:launch_time)
|
2254
|
+
SENSITIVE = []
|
2255
|
+
include Aws::Structure
|
2256
|
+
end
|
2257
|
+
|
2258
|
+
# The size and type of temporary storage that is used to hold data
|
2259
|
+
# during the savedown process. All the data written to this storage
|
2260
|
+
# space is lost when the cluster node is restarted.
|
2261
|
+
#
|
2262
|
+
# @!attribute [rw] type
|
2263
|
+
# The type of writeable storage space for temporarily storing your
|
2264
|
+
# savedown data. The valid values are:
|
2265
|
+
#
|
2266
|
+
# * SDS01 – This type represents 3000 IOPS and io2 ebs volume type.
|
2267
|
+
#
|
2268
|
+
# ^
|
2269
|
+
# @return [String]
|
2270
|
+
#
|
2271
|
+
# @!attribute [rw] size
|
2272
|
+
# The size of temporary storage in bytes.
|
2273
|
+
# @return [Integer]
|
2274
|
+
#
|
2275
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxSavedownStorageConfiguration AWS API Documentation
|
2276
|
+
#
|
2277
|
+
class KxSavedownStorageConfiguration < Struct.new(
|
2278
|
+
:type,
|
2279
|
+
:size)
|
2280
|
+
SENSITIVE = []
|
2281
|
+
include Aws::Structure
|
2282
|
+
end
|
2283
|
+
|
2284
|
+
# A structure that stores metadata for a kdb user.
|
2285
|
+
#
|
2286
|
+
# @!attribute [rw] user_arn
|
2287
|
+
# The Amazon Resource Name (ARN) that identifies the user. For more
|
2288
|
+
# information about ARNs and how to use ARNs in policies, see [IAM
|
2289
|
+
# Identifiers](IAM/latest/UserGuide/reference_identifiers.html) in the
|
2290
|
+
# *IAM User Guide*.
|
2291
|
+
# @return [String]
|
2292
|
+
#
|
2293
|
+
# @!attribute [rw] user_name
|
2294
|
+
# A unique identifier for the user.
|
2295
|
+
# @return [String]
|
2296
|
+
#
|
2297
|
+
# @!attribute [rw] iam_role
|
2298
|
+
# The IAM role ARN that is associated with the user.
|
2299
|
+
# @return [String]
|
2300
|
+
#
|
2301
|
+
# @!attribute [rw] create_timestamp
|
2302
|
+
# The timestamp at which the kdb user was created.
|
2303
|
+
# @return [Time]
|
2304
|
+
#
|
2305
|
+
# @!attribute [rw] update_timestamp
|
2306
|
+
# The timestamp at which the kdb user was updated.
|
2307
|
+
# @return [Time]
|
2308
|
+
#
|
2309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxUser AWS API Documentation
|
2310
|
+
#
|
2311
|
+
class KxUser < Struct.new(
|
2312
|
+
:user_arn,
|
2313
|
+
:user_name,
|
2314
|
+
:iam_role,
|
2315
|
+
:create_timestamp,
|
2316
|
+
:update_timestamp)
|
289
2317
|
SENSITIVE = []
|
290
2318
|
include Aws::Structure
|
291
2319
|
end
|
@@ -306,8 +2334,8 @@ module Aws::Finspace
|
|
306
2334
|
# @!attribute [rw] next_token
|
307
2335
|
# A token generated by FinSpace that specifies where to continue
|
308
2336
|
# pagination if a previous request was truncated. To get the next set
|
309
|
-
# of pages, pass in the nextToken value from the response
|
310
|
-
# the previous page call.
|
2337
|
+
# of pages, pass in the `nextToken`nextToken value from the response
|
2338
|
+
# object of the previous page call.
|
311
2339
|
# @return [String]
|
312
2340
|
#
|
313
2341
|
# @!attribute [rw] max_results
|
@@ -323,19 +2351,281 @@ module Aws::Finspace
|
|
323
2351
|
include Aws::Structure
|
324
2352
|
end
|
325
2353
|
|
326
|
-
# @!attribute [rw] environments
|
327
|
-
# A list of all of your FinSpace environments.
|
328
|
-
# @return [Array<Types::Environment>]
|
2354
|
+
# @!attribute [rw] environments
|
2355
|
+
# A list of all of your FinSpace environments.
|
2356
|
+
# @return [Array<Types::Environment>]
|
2357
|
+
#
|
2358
|
+
# @!attribute [rw] next_token
|
2359
|
+
# A token that you can use in a subsequent call to retrieve the next
|
2360
|
+
# set of results.
|
2361
|
+
# @return [String]
|
2362
|
+
#
|
2363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListEnvironmentsResponse AWS API Documentation
|
2364
|
+
#
|
2365
|
+
class ListEnvironmentsResponse < Struct.new(
|
2366
|
+
:environments,
|
2367
|
+
:next_token)
|
2368
|
+
SENSITIVE = []
|
2369
|
+
include Aws::Structure
|
2370
|
+
end
|
2371
|
+
|
2372
|
+
# @!attribute [rw] environment_id
|
2373
|
+
# A unique identifier for the kdb environment.
|
2374
|
+
# @return [String]
|
2375
|
+
#
|
2376
|
+
# @!attribute [rw] database_name
|
2377
|
+
# The name of the kdb database.
|
2378
|
+
# @return [String]
|
2379
|
+
#
|
2380
|
+
# @!attribute [rw] next_token
|
2381
|
+
# A token that indicates where a results page should begin.
|
2382
|
+
# @return [String]
|
2383
|
+
#
|
2384
|
+
# @!attribute [rw] max_results
|
2385
|
+
# The maximum number of results to return in this request.
|
2386
|
+
# @return [Integer]
|
2387
|
+
#
|
2388
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxChangesetsRequest AWS API Documentation
|
2389
|
+
#
|
2390
|
+
class ListKxChangesetsRequest < Struct.new(
|
2391
|
+
:environment_id,
|
2392
|
+
:database_name,
|
2393
|
+
:next_token,
|
2394
|
+
:max_results)
|
2395
|
+
SENSITIVE = []
|
2396
|
+
include Aws::Structure
|
2397
|
+
end
|
2398
|
+
|
2399
|
+
# @!attribute [rw] kx_changesets
|
2400
|
+
# A list of changesets for a database.
|
2401
|
+
# @return [Array<Types::KxChangesetListEntry>]
|
2402
|
+
#
|
2403
|
+
# @!attribute [rw] next_token
|
2404
|
+
# A token that indicates where a results page should begin.
|
2405
|
+
# @return [String]
|
2406
|
+
#
|
2407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxChangesetsResponse AWS API Documentation
|
2408
|
+
#
|
2409
|
+
class ListKxChangesetsResponse < Struct.new(
|
2410
|
+
:kx_changesets,
|
2411
|
+
:next_token)
|
2412
|
+
SENSITIVE = []
|
2413
|
+
include Aws::Structure
|
2414
|
+
end
|
2415
|
+
|
2416
|
+
# @!attribute [rw] environment_id
|
2417
|
+
# A unique identifier for the kdb environment.
|
2418
|
+
# @return [String]
|
2419
|
+
#
|
2420
|
+
# @!attribute [rw] cluster_name
|
2421
|
+
# A unique name for the cluster.
|
2422
|
+
# @return [String]
|
2423
|
+
#
|
2424
|
+
# @!attribute [rw] next_token
|
2425
|
+
# A token that indicates where a results page should begin.
|
2426
|
+
# @return [String]
|
2427
|
+
#
|
2428
|
+
# @!attribute [rw] max_results
|
2429
|
+
# The maximum number of results to return in this request.
|
2430
|
+
# @return [Integer]
|
2431
|
+
#
|
2432
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxClusterNodesRequest AWS API Documentation
|
2433
|
+
#
|
2434
|
+
class ListKxClusterNodesRequest < Struct.new(
|
2435
|
+
:environment_id,
|
2436
|
+
:cluster_name,
|
2437
|
+
:next_token,
|
2438
|
+
:max_results)
|
2439
|
+
SENSITIVE = []
|
2440
|
+
include Aws::Structure
|
2441
|
+
end
|
2442
|
+
|
2443
|
+
# @!attribute [rw] nodes
|
2444
|
+
# A list of nodes associated with the cluster.
|
2445
|
+
# @return [Array<Types::KxNode>]
|
2446
|
+
#
|
2447
|
+
# @!attribute [rw] next_token
|
2448
|
+
# A token that indicates where a results page should begin.
|
2449
|
+
# @return [String]
|
2450
|
+
#
|
2451
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxClusterNodesResponse AWS API Documentation
|
2452
|
+
#
|
2453
|
+
class ListKxClusterNodesResponse < Struct.new(
|
2454
|
+
:nodes,
|
2455
|
+
:next_token)
|
2456
|
+
SENSITIVE = []
|
2457
|
+
include Aws::Structure
|
2458
|
+
end
|
2459
|
+
|
2460
|
+
# @!attribute [rw] environment_id
|
2461
|
+
# A unique identifier for the kdb environment.
|
2462
|
+
# @return [String]
|
2463
|
+
#
|
2464
|
+
# @!attribute [rw] cluster_type
|
2465
|
+
# Specifies the type of KDB database that is being created. The
|
2466
|
+
# following types are available:
|
2467
|
+
#
|
2468
|
+
# * HDB – A Historical Database. The data is only accessible with
|
2469
|
+
# read-only permissions from one of the FinSpace managed kdb
|
2470
|
+
# databases mounted to the cluster.
|
2471
|
+
#
|
2472
|
+
# * RDB – A Realtime Database. This type of database captures all the
|
2473
|
+
# data from a ticker plant and stores it in memory until the end of
|
2474
|
+
# day, after which it writes all of its data to a disk and reloads
|
2475
|
+
# the HDB. This cluster type requires local storage for temporary
|
2476
|
+
# storage of data during the savedown process. If you specify this
|
2477
|
+
# field in your request, you must provide the
|
2478
|
+
# `savedownStorageConfiguration` parameter.
|
2479
|
+
#
|
2480
|
+
# * GATEWAY – A gateway cluster allows you to access data across
|
2481
|
+
# processes in kdb systems. It allows you to create your own routing
|
2482
|
+
# logic using the initialization scripts and custom code. This type
|
2483
|
+
# of cluster does not require a writable local storage.
|
2484
|
+
# @return [String]
|
2485
|
+
#
|
2486
|
+
# @!attribute [rw] max_results
|
2487
|
+
# The maximum number of results to return in this request.
|
2488
|
+
# @return [Integer]
|
2489
|
+
#
|
2490
|
+
# @!attribute [rw] next_token
|
2491
|
+
# A token that indicates where a results page should begin.
|
2492
|
+
# @return [String]
|
2493
|
+
#
|
2494
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxClustersRequest AWS API Documentation
|
2495
|
+
#
|
2496
|
+
class ListKxClustersRequest < Struct.new(
|
2497
|
+
:environment_id,
|
2498
|
+
:cluster_type,
|
2499
|
+
:max_results,
|
2500
|
+
:next_token)
|
2501
|
+
SENSITIVE = []
|
2502
|
+
include Aws::Structure
|
2503
|
+
end
|
2504
|
+
|
2505
|
+
# @!attribute [rw] kx_cluster_summaries
|
2506
|
+
# Lists the cluster details.
|
2507
|
+
# @return [Array<Types::KxCluster>]
|
2508
|
+
#
|
2509
|
+
# @!attribute [rw] next_token
|
2510
|
+
# A token that indicates where a results page should begin.
|
2511
|
+
# @return [String]
|
2512
|
+
#
|
2513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxClustersResponse AWS API Documentation
|
2514
|
+
#
|
2515
|
+
class ListKxClustersResponse < Struct.new(
|
2516
|
+
:kx_cluster_summaries,
|
2517
|
+
:next_token)
|
2518
|
+
SENSITIVE = []
|
2519
|
+
include Aws::Structure
|
2520
|
+
end
|
2521
|
+
|
2522
|
+
# @!attribute [rw] environment_id
|
2523
|
+
# A unique identifier for the kdb environment.
|
2524
|
+
# @return [String]
|
2525
|
+
#
|
2526
|
+
# @!attribute [rw] next_token
|
2527
|
+
# A token that indicates where a results page should begin.
|
2528
|
+
# @return [String]
|
2529
|
+
#
|
2530
|
+
# @!attribute [rw] max_results
|
2531
|
+
# The maximum number of results to return in this request.
|
2532
|
+
# @return [Integer]
|
2533
|
+
#
|
2534
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxDatabasesRequest AWS API Documentation
|
2535
|
+
#
|
2536
|
+
class ListKxDatabasesRequest < Struct.new(
|
2537
|
+
:environment_id,
|
2538
|
+
:next_token,
|
2539
|
+
:max_results)
|
2540
|
+
SENSITIVE = []
|
2541
|
+
include Aws::Structure
|
2542
|
+
end
|
2543
|
+
|
2544
|
+
# @!attribute [rw] kx_databases
|
2545
|
+
# A list of databases in the kdb environment.
|
2546
|
+
# @return [Array<Types::KxDatabaseListEntry>]
|
2547
|
+
#
|
2548
|
+
# @!attribute [rw] next_token
|
2549
|
+
# A token that indicates where a results page should begin.
|
2550
|
+
# @return [String]
|
2551
|
+
#
|
2552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxDatabasesResponse AWS API Documentation
|
2553
|
+
#
|
2554
|
+
class ListKxDatabasesResponse < Struct.new(
|
2555
|
+
:kx_databases,
|
2556
|
+
:next_token)
|
2557
|
+
SENSITIVE = []
|
2558
|
+
include Aws::Structure
|
2559
|
+
end
|
2560
|
+
|
2561
|
+
# @!attribute [rw] next_token
|
2562
|
+
# A token that indicates where a results page should begin.
|
2563
|
+
# @return [String]
|
2564
|
+
#
|
2565
|
+
# @!attribute [rw] max_results
|
2566
|
+
# The maximum number of results to return in this request.
|
2567
|
+
# @return [Integer]
|
2568
|
+
#
|
2569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxEnvironmentsRequest AWS API Documentation
|
2570
|
+
#
|
2571
|
+
class ListKxEnvironmentsRequest < Struct.new(
|
2572
|
+
:next_token,
|
2573
|
+
:max_results)
|
2574
|
+
SENSITIVE = []
|
2575
|
+
include Aws::Structure
|
2576
|
+
end
|
2577
|
+
|
2578
|
+
# @!attribute [rw] environments
|
2579
|
+
# A list of environments in an account.
|
2580
|
+
# @return [Array<Types::KxEnvironment>]
|
2581
|
+
#
|
2582
|
+
# @!attribute [rw] next_token
|
2583
|
+
# A token that indicates where a results page should begin.
|
2584
|
+
# @return [String]
|
2585
|
+
#
|
2586
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxEnvironmentsResponse AWS API Documentation
|
2587
|
+
#
|
2588
|
+
class ListKxEnvironmentsResponse < Struct.new(
|
2589
|
+
:environments,
|
2590
|
+
:next_token)
|
2591
|
+
SENSITIVE = []
|
2592
|
+
include Aws::Structure
|
2593
|
+
end
|
2594
|
+
|
2595
|
+
# @!attribute [rw] environment_id
|
2596
|
+
# A unique identifier for the kdb environment.
|
2597
|
+
# @return [String]
|
2598
|
+
#
|
2599
|
+
# @!attribute [rw] next_token
|
2600
|
+
# A token that indicates where a results page should begin.
|
2601
|
+
# @return [String]
|
2602
|
+
#
|
2603
|
+
# @!attribute [rw] max_results
|
2604
|
+
# The maximum number of results to return in this request.
|
2605
|
+
# @return [Integer]
|
2606
|
+
#
|
2607
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxUsersRequest AWS API Documentation
|
2608
|
+
#
|
2609
|
+
class ListKxUsersRequest < Struct.new(
|
2610
|
+
:environment_id,
|
2611
|
+
:next_token,
|
2612
|
+
:max_results)
|
2613
|
+
SENSITIVE = []
|
2614
|
+
include Aws::Structure
|
2615
|
+
end
|
2616
|
+
|
2617
|
+
# @!attribute [rw] users
|
2618
|
+
# A list of users in a kdb environment.
|
2619
|
+
# @return [Array<Types::KxUser>]
|
329
2620
|
#
|
330
2621
|
# @!attribute [rw] next_token
|
331
|
-
# A token that
|
332
|
-
# set of results.
|
2622
|
+
# A token that indicates where a results page should begin.
|
333
2623
|
# @return [String]
|
334
2624
|
#
|
335
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/
|
2625
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxUsersResponse AWS API Documentation
|
336
2626
|
#
|
337
|
-
class
|
338
|
-
:
|
2627
|
+
class ListKxUsersResponse < Struct.new(
|
2628
|
+
:users,
|
339
2629
|
:next_token)
|
340
2630
|
SENSITIVE = []
|
341
2631
|
include Aws::Structure
|
@@ -365,6 +2655,19 @@ module Aws::Finspace
|
|
365
2655
|
include Aws::Structure
|
366
2656
|
end
|
367
2657
|
|
2658
|
+
# The specified resource group already exists.
|
2659
|
+
#
|
2660
|
+
# @!attribute [rw] message
|
2661
|
+
# @return [String]
|
2662
|
+
#
|
2663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ResourceAlreadyExistsException AWS API Documentation
|
2664
|
+
#
|
2665
|
+
class ResourceAlreadyExistsException < Struct.new(
|
2666
|
+
:message)
|
2667
|
+
SENSITIVE = []
|
2668
|
+
include Aws::Structure
|
2669
|
+
end
|
2670
|
+
|
368
2671
|
# One or more resources can't be found.
|
369
2672
|
#
|
370
2673
|
# @!attribute [rw] message
|
@@ -444,6 +2747,30 @@ module Aws::Finspace
|
|
444
2747
|
#
|
445
2748
|
class ThrottlingException < Aws::EmptyStructure; end
|
446
2749
|
|
2750
|
+
# The structure of the transit gateway and network configuration that is
|
2751
|
+
# used to connect the kdb environment to an internal network.
|
2752
|
+
#
|
2753
|
+
# @!attribute [rw] transit_gateway_id
|
2754
|
+
# The identifier of the transit gateway created by the customer to
|
2755
|
+
# connect outbound traffics from kdb network to your internal network.
|
2756
|
+
# @return [String]
|
2757
|
+
#
|
2758
|
+
# @!attribute [rw] routable_cidr_space
|
2759
|
+
# The routing CIDR on behalf of kdb environment. It could be any "/26
|
2760
|
+
# range in the 100.64.0.0 CIDR space. After providing, it will be
|
2761
|
+
# added to the customer's transit gateway routing table so that the
|
2762
|
+
# traffics could be routed to kdb network.
|
2763
|
+
# @return [String]
|
2764
|
+
#
|
2765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/TransitGatewayConfiguration AWS API Documentation
|
2766
|
+
#
|
2767
|
+
class TransitGatewayConfiguration < Struct.new(
|
2768
|
+
:transit_gateway_id,
|
2769
|
+
:routable_cidr_space)
|
2770
|
+
SENSITIVE = []
|
2771
|
+
include Aws::Structure
|
2772
|
+
end
|
2773
|
+
|
447
2774
|
# @!attribute [rw] resource_arn
|
448
2775
|
# A FinSpace resource from which you want to remove a tag or tags. The
|
449
2776
|
# value for this parameter is an Amazon Resource Name (ARN).
|
@@ -516,6 +2843,392 @@ module Aws::Finspace
|
|
516
2843
|
include Aws::Structure
|
517
2844
|
end
|
518
2845
|
|
2846
|
+
# @!attribute [rw] environment_id
|
2847
|
+
# The unique identifier of a kdb environment.
|
2848
|
+
# @return [String]
|
2849
|
+
#
|
2850
|
+
# @!attribute [rw] cluster_name
|
2851
|
+
# A unique name for the cluster that you want to modify.
|
2852
|
+
# @return [String]
|
2853
|
+
#
|
2854
|
+
# @!attribute [rw] client_token
|
2855
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
2856
|
+
# @return [String]
|
2857
|
+
#
|
2858
|
+
# @!attribute [rw] databases
|
2859
|
+
# The structure of databases mounted on the cluster.
|
2860
|
+
# @return [Array<Types::KxDatabaseConfiguration>]
|
2861
|
+
#
|
2862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxClusterDatabasesRequest AWS API Documentation
|
2863
|
+
#
|
2864
|
+
class UpdateKxClusterDatabasesRequest < Struct.new(
|
2865
|
+
:environment_id,
|
2866
|
+
:cluster_name,
|
2867
|
+
:client_token,
|
2868
|
+
:databases)
|
2869
|
+
SENSITIVE = []
|
2870
|
+
include Aws::Structure
|
2871
|
+
end
|
2872
|
+
|
2873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxClusterDatabasesResponse AWS API Documentation
|
2874
|
+
#
|
2875
|
+
class UpdateKxClusterDatabasesResponse < Aws::EmptyStructure; end
|
2876
|
+
|
2877
|
+
# @!attribute [rw] environment_id
|
2878
|
+
# A unique identifier for the kdb environment.
|
2879
|
+
# @return [String]
|
2880
|
+
#
|
2881
|
+
# @!attribute [rw] database_name
|
2882
|
+
# The name of the kdb database.
|
2883
|
+
# @return [String]
|
2884
|
+
#
|
2885
|
+
# @!attribute [rw] description
|
2886
|
+
# A description of the database.
|
2887
|
+
# @return [String]
|
2888
|
+
#
|
2889
|
+
# @!attribute [rw] client_token
|
2890
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
2891
|
+
#
|
2892
|
+
# **A suitable default value is auto-generated.** You should normally
|
2893
|
+
# not need to pass this option.
|
2894
|
+
# @return [String]
|
2895
|
+
#
|
2896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxDatabaseRequest AWS API Documentation
|
2897
|
+
#
|
2898
|
+
class UpdateKxDatabaseRequest < Struct.new(
|
2899
|
+
:environment_id,
|
2900
|
+
:database_name,
|
2901
|
+
:description,
|
2902
|
+
:client_token)
|
2903
|
+
SENSITIVE = []
|
2904
|
+
include Aws::Structure
|
2905
|
+
end
|
2906
|
+
|
2907
|
+
# @!attribute [rw] database_name
|
2908
|
+
# The name of the kdb database.
|
2909
|
+
# @return [String]
|
2910
|
+
#
|
2911
|
+
# @!attribute [rw] environment_id
|
2912
|
+
# A unique identifier for the kdb environment.
|
2913
|
+
# @return [String]
|
2914
|
+
#
|
2915
|
+
# @!attribute [rw] description
|
2916
|
+
# A description of the database.
|
2917
|
+
# @return [String]
|
2918
|
+
#
|
2919
|
+
# @!attribute [rw] last_modified_timestamp
|
2920
|
+
# The last time that the database was modified. The value is
|
2921
|
+
# determined as epoch time in milliseconds. For example, the value for
|
2922
|
+
# Monday, November 1, 2021 12:00:00 PM UTC is specified as
|
2923
|
+
# 1635768000000.
|
2924
|
+
# @return [Time]
|
2925
|
+
#
|
2926
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxDatabaseResponse AWS API Documentation
|
2927
|
+
#
|
2928
|
+
class UpdateKxDatabaseResponse < Struct.new(
|
2929
|
+
:database_name,
|
2930
|
+
:environment_id,
|
2931
|
+
:description,
|
2932
|
+
:last_modified_timestamp)
|
2933
|
+
SENSITIVE = []
|
2934
|
+
include Aws::Structure
|
2935
|
+
end
|
2936
|
+
|
2937
|
+
# @!attribute [rw] environment_id
|
2938
|
+
# A unique identifier for the kdb environment.
|
2939
|
+
# @return [String]
|
2940
|
+
#
|
2941
|
+
# @!attribute [rw] transit_gateway_configuration
|
2942
|
+
# Specifies the transit gateway and network configuration to connect
|
2943
|
+
# the kdb environment to an internal network.
|
2944
|
+
# @return [Types::TransitGatewayConfiguration]
|
2945
|
+
#
|
2946
|
+
# @!attribute [rw] custom_dns_configuration
|
2947
|
+
# A list of DNS server name and server IP. This is used to set up
|
2948
|
+
# Route-53 outbound resolvers.
|
2949
|
+
# @return [Array<Types::CustomDNSServer>]
|
2950
|
+
#
|
2951
|
+
# @!attribute [rw] client_token
|
2952
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
2953
|
+
# @return [String]
|
2954
|
+
#
|
2955
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxEnvironmentNetworkRequest AWS API Documentation
|
2956
|
+
#
|
2957
|
+
class UpdateKxEnvironmentNetworkRequest < Struct.new(
|
2958
|
+
:environment_id,
|
2959
|
+
:transit_gateway_configuration,
|
2960
|
+
:custom_dns_configuration,
|
2961
|
+
:client_token)
|
2962
|
+
SENSITIVE = []
|
2963
|
+
include Aws::Structure
|
2964
|
+
end
|
2965
|
+
|
2966
|
+
# @!attribute [rw] name
|
2967
|
+
# The name of the kdb environment.
|
2968
|
+
# @return [String]
|
2969
|
+
#
|
2970
|
+
# @!attribute [rw] environment_id
|
2971
|
+
# A unique identifier for the kdb environment.
|
2972
|
+
# @return [String]
|
2973
|
+
#
|
2974
|
+
# @!attribute [rw] aws_account_id
|
2975
|
+
# The unique identifier of the AWS account that is used to create the
|
2976
|
+
# kdb environment.
|
2977
|
+
# @return [String]
|
2978
|
+
#
|
2979
|
+
# @!attribute [rw] status
|
2980
|
+
# The status of the kdb environment.
|
2981
|
+
# @return [String]
|
2982
|
+
#
|
2983
|
+
# @!attribute [rw] tgw_status
|
2984
|
+
# The status of the network configuration.
|
2985
|
+
# @return [String]
|
2986
|
+
#
|
2987
|
+
# @!attribute [rw] dns_status
|
2988
|
+
# The status of DNS configuration.
|
2989
|
+
# @return [String]
|
2990
|
+
#
|
2991
|
+
# @!attribute [rw] error_message
|
2992
|
+
# Specifies the error message that appears if a flow fails.
|
2993
|
+
# @return [String]
|
2994
|
+
#
|
2995
|
+
# @!attribute [rw] description
|
2996
|
+
# The description of the environment.
|
2997
|
+
# @return [String]
|
2998
|
+
#
|
2999
|
+
# @!attribute [rw] environment_arn
|
3000
|
+
# The ARN identifier of the environment.
|
3001
|
+
# @return [String]
|
3002
|
+
#
|
3003
|
+
# @!attribute [rw] kms_key_id
|
3004
|
+
# The KMS key ID to encrypt your data in the FinSpace environment.
|
3005
|
+
# @return [String]
|
3006
|
+
#
|
3007
|
+
# @!attribute [rw] dedicated_service_account_id
|
3008
|
+
# A unique identifier for the AWS environment infrastructure account.
|
3009
|
+
# @return [String]
|
3010
|
+
#
|
3011
|
+
# @!attribute [rw] transit_gateway_configuration
|
3012
|
+
# The structure of the transit gateway and network configuration that
|
3013
|
+
# is used to connect the kdb environment to an internal network.
|
3014
|
+
# @return [Types::TransitGatewayConfiguration]
|
3015
|
+
#
|
3016
|
+
# @!attribute [rw] custom_dns_configuration
|
3017
|
+
# A list of DNS server name and server IP. This is used to set up
|
3018
|
+
# Route-53 outbound resolvers.
|
3019
|
+
# @return [Array<Types::CustomDNSServer>]
|
3020
|
+
#
|
3021
|
+
# @!attribute [rw] creation_timestamp
|
3022
|
+
# The timestamp at which the kdb environment was created in FinSpace.
|
3023
|
+
# @return [Time]
|
3024
|
+
#
|
3025
|
+
# @!attribute [rw] update_timestamp
|
3026
|
+
# The timestamp at which the kdb environment was updated.
|
3027
|
+
# @return [Time]
|
3028
|
+
#
|
3029
|
+
# @!attribute [rw] availability_zone_ids
|
3030
|
+
# The identifier of the availability zones where subnets for the
|
3031
|
+
# environment are created.
|
3032
|
+
# @return [Array<String>]
|
3033
|
+
#
|
3034
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxEnvironmentNetworkResponse AWS API Documentation
|
3035
|
+
#
|
3036
|
+
class UpdateKxEnvironmentNetworkResponse < Struct.new(
|
3037
|
+
:name,
|
3038
|
+
:environment_id,
|
3039
|
+
:aws_account_id,
|
3040
|
+
:status,
|
3041
|
+
:tgw_status,
|
3042
|
+
:dns_status,
|
3043
|
+
:error_message,
|
3044
|
+
:description,
|
3045
|
+
:environment_arn,
|
3046
|
+
:kms_key_id,
|
3047
|
+
:dedicated_service_account_id,
|
3048
|
+
:transit_gateway_configuration,
|
3049
|
+
:custom_dns_configuration,
|
3050
|
+
:creation_timestamp,
|
3051
|
+
:update_timestamp,
|
3052
|
+
:availability_zone_ids)
|
3053
|
+
SENSITIVE = []
|
3054
|
+
include Aws::Structure
|
3055
|
+
end
|
3056
|
+
|
3057
|
+
# @!attribute [rw] environment_id
|
3058
|
+
# A unique identifier for the kdb environment.
|
3059
|
+
# @return [String]
|
3060
|
+
#
|
3061
|
+
# @!attribute [rw] name
|
3062
|
+
# The name of the kdb environment.
|
3063
|
+
# @return [String]
|
3064
|
+
#
|
3065
|
+
# @!attribute [rw] description
|
3066
|
+
# A description of the kdb environment.
|
3067
|
+
# @return [String]
|
3068
|
+
#
|
3069
|
+
# @!attribute [rw] client_token
|
3070
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
3071
|
+
# @return [String]
|
3072
|
+
#
|
3073
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxEnvironmentRequest AWS API Documentation
|
3074
|
+
#
|
3075
|
+
class UpdateKxEnvironmentRequest < Struct.new(
|
3076
|
+
:environment_id,
|
3077
|
+
:name,
|
3078
|
+
:description,
|
3079
|
+
:client_token)
|
3080
|
+
SENSITIVE = []
|
3081
|
+
include Aws::Structure
|
3082
|
+
end
|
3083
|
+
|
3084
|
+
# @!attribute [rw] name
|
3085
|
+
# The name of the kdb environment.
|
3086
|
+
# @return [String]
|
3087
|
+
#
|
3088
|
+
# @!attribute [rw] environment_id
|
3089
|
+
# A unique identifier for the kdb environment.
|
3090
|
+
# @return [String]
|
3091
|
+
#
|
3092
|
+
# @!attribute [rw] aws_account_id
|
3093
|
+
# The unique identifier of the AWS account that is used to create the
|
3094
|
+
# kdb environment.
|
3095
|
+
# @return [String]
|
3096
|
+
#
|
3097
|
+
# @!attribute [rw] status
|
3098
|
+
# The status of the kdb environment.
|
3099
|
+
# @return [String]
|
3100
|
+
#
|
3101
|
+
# @!attribute [rw] tgw_status
|
3102
|
+
# The status of the network configuration.
|
3103
|
+
# @return [String]
|
3104
|
+
#
|
3105
|
+
# @!attribute [rw] dns_status
|
3106
|
+
# The status of DNS configuration.
|
3107
|
+
# @return [String]
|
3108
|
+
#
|
3109
|
+
# @!attribute [rw] error_message
|
3110
|
+
# Specifies the error message that appears if a flow fails.
|
3111
|
+
# @return [String]
|
3112
|
+
#
|
3113
|
+
# @!attribute [rw] description
|
3114
|
+
# The description of the environment.
|
3115
|
+
# @return [String]
|
3116
|
+
#
|
3117
|
+
# @!attribute [rw] environment_arn
|
3118
|
+
# The ARN identifier of the environment.
|
3119
|
+
# @return [String]
|
3120
|
+
#
|
3121
|
+
# @!attribute [rw] kms_key_id
|
3122
|
+
# The KMS key ID to encrypt your data in the FinSpace environment.
|
3123
|
+
# @return [String]
|
3124
|
+
#
|
3125
|
+
# @!attribute [rw] dedicated_service_account_id
|
3126
|
+
# A unique identifier for the AWS environment infrastructure account.
|
3127
|
+
# @return [String]
|
3128
|
+
#
|
3129
|
+
# @!attribute [rw] transit_gateway_configuration
|
3130
|
+
# The structure of the transit gateway and network configuration that
|
3131
|
+
# is used to connect the kdb environment to an internal network.
|
3132
|
+
# @return [Types::TransitGatewayConfiguration]
|
3133
|
+
#
|
3134
|
+
# @!attribute [rw] custom_dns_configuration
|
3135
|
+
# A list of DNS server name and server IP. This is used to set up
|
3136
|
+
# Route-53 outbound resolvers.
|
3137
|
+
# @return [Array<Types::CustomDNSServer>]
|
3138
|
+
#
|
3139
|
+
# @!attribute [rw] creation_timestamp
|
3140
|
+
# The timestamp at which the kdb environment was created in FinSpace.
|
3141
|
+
# @return [Time]
|
3142
|
+
#
|
3143
|
+
# @!attribute [rw] update_timestamp
|
3144
|
+
# The timestamp at which the kdb environment was updated.
|
3145
|
+
# @return [Time]
|
3146
|
+
#
|
3147
|
+
# @!attribute [rw] availability_zone_ids
|
3148
|
+
# The identifier of the availability zones where subnets for the
|
3149
|
+
# environment are created.
|
3150
|
+
# @return [Array<String>]
|
3151
|
+
#
|
3152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxEnvironmentResponse AWS API Documentation
|
3153
|
+
#
|
3154
|
+
class UpdateKxEnvironmentResponse < Struct.new(
|
3155
|
+
:name,
|
3156
|
+
:environment_id,
|
3157
|
+
:aws_account_id,
|
3158
|
+
:status,
|
3159
|
+
:tgw_status,
|
3160
|
+
:dns_status,
|
3161
|
+
:error_message,
|
3162
|
+
:description,
|
3163
|
+
:environment_arn,
|
3164
|
+
:kms_key_id,
|
3165
|
+
:dedicated_service_account_id,
|
3166
|
+
:transit_gateway_configuration,
|
3167
|
+
:custom_dns_configuration,
|
3168
|
+
:creation_timestamp,
|
3169
|
+
:update_timestamp,
|
3170
|
+
:availability_zone_ids)
|
3171
|
+
SENSITIVE = []
|
3172
|
+
include Aws::Structure
|
3173
|
+
end
|
3174
|
+
|
3175
|
+
# @!attribute [rw] environment_id
|
3176
|
+
# A unique identifier for the kdb environment.
|
3177
|
+
# @return [String]
|
3178
|
+
#
|
3179
|
+
# @!attribute [rw] user_name
|
3180
|
+
# A unique identifier for the user.
|
3181
|
+
# @return [String]
|
3182
|
+
#
|
3183
|
+
# @!attribute [rw] iam_role
|
3184
|
+
# The IAM role ARN that is associated with the user.
|
3185
|
+
# @return [String]
|
3186
|
+
#
|
3187
|
+
# @!attribute [rw] client_token
|
3188
|
+
# A token that ensures idempotency. This token expires in 10 minutes.
|
3189
|
+
# @return [String]
|
3190
|
+
#
|
3191
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxUserRequest AWS API Documentation
|
3192
|
+
#
|
3193
|
+
class UpdateKxUserRequest < Struct.new(
|
3194
|
+
:environment_id,
|
3195
|
+
:user_name,
|
3196
|
+
:iam_role,
|
3197
|
+
:client_token)
|
3198
|
+
SENSITIVE = []
|
3199
|
+
include Aws::Structure
|
3200
|
+
end
|
3201
|
+
|
3202
|
+
# @!attribute [rw] user_name
|
3203
|
+
# A unique identifier for the user.
|
3204
|
+
# @return [String]
|
3205
|
+
#
|
3206
|
+
# @!attribute [rw] user_arn
|
3207
|
+
# The Amazon Resource Name (ARN) that identifies the user. For more
|
3208
|
+
# information about ARNs and how to use ARNs in policies, see [IAM
|
3209
|
+
# Identifiers](IAM/latest/UserGuide/reference_identifiers.html) in the
|
3210
|
+
# *IAM User Guide*.
|
3211
|
+
# @return [String]
|
3212
|
+
#
|
3213
|
+
# @!attribute [rw] environment_id
|
3214
|
+
# A unique identifier for the kdb environment.
|
3215
|
+
# @return [String]
|
3216
|
+
#
|
3217
|
+
# @!attribute [rw] iam_role
|
3218
|
+
# The IAM role ARN that is associated with the user.
|
3219
|
+
# @return [String]
|
3220
|
+
#
|
3221
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxUserResponse AWS API Documentation
|
3222
|
+
#
|
3223
|
+
class UpdateKxUserResponse < Struct.new(
|
3224
|
+
:user_name,
|
3225
|
+
:user_arn,
|
3226
|
+
:environment_id,
|
3227
|
+
:iam_role)
|
3228
|
+
SENSITIVE = []
|
3229
|
+
include Aws::Structure
|
3230
|
+
end
|
3231
|
+
|
519
3232
|
# The input fails to satisfy the constraints specified by an AWS
|
520
3233
|
# service.
|
521
3234
|
#
|
@@ -530,5 +3243,42 @@ module Aws::Finspace
|
|
530
3243
|
include Aws::Structure
|
531
3244
|
end
|
532
3245
|
|
3246
|
+
# Configuration details about the network where the Privatelink endpoint
|
3247
|
+
# of the cluster resides.
|
3248
|
+
#
|
3249
|
+
# @!attribute [rw] vpc_id
|
3250
|
+
# The identifier of the VPC endpoint.
|
3251
|
+
# @return [String]
|
3252
|
+
#
|
3253
|
+
# @!attribute [rw] security_group_ids
|
3254
|
+
# The unique identifier of the VPC security group applied to the VPC
|
3255
|
+
# endpoint ENI for the cluster.
|
3256
|
+
# @return [Array<String>]
|
3257
|
+
#
|
3258
|
+
# @!attribute [rw] subnet_ids
|
3259
|
+
# The identifier of the subnet that the Privatelink VPC endpoint uses
|
3260
|
+
# to connect to the cluster.
|
3261
|
+
# @return [Array<String>]
|
3262
|
+
#
|
3263
|
+
# @!attribute [rw] ip_address_type
|
3264
|
+
# The IP address type for cluster network configuration parameters.
|
3265
|
+
# The following type is available:
|
3266
|
+
#
|
3267
|
+
# * IP\_V4 – IP address version 4
|
3268
|
+
#
|
3269
|
+
# ^
|
3270
|
+
# @return [String]
|
3271
|
+
#
|
3272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/VpcConfiguration AWS API Documentation
|
3273
|
+
#
|
3274
|
+
class VpcConfiguration < Struct.new(
|
3275
|
+
:vpc_id,
|
3276
|
+
:security_group_ids,
|
3277
|
+
:subnet_ids,
|
3278
|
+
:ip_address_type)
|
3279
|
+
SENSITIVE = []
|
3280
|
+
include Aws::Structure
|
3281
|
+
end
|
3282
|
+
|
533
3283
|
end
|
534
3284
|
end
|