aws-sdk-finspace 1.25.0 → 1.27.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -292,31 +292,52 @@ module Aws::Finspace
292
292
  #
293
293
  # @!attribute [rw] change_requests
294
294
  # A list of change request objects that are run in order. A change
295
- # request object consists of changeType , s3Path, and a dbPath. A
295
+ # request object consists of `changeType` , `s3Path`, and `dbPath`. A
296
296
  # changeType can has the following values:
297
297
  #
298
298
  # * PUT – Adds or updates files in a database.
299
299
  #
300
300
  # * DELETE – Deletes files in a database.
301
301
  #
302
- # All the change requests require a mandatory *dbPath* attribute that
303
- # defines the path within the database directory. The *s3Path*
302
+ # All the change requests require a mandatory `dbPath` attribute that
303
+ # defines the path within the database directory. All database paths
304
+ # must start with a leading / and end with a trailing /. The `s3Path`
304
305
  # attribute defines the s3 source file path and is required for a PUT
305
- # change type.
306
+ # change type. The `s3path` must end with a trailing / if it is a
307
+ # directory and must end without a trailing / if it is a file.
306
308
  #
307
- # Here is an example of how you can use the change request object:
309
+ # Here are few examples of how you can use the change request object:
308
310
  #
309
- # `[ \{ "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/",
310
- # "dbPath":"/2020.01.02/"\}, \{ "changeType": "PUT",
311
- # "s3Path":"s3://bucket/db/sym", "dbPath":"/"\}, \{ "changeType":
312
- # "DELETE", "dbPath": "/2020.01.01/"\} ]`
311
+ # 1. This request adds a single sym file at database root location.
313
312
  #
314
- # In this example, the first request with *PUT* change type allows you
315
- # to add files in the given s3Path under the *2020.01.02* partition of
316
- # the database. The second request with *PUT* change type allows you
317
- # to add a single sym file at database root location. The last request
318
- # with *DELETE* change type allows you to delete the files under the
319
- # *2020.01.01* partition of the database.
313
+ # `\{ "changeType": "PUT", "s3Path":"s3://bucket/db/sym",
314
+ # "dbPath":"/"\}`
315
+ #
316
+ # 2. This request adds files in the given `s3Path` under the
317
+ # 2020.01.02 partition of the database.
318
+ #
319
+ # `\{ "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/",
320
+ # "dbPath":"/2020.01.02/"\}`
321
+ #
322
+ # 3. This request adds files in the given `s3Path` under the *taq*
323
+ # table partition of the database.
324
+ #
325
+ # `[ \{ "changeType": "PUT",
326
+ # "s3Path":"s3://bucket/db/2020.01.02/taq/",
327
+ # "dbPath":"/2020.01.02/taq/"\}]`
328
+ #
329
+ # 4. This request deletes the 2020.01.02 partition of the database.
330
+ #
331
+ # `[\{ "changeType": "DELETE", "dbPath": "/2020.01.02/"\} ]`
332
+ #
333
+ # 5. The *DELETE* request allows you to delete the existing files
334
+ # under the 2020.01.02 partition of the database, and the *PUT*
335
+ # request adds a new taq table under it.
336
+ #
337
+ # `[ \{"changeType": "DELETE", "dbPath":"/2020.01.02/"\},
338
+ # \{"changeType": "PUT",
339
+ # "s3Path":"s3://bucket/db/2020.01.02/taq/",
340
+ # "dbPath":"/2020.01.02/taq/"\}]`
320
341
  # @return [Array<Types::ChangeRequest>]
321
342
  #
322
343
  # @!attribute [rw] client_token
@@ -434,8 +455,29 @@ module Aws::Finspace
434
455
  # processes in kdb systems. It allows you to create your own routing
435
456
  # logic using the initialization scripts and custom code. This type
436
457
  # of cluster does not require a writable local storage.
458
+ #
459
+ # * GP – A general purpose cluster allows you to quickly iterate on
460
+ # code during development by granting greater access to system
461
+ # commands and enabling a fast reload of custom code. This cluster
462
+ # type can optionally mount databases including cache and savedown
463
+ # storage. For this cluster type, the node count is fixed at 1. It
464
+ # does not support autoscaling and supports only `SINGLE` AZ mode.
465
+ #
466
+ # * Tickerplant – A tickerplant cluster allows you to subscribe to
467
+ # feed handlers based on IAM permissions. It can publish to RDBs,
468
+ # other Tickerplants, and real-time subscribers (RTS). Tickerplants
469
+ # can persist messages to log, which is readable by any RDB
470
+ # environment. It supports only single-node that is only one kdb
471
+ # process.
437
472
  # @return [String]
438
473
  #
474
+ # @!attribute [rw] tickerplant_log_configuration
475
+ # A configuration to store Tickerplant logs. It consists of a list of
476
+ # volumes that will be mounted to your cluster. For the cluster type
477
+ # `Tickerplant`, the location of the TP volume on the cluster will be
478
+ # available by using the global variable `.aws.tp_log_path`.
479
+ # @return [Types::TickerplantLogConfiguration]
480
+ #
439
481
  # @!attribute [rw] databases
440
482
  # A list of databases that will be available for querying.
441
483
  # @return [Array<Types::KxDatabaseConfiguration>]
@@ -519,6 +561,11 @@ module Aws::Finspace
519
561
  # tags to a cluster.
520
562
  # @return [Hash<String,String>]
521
563
  #
564
+ # @!attribute [rw] scaling_group_configuration
565
+ # The structure that stores the configuration details of a scaling
566
+ # group.
567
+ # @return [Types::KxScalingGroupConfiguration]
568
+ #
522
569
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxClusterRequest AWS API Documentation
523
570
  #
524
571
  class CreateKxClusterRequest < Struct.new(
@@ -526,6 +573,7 @@ module Aws::Finspace
526
573
  :environment_id,
527
574
  :cluster_name,
528
575
  :cluster_type,
576
+ :tickerplant_log_configuration,
529
577
  :databases,
530
578
  :cache_storage_configurations,
531
579
  :auto_scaling_configuration,
@@ -540,7 +588,8 @@ module Aws::Finspace
540
588
  :savedown_storage_configuration,
541
589
  :az_mode,
542
590
  :availability_zone_id,
543
- :tags)
591
+ :tags,
592
+ :scaling_group_configuration)
544
593
  SENSITIVE = []
545
594
  include Aws::Structure
546
595
  end
@@ -597,8 +646,33 @@ module Aws::Finspace
597
646
  # processes in kdb systems. It allows you to create your own routing
598
647
  # logic using the initialization scripts and custom code. This type
599
648
  # of cluster does not require a writable local storage.
649
+ #
650
+ # * GP – A general purpose cluster allows you to quickly iterate on
651
+ # code during development by granting greater access to system
652
+ # commands and enabling a fast reload of custom code. This cluster
653
+ # type can optionally mount databases including cache and savedown
654
+ # storage. For this cluster type, the node count is fixed at 1. It
655
+ # does not support autoscaling and supports only `SINGLE` AZ mode.
656
+ #
657
+ # * Tickerplant – A tickerplant cluster allows you to subscribe to
658
+ # feed handlers based on IAM permissions. It can publish to RDBs,
659
+ # other Tickerplants, and real-time subscribers (RTS). Tickerplants
660
+ # can persist messages to log, which is readable by any RDB
661
+ # environment. It supports only single-node that is only one kdb
662
+ # process.
600
663
  # @return [String]
601
664
  #
665
+ # @!attribute [rw] tickerplant_log_configuration
666
+ # A configuration to store the Tickerplant logs. It consists of a list
667
+ # of volumes that will be mounted to your cluster. For the cluster
668
+ # type `Tickerplant`, the location of the TP volume on the cluster
669
+ # will be available by using the global variable `.aws.tp_log_path`.
670
+ # @return [Types::TickerplantLogConfiguration]
671
+ #
672
+ # @!attribute [rw] volumes
673
+ # A list of volumes mounted on the cluster.
674
+ # @return [Array<Types::Volume>]
675
+ #
602
676
  # @!attribute [rw] databases
603
677
  # A list of databases that will be available for querying.
604
678
  # @return [Array<Types::KxDatabaseConfiguration>]
@@ -690,6 +764,11 @@ module Aws::Finspace
690
764
  # 1635768000000.
691
765
  # @return [Time]
692
766
  #
767
+ # @!attribute [rw] scaling_group_configuration
768
+ # The structure that stores the configuration details of a scaling
769
+ # group.
770
+ # @return [Types::KxScalingGroupConfiguration]
771
+ #
693
772
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxClusterResponse AWS API Documentation
694
773
  #
695
774
  class CreateKxClusterResponse < Struct.new(
@@ -698,6 +777,8 @@ module Aws::Finspace
698
777
  :status_reason,
699
778
  :cluster_name,
700
779
  :cluster_type,
780
+ :tickerplant_log_configuration,
781
+ :volumes,
701
782
  :databases,
702
783
  :cache_storage_configurations,
703
784
  :auto_scaling_configuration,
@@ -713,7 +794,8 @@ module Aws::Finspace
713
794
  :savedown_storage_configuration,
714
795
  :az_mode,
715
796
  :availability_zone_id,
716
- :created_timestamp)
797
+ :created_timestamp,
798
+ :scaling_group_configuration)
717
799
  SENSITIVE = []
718
800
  include Aws::Structure
719
801
  end
@@ -797,6 +879,176 @@ module Aws::Finspace
797
879
  include Aws::Structure
798
880
  end
799
881
 
882
+ # @!attribute [rw] environment_id
883
+ # A unique identifier for the kdb environment, where you want to
884
+ # create the dataview.
885
+ # @return [String]
886
+ #
887
+ # @!attribute [rw] database_name
888
+ # The name of the database where you want to create a dataview.
889
+ # @return [String]
890
+ #
891
+ # @!attribute [rw] dataview_name
892
+ # A unique identifier for the dataview.
893
+ # @return [String]
894
+ #
895
+ # @!attribute [rw] az_mode
896
+ # The number of availability zones you want to assign per cluster.
897
+ # This can be one of the following
898
+ #
899
+ # * `SINGLE` – Assigns one availability zone per cluster.
900
+ #
901
+ # * `MULTI` – Assigns all the availability zones per cluster.
902
+ # @return [String]
903
+ #
904
+ # @!attribute [rw] availability_zone_id
905
+ # The identifier of the availability zones.
906
+ # @return [String]
907
+ #
908
+ # @!attribute [rw] changeset_id
909
+ # A unique identifier of the changeset that you want to use to ingest
910
+ # data.
911
+ # @return [String]
912
+ #
913
+ # @!attribute [rw] segment_configurations
914
+ # The configuration that contains the database path of the data that
915
+ # you want to place on each selected volume. Each segment must have a
916
+ # unique database path for each volume. If you do not explicitly
917
+ # specify any database path for a volume, they are accessible from the
918
+ # cluster through the default S3/object store segment.
919
+ # @return [Array<Types::KxDataviewSegmentConfiguration>]
920
+ #
921
+ # @!attribute [rw] auto_update
922
+ # The option to specify whether you want to apply all the future
923
+ # additions and corrections automatically to the dataview, when you
924
+ # ingest new changesets. The default value is false.
925
+ # @return [Boolean]
926
+ #
927
+ # @!attribute [rw] description
928
+ # A description of the dataview.
929
+ # @return [String]
930
+ #
931
+ # @!attribute [rw] tags
932
+ # A list of key-value pairs to label the dataview. You can add up to
933
+ # 50 tags to a dataview.
934
+ # @return [Hash<String,String>]
935
+ #
936
+ # @!attribute [rw] client_token
937
+ # A token that ensures idempotency. This token expires in 10 minutes.
938
+ #
939
+ # **A suitable default value is auto-generated.** You should normally
940
+ # not need to pass this option.
941
+ # @return [String]
942
+ #
943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxDataviewRequest AWS API Documentation
944
+ #
945
+ class CreateKxDataviewRequest < Struct.new(
946
+ :environment_id,
947
+ :database_name,
948
+ :dataview_name,
949
+ :az_mode,
950
+ :availability_zone_id,
951
+ :changeset_id,
952
+ :segment_configurations,
953
+ :auto_update,
954
+ :description,
955
+ :tags,
956
+ :client_token)
957
+ SENSITIVE = []
958
+ include Aws::Structure
959
+ end
960
+
961
+ # @!attribute [rw] dataview_name
962
+ # A unique identifier for the dataview.
963
+ # @return [String]
964
+ #
965
+ # @!attribute [rw] database_name
966
+ # The name of the database where you want to create a dataview.
967
+ # @return [String]
968
+ #
969
+ # @!attribute [rw] environment_id
970
+ # A unique identifier for the kdb environment, where you want to
971
+ # create the dataview.
972
+ # @return [String]
973
+ #
974
+ # @!attribute [rw] az_mode
975
+ # The number of availability zones you want to assign per cluster.
976
+ # This can be one of the following
977
+ #
978
+ # * `SINGLE` – Assigns one availability zone per cluster.
979
+ #
980
+ # * `MULTI` – Assigns all the availability zones per cluster.
981
+ # @return [String]
982
+ #
983
+ # @!attribute [rw] availability_zone_id
984
+ # The identifier of the availability zones.
985
+ # @return [String]
986
+ #
987
+ # @!attribute [rw] changeset_id
988
+ # A unique identifier for the changeset.
989
+ # @return [String]
990
+ #
991
+ # @!attribute [rw] segment_configurations
992
+ # The configuration that contains the database path of the data that
993
+ # you want to place on each selected volume. Each segment must have a
994
+ # unique database path for each volume. If you do not explicitly
995
+ # specify any database path for a volume, they are accessible from the
996
+ # cluster through the default S3/object store segment.
997
+ # @return [Array<Types::KxDataviewSegmentConfiguration>]
998
+ #
999
+ # @!attribute [rw] description
1000
+ # A description of the dataview.
1001
+ # @return [String]
1002
+ #
1003
+ # @!attribute [rw] auto_update
1004
+ # The option to select whether you want to apply all the future
1005
+ # additions and corrections automatically to the dataview when you
1006
+ # ingest new changesets. The default value is false.
1007
+ # @return [Boolean]
1008
+ #
1009
+ # @!attribute [rw] created_timestamp
1010
+ # The timestamp at which the dataview was created in FinSpace. The
1011
+ # value is determined as epoch time in milliseconds. For example, the
1012
+ # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
1013
+ # 1635768000000.
1014
+ # @return [Time]
1015
+ #
1016
+ # @!attribute [rw] last_modified_timestamp
1017
+ # The last time that the dataview was updated in FinSpace. The value
1018
+ # is determined as epoch time in milliseconds. For example, the value
1019
+ # for Monday, November 1, 2021 12:00:00 PM UTC is specified as
1020
+ # 1635768000000.
1021
+ # @return [Time]
1022
+ #
1023
+ # @!attribute [rw] status
1024
+ # The status of dataview creation.
1025
+ #
1026
+ # * `CREATING` – The dataview creation is in progress.
1027
+ #
1028
+ # * `UPDATING` – The dataview is in the process of being updated.
1029
+ #
1030
+ # * `ACTIVE` – The dataview is active.
1031
+ # @return [String]
1032
+ #
1033
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxDataviewResponse AWS API Documentation
1034
+ #
1035
+ class CreateKxDataviewResponse < Struct.new(
1036
+ :dataview_name,
1037
+ :database_name,
1038
+ :environment_id,
1039
+ :az_mode,
1040
+ :availability_zone_id,
1041
+ :changeset_id,
1042
+ :segment_configurations,
1043
+ :description,
1044
+ :auto_update,
1045
+ :created_timestamp,
1046
+ :last_modified_timestamp,
1047
+ :status)
1048
+ SENSITIVE = []
1049
+ include Aws::Structure
1050
+ end
1051
+
800
1052
  # @!attribute [rw] name
801
1053
  # The name of the kdb environment that you want to create.
802
1054
  # @return [String]
@@ -816,6 +1068,9 @@ module Aws::Finspace
816
1068
  #
817
1069
  # @!attribute [rw] client_token
818
1070
  # A token that ensures idempotency. This token expires in 10 minutes.
1071
+ #
1072
+ # **A suitable default value is auto-generated.** You should normally
1073
+ # not need to pass this option.
819
1074
  # @return [String]
820
1075
  #
821
1076
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxEnvironmentRequest AWS API Documentation
@@ -872,6 +1127,115 @@ module Aws::Finspace
872
1127
  include Aws::Structure
873
1128
  end
874
1129
 
1130
+ # @!attribute [rw] client_token
1131
+ # A token that ensures idempotency. This token expires in 10 minutes.
1132
+ #
1133
+ # **A suitable default value is auto-generated.** You should normally
1134
+ # not need to pass this option.
1135
+ # @return [String]
1136
+ #
1137
+ # @!attribute [rw] environment_id
1138
+ # A unique identifier for the kdb environment, where you want to
1139
+ # create the scaling group.
1140
+ # @return [String]
1141
+ #
1142
+ # @!attribute [rw] scaling_group_name
1143
+ # A unique identifier for the kdb scaling group.
1144
+ # @return [String]
1145
+ #
1146
+ # @!attribute [rw] host_type
1147
+ # The memory and CPU capabilities of the scaling group host on which
1148
+ # FinSpace Managed kdb clusters will be placed.
1149
+ # @return [String]
1150
+ #
1151
+ # @!attribute [rw] availability_zone_id
1152
+ # The identifier of the availability zones.
1153
+ # @return [String]
1154
+ #
1155
+ # @!attribute [rw] tags
1156
+ # A list of key-value pairs to label the scaling group. You can add up
1157
+ # to 50 tags to a scaling group.
1158
+ # @return [Hash<String,String>]
1159
+ #
1160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxScalingGroupRequest AWS API Documentation
1161
+ #
1162
+ class CreateKxScalingGroupRequest < Struct.new(
1163
+ :client_token,
1164
+ :environment_id,
1165
+ :scaling_group_name,
1166
+ :host_type,
1167
+ :availability_zone_id,
1168
+ :tags)
1169
+ SENSITIVE = []
1170
+ include Aws::Structure
1171
+ end
1172
+
1173
+ # @!attribute [rw] environment_id
1174
+ # A unique identifier for the kdb environment, where you create the
1175
+ # scaling group.
1176
+ # @return [String]
1177
+ #
1178
+ # @!attribute [rw] scaling_group_name
1179
+ # A unique identifier for the kdb scaling group.
1180
+ # @return [String]
1181
+ #
1182
+ # @!attribute [rw] host_type
1183
+ # The memory and CPU capabilities of the scaling group host on which
1184
+ # FinSpace Managed kdb clusters will be placed.
1185
+ # @return [String]
1186
+ #
1187
+ # @!attribute [rw] availability_zone_id
1188
+ # The identifier of the availability zones.
1189
+ # @return [String]
1190
+ #
1191
+ # @!attribute [rw] status
1192
+ # The status of scaling group.
1193
+ #
1194
+ # * CREATING – The scaling group creation is in progress.
1195
+ #
1196
+ # * CREATE\_FAILED – The scaling group creation has failed.
1197
+ #
1198
+ # * ACTIVE – The scaling group is active.
1199
+ #
1200
+ # * UPDATING – The scaling group is in the process of being updated.
1201
+ #
1202
+ # * UPDATE\_FAILED – The update action failed.
1203
+ #
1204
+ # * DELETING – The scaling group is in the process of being deleted.
1205
+ #
1206
+ # * DELETE\_FAILED – The system failed to delete the scaling group.
1207
+ #
1208
+ # * DELETED – The scaling group is successfully deleted.
1209
+ # @return [String]
1210
+ #
1211
+ # @!attribute [rw] last_modified_timestamp
1212
+ # The last time that the scaling group was updated in FinSpace. The
1213
+ # value is determined as epoch time in milliseconds. For example, the
1214
+ # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
1215
+ # 1635768000000.
1216
+ # @return [Time]
1217
+ #
1218
+ # @!attribute [rw] created_timestamp
1219
+ # The timestamp at which the scaling group was created in FinSpace.
1220
+ # The value is determined as epoch time in milliseconds. For example,
1221
+ # the value for Monday, November 1, 2021 12:00:00 PM UTC is specified
1222
+ # as 1635768000000.
1223
+ # @return [Time]
1224
+ #
1225
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxScalingGroupResponse AWS API Documentation
1226
+ #
1227
+ class CreateKxScalingGroupResponse < Struct.new(
1228
+ :environment_id,
1229
+ :scaling_group_name,
1230
+ :host_type,
1231
+ :availability_zone_id,
1232
+ :status,
1233
+ :last_modified_timestamp,
1234
+ :created_timestamp)
1235
+ SENSITIVE = []
1236
+ include Aws::Structure
1237
+ end
1238
+
875
1239
  # @!attribute [rw] environment_id
876
1240
  # A unique identifier for the kdb environment where you want to create
877
1241
  # a user.
@@ -892,6 +1256,9 @@ module Aws::Finspace
892
1256
  #
893
1257
  # @!attribute [rw] client_token
894
1258
  # A token that ensures idempotency. This token expires in 10 minutes.
1259
+ #
1260
+ # **A suitable default value is auto-generated.** You should normally
1261
+ # not need to pass this option.
895
1262
  # @return [String]
896
1263
  #
897
1264
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxUserRequest AWS API Documentation
@@ -939,34 +1306,183 @@ module Aws::Finspace
939
1306
  include Aws::Structure
940
1307
  end
941
1308
 
942
- # A list of DNS server name and server IP. This is used to set up
943
- # Route-53 outbound resolvers.
1309
+ # @!attribute [rw] client_token
1310
+ # A token that ensures idempotency. This token expires in 10 minutes.
944
1311
  #
945
- # @!attribute [rw] custom_dns_server_name
946
- # The name of the DNS server.
1312
+ # **A suitable default value is auto-generated.** You should normally
1313
+ # not need to pass this option.
947
1314
  # @return [String]
948
1315
  #
949
- # @!attribute [rw] custom_dns_server_ip
950
- # The IP address of the DNS server.
1316
+ # @!attribute [rw] environment_id
1317
+ # A unique identifier for the kdb environment, whose clusters can
1318
+ # attach to the volume.
951
1319
  # @return [String]
952
1320
  #
953
- # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CustomDNSServer AWS API Documentation
1321
+ # @!attribute [rw] volume_type
1322
+ # The type of file system volume. Currently, FinSpace only supports
1323
+ # `NAS_1` volume type. When you select `NAS_1` volume type, you must
1324
+ # also provide `nas1Configuration`.
1325
+ # @return [String]
954
1326
  #
955
- class CustomDNSServer < Struct.new(
956
- :custom_dns_server_name,
957
- :custom_dns_server_ip)
1327
+ # @!attribute [rw] volume_name
1328
+ # A unique identifier for the volume.
1329
+ # @return [String]
1330
+ #
1331
+ # @!attribute [rw] description
1332
+ # A description of the volume.
1333
+ # @return [String]
1334
+ #
1335
+ # @!attribute [rw] nas1_configuration
1336
+ # Specifies the configuration for the Network attached storage
1337
+ # (NAS\_1) file system volume. This parameter is required when you
1338
+ # choose `volumeType` as *NAS\_1*.
1339
+ # @return [Types::KxNAS1Configuration]
1340
+ #
1341
+ # @!attribute [rw] az_mode
1342
+ # The number of availability zones you want to assign per cluster.
1343
+ # Currently, FinSpace only support `SINGLE` for volumes.
1344
+ # @return [String]
1345
+ #
1346
+ # @!attribute [rw] availability_zone_ids
1347
+ # The identifier of the availability zones.
1348
+ # @return [Array<String>]
1349
+ #
1350
+ # @!attribute [rw] tags
1351
+ # A list of key-value pairs to label the volume. You can add up to 50
1352
+ # tags to a volume.
1353
+ # @return [Hash<String,String>]
1354
+ #
1355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxVolumeRequest AWS API Documentation
1356
+ #
1357
+ class CreateKxVolumeRequest < Struct.new(
1358
+ :client_token,
1359
+ :environment_id,
1360
+ :volume_type,
1361
+ :volume_name,
1362
+ :description,
1363
+ :nas1_configuration,
1364
+ :az_mode,
1365
+ :availability_zone_ids,
1366
+ :tags)
958
1367
  SENSITIVE = []
959
1368
  include Aws::Structure
960
1369
  end
961
1370
 
962
1371
  # @!attribute [rw] environment_id
963
- # The identifier for the FinSpace environment.
1372
+ # A unique identifier for the kdb environment, whose clusters can
1373
+ # attach to the volume.
964
1374
  # @return [String]
965
1375
  #
966
- # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteEnvironmentRequest AWS API Documentation
1376
+ # @!attribute [rw] volume_name
1377
+ # A unique identifier for the volume.
1378
+ # @return [String]
967
1379
  #
968
- class DeleteEnvironmentRequest < Struct.new(
969
- :environment_id)
1380
+ # @!attribute [rw] volume_type
1381
+ # The type of file system volume. Currently, FinSpace only supports
1382
+ # `NAS_1` volume type.
1383
+ # @return [String]
1384
+ #
1385
+ # @!attribute [rw] volume_arn
1386
+ # The ARN identifier of the volume.
1387
+ # @return [String]
1388
+ #
1389
+ # @!attribute [rw] nas1_configuration
1390
+ # Specifies the configuration for the Network attached storage
1391
+ # (NAS\_1) file system volume.
1392
+ # @return [Types::KxNAS1Configuration]
1393
+ #
1394
+ # @!attribute [rw] status
1395
+ # The status of volume creation.
1396
+ #
1397
+ # * CREATING – The volume creation is in progress.
1398
+ #
1399
+ # * CREATE\_FAILED – The volume creation has failed.
1400
+ #
1401
+ # * ACTIVE – The volume is active.
1402
+ #
1403
+ # * UPDATING – The volume is in the process of being updated.
1404
+ #
1405
+ # * UPDATE\_FAILED – The update action failed.
1406
+ #
1407
+ # * UPDATED – The volume is successfully updated.
1408
+ #
1409
+ # * DELETING – The volume is in the process of being deleted.
1410
+ #
1411
+ # * DELETE\_FAILED – The system failed to delete the volume.
1412
+ #
1413
+ # * DELETED – The volume is successfully deleted.
1414
+ # @return [String]
1415
+ #
1416
+ # @!attribute [rw] status_reason
1417
+ # The error message when a failed state occurs.
1418
+ # @return [String]
1419
+ #
1420
+ # @!attribute [rw] az_mode
1421
+ # The number of availability zones you want to assign per cluster.
1422
+ # Currently, FinSpace only support `SINGLE` for volumes.
1423
+ # @return [String]
1424
+ #
1425
+ # @!attribute [rw] description
1426
+ # A description of the volume.
1427
+ # @return [String]
1428
+ #
1429
+ # @!attribute [rw] availability_zone_ids
1430
+ # The identifier of the availability zones.
1431
+ # @return [Array<String>]
1432
+ #
1433
+ # @!attribute [rw] created_timestamp
1434
+ # The timestamp at which the volume was created in FinSpace. The value
1435
+ # is determined as epoch time in milliseconds. For example, the value
1436
+ # for Monday, November 1, 2021 12:00:00 PM UTC is specified as
1437
+ # 1635768000000.
1438
+ # @return [Time]
1439
+ #
1440
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CreateKxVolumeResponse AWS API Documentation
1441
+ #
1442
+ class CreateKxVolumeResponse < Struct.new(
1443
+ :environment_id,
1444
+ :volume_name,
1445
+ :volume_type,
1446
+ :volume_arn,
1447
+ :nas1_configuration,
1448
+ :status,
1449
+ :status_reason,
1450
+ :az_mode,
1451
+ :description,
1452
+ :availability_zone_ids,
1453
+ :created_timestamp)
1454
+ SENSITIVE = []
1455
+ include Aws::Structure
1456
+ end
1457
+
1458
+ # A list of DNS server name and server IP. This is used to set up
1459
+ # Route-53 outbound resolvers.
1460
+ #
1461
+ # @!attribute [rw] custom_dns_server_name
1462
+ # The name of the DNS server.
1463
+ # @return [String]
1464
+ #
1465
+ # @!attribute [rw] custom_dns_server_ip
1466
+ # The IP address of the DNS server.
1467
+ # @return [String]
1468
+ #
1469
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/CustomDNSServer AWS API Documentation
1470
+ #
1471
+ class CustomDNSServer < Struct.new(
1472
+ :custom_dns_server_name,
1473
+ :custom_dns_server_ip)
1474
+ SENSITIVE = []
1475
+ include Aws::Structure
1476
+ end
1477
+
1478
+ # @!attribute [rw] environment_id
1479
+ # The identifier for the FinSpace environment.
1480
+ # @return [String]
1481
+ #
1482
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteEnvironmentRequest AWS API Documentation
1483
+ #
1484
+ class DeleteEnvironmentRequest < Struct.new(
1485
+ :environment_id)
970
1486
  SENSITIVE = []
971
1487
  include Aws::Structure
972
1488
  end
@@ -1033,14 +1549,57 @@ module Aws::Finspace
1033
1549
  #
1034
1550
  class DeleteKxDatabaseResponse < Aws::EmptyStructure; end
1035
1551
 
1552
+ # @!attribute [rw] environment_id
1553
+ # A unique identifier for the kdb environment, from where you want to
1554
+ # delete the dataview.
1555
+ # @return [String]
1556
+ #
1557
+ # @!attribute [rw] database_name
1558
+ # The name of the database whose dataview you want to delete.
1559
+ # @return [String]
1560
+ #
1561
+ # @!attribute [rw] dataview_name
1562
+ # The name of the dataview that you want to delete.
1563
+ # @return [String]
1564
+ #
1565
+ # @!attribute [rw] client_token
1566
+ # A token that ensures idempotency. This token expires in 10 minutes.
1567
+ #
1568
+ # **A suitable default value is auto-generated.** You should normally
1569
+ # not need to pass this option.
1570
+ # @return [String]
1571
+ #
1572
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxDataviewRequest AWS API Documentation
1573
+ #
1574
+ class DeleteKxDataviewRequest < Struct.new(
1575
+ :environment_id,
1576
+ :database_name,
1577
+ :dataview_name,
1578
+ :client_token)
1579
+ SENSITIVE = []
1580
+ include Aws::Structure
1581
+ end
1582
+
1583
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxDataviewResponse AWS API Documentation
1584
+ #
1585
+ class DeleteKxDataviewResponse < Aws::EmptyStructure; end
1586
+
1036
1587
  # @!attribute [rw] environment_id
1037
1588
  # A unique identifier for the kdb environment.
1038
1589
  # @return [String]
1039
1590
  #
1591
+ # @!attribute [rw] client_token
1592
+ # A token that ensures idempotency. This token expires in 10 minutes.
1593
+ #
1594
+ # **A suitable default value is auto-generated.** You should normally
1595
+ # not need to pass this option.
1596
+ # @return [String]
1597
+ #
1040
1598
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxEnvironmentRequest AWS API Documentation
1041
1599
  #
1042
1600
  class DeleteKxEnvironmentRequest < Struct.new(
1043
- :environment_id)
1601
+ :environment_id,
1602
+ :client_token)
1044
1603
  SENSITIVE = []
1045
1604
  include Aws::Structure
1046
1605
  end
@@ -1049,6 +1608,36 @@ module Aws::Finspace
1049
1608
  #
1050
1609
  class DeleteKxEnvironmentResponse < Aws::EmptyStructure; end
1051
1610
 
1611
+ # @!attribute [rw] environment_id
1612
+ # A unique identifier for the kdb environment, from where you want to
1613
+ # delete the dataview.
1614
+ # @return [String]
1615
+ #
1616
+ # @!attribute [rw] scaling_group_name
1617
+ # A unique identifier for the kdb scaling group.
1618
+ # @return [String]
1619
+ #
1620
+ # @!attribute [rw] client_token
1621
+ # A token that ensures idempotency. This token expires in 10 minutes.
1622
+ #
1623
+ # **A suitable default value is auto-generated.** You should normally
1624
+ # not need to pass this option.
1625
+ # @return [String]
1626
+ #
1627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxScalingGroupRequest AWS API Documentation
1628
+ #
1629
+ class DeleteKxScalingGroupRequest < Struct.new(
1630
+ :environment_id,
1631
+ :scaling_group_name,
1632
+ :client_token)
1633
+ SENSITIVE = []
1634
+ include Aws::Structure
1635
+ end
1636
+
1637
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxScalingGroupResponse AWS API Documentation
1638
+ #
1639
+ class DeleteKxScalingGroupResponse < Aws::EmptyStructure; end
1640
+
1052
1641
  # @!attribute [rw] user_name
1053
1642
  # A unique identifier for the user that you want to delete.
1054
1643
  # @return [String]
@@ -1057,11 +1646,19 @@ module Aws::Finspace
1057
1646
  # A unique identifier for the kdb environment.
1058
1647
  # @return [String]
1059
1648
  #
1649
+ # @!attribute [rw] client_token
1650
+ # A token that ensures idempotency. This token expires in 10 minutes.
1651
+ #
1652
+ # **A suitable default value is auto-generated.** You should normally
1653
+ # not need to pass this option.
1654
+ # @return [String]
1655
+ #
1060
1656
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxUserRequest AWS API Documentation
1061
1657
  #
1062
1658
  class DeleteKxUserRequest < Struct.new(
1063
1659
  :user_name,
1064
- :environment_id)
1660
+ :environment_id,
1661
+ :client_token)
1065
1662
  SENSITIVE = []
1066
1663
  include Aws::Structure
1067
1664
  end
@@ -1070,6 +1667,36 @@ module Aws::Finspace
1070
1667
  #
1071
1668
  class DeleteKxUserResponse < Aws::EmptyStructure; end
1072
1669
 
1670
+ # @!attribute [rw] environment_id
1671
+ # A unique identifier for the kdb environment, whose clusters can
1672
+ # attach to the volume.
1673
+ # @return [String]
1674
+ #
1675
+ # @!attribute [rw] volume_name
1676
+ # The name of the volume that you want to delete.
1677
+ # @return [String]
1678
+ #
1679
+ # @!attribute [rw] client_token
1680
+ # A token that ensures idempotency. This token expires in 10 minutes.
1681
+ #
1682
+ # **A suitable default value is auto-generated.** You should normally
1683
+ # not need to pass this option.
1684
+ # @return [String]
1685
+ #
1686
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxVolumeRequest AWS API Documentation
1687
+ #
1688
+ class DeleteKxVolumeRequest < Struct.new(
1689
+ :environment_id,
1690
+ :volume_name,
1691
+ :client_token)
1692
+ SENSITIVE = []
1693
+ include Aws::Structure
1694
+ end
1695
+
1696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxVolumeResponse AWS API Documentation
1697
+ #
1698
+ class DeleteKxVolumeResponse < Aws::EmptyStructure; end
1699
+
1073
1700
  # Represents an FinSpace environment.
1074
1701
  #
1075
1702
  # @!attribute [rw] name
@@ -1392,8 +2019,33 @@ module Aws::Finspace
1392
2019
  # processes in kdb systems. It allows you to create your own routing
1393
2020
  # logic using the initialization scripts and custom code. This type
1394
2021
  # of cluster does not require a writable local storage.
2022
+ #
2023
+ # * GP – A general purpose cluster allows you to quickly iterate on
2024
+ # code during development by granting greater access to system
2025
+ # commands and enabling a fast reload of custom code. This cluster
2026
+ # type can optionally mount databases including cache and savedown
2027
+ # storage. For this cluster type, the node count is fixed at 1. It
2028
+ # does not support autoscaling and supports only `SINGLE` AZ mode.
2029
+ #
2030
+ # * Tickerplant – A tickerplant cluster allows you to subscribe to
2031
+ # feed handlers based on IAM permissions. It can publish to RDBs,
2032
+ # other Tickerplants, and real-time subscribers (RTS). Tickerplants
2033
+ # can persist messages to log, which is readable by any RDB
2034
+ # environment. It supports only single-node that is only one kdb
2035
+ # process.
1395
2036
  # @return [String]
1396
2037
  #
2038
+ # @!attribute [rw] tickerplant_log_configuration
2039
+ # A configuration to store the Tickerplant logs. It consists of a list
2040
+ # of volumes that will be mounted to your cluster. For the cluster
2041
+ # type `Tickerplant`, the location of the TP volume on the cluster
2042
+ # will be available by using the global variable `.aws.tp_log_path`.
2043
+ # @return [Types::TickerplantLogConfiguration]
2044
+ #
2045
+ # @!attribute [rw] volumes
2046
+ # A list of volumes attached to the cluster.
2047
+ # @return [Array<Types::Volume>]
2048
+ #
1397
2049
  # @!attribute [rw] databases
1398
2050
  # A list of databases mounted on the cluster.
1399
2051
  # @return [Array<Types::KxDatabaseConfiguration>]
@@ -1484,6 +2136,11 @@ module Aws::Finspace
1484
2136
  # 1635768000000.
1485
2137
  # @return [Time]
1486
2138
  #
2139
+ # @!attribute [rw] scaling_group_configuration
2140
+ # The structure that stores the capacity configuration details of a
2141
+ # scaling group.
2142
+ # @return [Types::KxScalingGroupConfiguration]
2143
+ #
1487
2144
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxClusterResponse AWS API Documentation
1488
2145
  #
1489
2146
  class GetKxClusterResponse < Struct.new(
@@ -1491,6 +2148,8 @@ module Aws::Finspace
1491
2148
  :status_reason,
1492
2149
  :cluster_name,
1493
2150
  :cluster_type,
2151
+ :tickerplant_log_configuration,
2152
+ :volumes,
1494
2153
  :databases,
1495
2154
  :cache_storage_configurations,
1496
2155
  :auto_scaling_configuration,
@@ -1506,7 +2165,8 @@ module Aws::Finspace
1506
2165
  :savedown_storage_configuration,
1507
2166
  :az_mode,
1508
2167
  :availability_zone_id,
1509
- :created_timestamp)
2168
+ :created_timestamp,
2169
+ :scaling_group_configuration)
1510
2170
  SENSITIVE = []
1511
2171
  include Aws::Structure
1512
2172
  end
@@ -1632,6 +2292,132 @@ module Aws::Finspace
1632
2292
  include Aws::Structure
1633
2293
  end
1634
2294
 
2295
+ # @!attribute [rw] environment_id
2296
+ # A unique identifier for the kdb environment, from where you want to
2297
+ # retrieve the dataview details.
2298
+ # @return [String]
2299
+ #
2300
+ # @!attribute [rw] database_name
2301
+ # The name of the database where you created the dataview.
2302
+ # @return [String]
2303
+ #
2304
+ # @!attribute [rw] dataview_name
2305
+ # A unique identifier for the dataview.
2306
+ # @return [String]
2307
+ #
2308
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxDataviewRequest AWS API Documentation
2309
+ #
2310
+ class GetKxDataviewRequest < Struct.new(
2311
+ :environment_id,
2312
+ :database_name,
2313
+ :dataview_name)
2314
+ SENSITIVE = []
2315
+ include Aws::Structure
2316
+ end
2317
+
2318
+ # @!attribute [rw] database_name
2319
+ # The name of the database where you created the dataview.
2320
+ # @return [String]
2321
+ #
2322
+ # @!attribute [rw] dataview_name
2323
+ # A unique identifier for the dataview.
2324
+ # @return [String]
2325
+ #
2326
+ # @!attribute [rw] az_mode
2327
+ # The number of availability zones you want to assign per cluster.
2328
+ # This can be one of the following
2329
+ #
2330
+ # * `SINGLE` – Assigns one availability zone per cluster.
2331
+ #
2332
+ # * `MULTI` – Assigns all the availability zones per cluster.
2333
+ # @return [String]
2334
+ #
2335
+ # @!attribute [rw] availability_zone_id
2336
+ # The identifier of the availability zones.
2337
+ # @return [String]
2338
+ #
2339
+ # @!attribute [rw] changeset_id
2340
+ # A unique identifier of the changeset that you want to use to ingest
2341
+ # data.
2342
+ # @return [String]
2343
+ #
2344
+ # @!attribute [rw] segment_configurations
2345
+ # The configuration that contains the database path of the data that
2346
+ # you want to place on each selected volume. Each segment must have a
2347
+ # unique database path for each volume. If you do not explicitly
2348
+ # specify any database path for a volume, they are accessible from the
2349
+ # cluster through the default S3/object store segment.
2350
+ # @return [Array<Types::KxDataviewSegmentConfiguration>]
2351
+ #
2352
+ # @!attribute [rw] active_versions
2353
+ # The current active changeset versions of the database on the given
2354
+ # dataview.
2355
+ # @return [Array<Types::KxDataviewActiveVersion>]
2356
+ #
2357
+ # @!attribute [rw] description
2358
+ # A description of the dataview.
2359
+ # @return [String]
2360
+ #
2361
+ # @!attribute [rw] auto_update
2362
+ # The option to specify whether you want to apply all the future
2363
+ # additions and corrections automatically to the dataview when new
2364
+ # changesets are ingested. The default value is false.
2365
+ # @return [Boolean]
2366
+ #
2367
+ # @!attribute [rw] environment_id
2368
+ # A unique identifier for the kdb environment, from where you want to
2369
+ # retrieve the dataview details.
2370
+ # @return [String]
2371
+ #
2372
+ # @!attribute [rw] created_timestamp
2373
+ # The timestamp at which the dataview was created in FinSpace. The
2374
+ # value is determined as epoch time in milliseconds. For example, the
2375
+ # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
2376
+ # 1635768000000.
2377
+ # @return [Time]
2378
+ #
2379
+ # @!attribute [rw] last_modified_timestamp
2380
+ # The last time that the dataview was updated in FinSpace. The value
2381
+ # is determined as epoch time in milliseconds. For example, the value
2382
+ # for Monday, November 1, 2021 12:00:00 PM UTC is specified as
2383
+ # 1635768000000.
2384
+ # @return [Time]
2385
+ #
2386
+ # @!attribute [rw] status
2387
+ # The status of dataview creation.
2388
+ #
2389
+ # * `CREATING` – The dataview creation is in progress.
2390
+ #
2391
+ # * `UPDATING` – The dataview is in the process of being updated.
2392
+ #
2393
+ # * `ACTIVE` – The dataview is active.
2394
+ # @return [String]
2395
+ #
2396
+ # @!attribute [rw] status_reason
2397
+ # The error message when a failed state occurs.
2398
+ # @return [String]
2399
+ #
2400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxDataviewResponse AWS API Documentation
2401
+ #
2402
+ class GetKxDataviewResponse < Struct.new(
2403
+ :database_name,
2404
+ :dataview_name,
2405
+ :az_mode,
2406
+ :availability_zone_id,
2407
+ :changeset_id,
2408
+ :segment_configurations,
2409
+ :active_versions,
2410
+ :description,
2411
+ :auto_update,
2412
+ :environment_id,
2413
+ :created_timestamp,
2414
+ :last_modified_timestamp,
2415
+ :status,
2416
+ :status_reason)
2417
+ SENSITIVE = []
2418
+ include Aws::Structure
2419
+ end
2420
+
1635
2421
  # @!attribute [rw] environment_id
1636
2422
  # A unique identifier for the kdb environment.
1637
2423
  # @return [String]
@@ -1741,10 +2527,103 @@ module Aws::Finspace
1741
2527
  include Aws::Structure
1742
2528
  end
1743
2529
 
1744
- # @!attribute [rw] user_name
1745
- # A unique identifier for the user.
1746
- # @return [String]
1747
- #
2530
+ # @!attribute [rw] environment_id
2531
+ # A unique identifier for the kdb environment.
2532
+ # @return [String]
2533
+ #
2534
+ # @!attribute [rw] scaling_group_name
2535
+ # A unique identifier for the kdb scaling group.
2536
+ # @return [String]
2537
+ #
2538
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxScalingGroupRequest AWS API Documentation
2539
+ #
2540
+ class GetKxScalingGroupRequest < Struct.new(
2541
+ :environment_id,
2542
+ :scaling_group_name)
2543
+ SENSITIVE = []
2544
+ include Aws::Structure
2545
+ end
2546
+
2547
+ # @!attribute [rw] scaling_group_name
2548
+ # A unique identifier for the kdb scaling group.
2549
+ # @return [String]
2550
+ #
2551
+ # @!attribute [rw] scaling_group_arn
2552
+ # The ARN identifier for the scaling group.
2553
+ # @return [String]
2554
+ #
2555
+ # @!attribute [rw] host_type
2556
+ # The memory and CPU capabilities of the scaling group host on which
2557
+ # FinSpace Managed kdb clusters will be placed.
2558
+ # @return [String]
2559
+ #
2560
+ # @!attribute [rw] clusters
2561
+ # The list of Managed kdb clusters that are currently active in the
2562
+ # given scaling group.
2563
+ # @return [Array<String>]
2564
+ #
2565
+ # @!attribute [rw] availability_zone_id
2566
+ # The identifier of the availability zones.
2567
+ # @return [String]
2568
+ #
2569
+ # @!attribute [rw] status
2570
+ # The status of scaling group.
2571
+ #
2572
+ # * CREATING – The scaling group creation is in progress.
2573
+ #
2574
+ # * CREATE\_FAILED – The scaling group creation has failed.
2575
+ #
2576
+ # * ACTIVE – The scaling group is active.
2577
+ #
2578
+ # * UPDATING – The scaling group is in the process of being updated.
2579
+ #
2580
+ # * UPDATE\_FAILED – The update action failed.
2581
+ #
2582
+ # * DELETING – The scaling group is in the process of being deleted.
2583
+ #
2584
+ # * DELETE\_FAILED – The system failed to delete the scaling group.
2585
+ #
2586
+ # * DELETED – The scaling group is successfully deleted.
2587
+ # @return [String]
2588
+ #
2589
+ # @!attribute [rw] status_reason
2590
+ # The error message when a failed state occurs.
2591
+ # @return [String]
2592
+ #
2593
+ # @!attribute [rw] last_modified_timestamp
2594
+ # The last time that the scaling group was updated in FinSpace. The
2595
+ # value is determined as epoch time in milliseconds. For example, the
2596
+ # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
2597
+ # 1635768000000.
2598
+ # @return [Time]
2599
+ #
2600
+ # @!attribute [rw] created_timestamp
2601
+ # The timestamp at which the scaling group was created in FinSpace.
2602
+ # The value is determined as epoch time in milliseconds. For example,
2603
+ # the value for Monday, November 1, 2021 12:00:00 PM UTC is specified
2604
+ # as 1635768000000.
2605
+ # @return [Time]
2606
+ #
2607
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxScalingGroupResponse AWS API Documentation
2608
+ #
2609
+ class GetKxScalingGroupResponse < Struct.new(
2610
+ :scaling_group_name,
2611
+ :scaling_group_arn,
2612
+ :host_type,
2613
+ :clusters,
2614
+ :availability_zone_id,
2615
+ :status,
2616
+ :status_reason,
2617
+ :last_modified_timestamp,
2618
+ :created_timestamp)
2619
+ SENSITIVE = []
2620
+ include Aws::Structure
2621
+ end
2622
+
2623
+ # @!attribute [rw] user_name
2624
+ # A unique identifier for the user.
2625
+ # @return [String]
2626
+ #
1748
2627
  # @!attribute [rw] environment_id
1749
2628
  # A unique identifier for the kdb environment.
1750
2629
  # @return [String]
@@ -1791,6 +2670,124 @@ module Aws::Finspace
1791
2670
  include Aws::Structure
1792
2671
  end
1793
2672
 
2673
+ # @!attribute [rw] environment_id
2674
+ # A unique identifier for the kdb environment, whose clusters can
2675
+ # attach to the volume.
2676
+ # @return [String]
2677
+ #
2678
+ # @!attribute [rw] volume_name
2679
+ # A unique identifier for the volume.
2680
+ # @return [String]
2681
+ #
2682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxVolumeRequest AWS API Documentation
2683
+ #
2684
+ class GetKxVolumeRequest < Struct.new(
2685
+ :environment_id,
2686
+ :volume_name)
2687
+ SENSITIVE = []
2688
+ include Aws::Structure
2689
+ end
2690
+
2691
+ # @!attribute [rw] environment_id
2692
+ # A unique identifier for the kdb environment, whose clusters can
2693
+ # attach to the volume.
2694
+ # @return [String]
2695
+ #
2696
+ # @!attribute [rw] volume_name
2697
+ # A unique identifier for the volume.
2698
+ # @return [String]
2699
+ #
2700
+ # @!attribute [rw] volume_type
2701
+ # The type of file system volume. Currently, FinSpace only supports
2702
+ # `NAS_1` volume type.
2703
+ # @return [String]
2704
+ #
2705
+ # @!attribute [rw] volume_arn
2706
+ # The ARN identifier of the volume.
2707
+ # @return [String]
2708
+ #
2709
+ # @!attribute [rw] nas1_configuration
2710
+ # Specifies the configuration for the Network attached storage
2711
+ # (NAS\_1) file system volume.
2712
+ # @return [Types::KxNAS1Configuration]
2713
+ #
2714
+ # @!attribute [rw] status
2715
+ # The status of volume creation.
2716
+ #
2717
+ # * CREATING – The volume creation is in progress.
2718
+ #
2719
+ # * CREATE\_FAILED – The volume creation has failed.
2720
+ #
2721
+ # * ACTIVE – The volume is active.
2722
+ #
2723
+ # * UPDATING – The volume is in the process of being updated.
2724
+ #
2725
+ # * UPDATE\_FAILED – The update action failed.
2726
+ #
2727
+ # * UPDATED – The volume is successfully updated.
2728
+ #
2729
+ # * DELETING – The volume is in the process of being deleted.
2730
+ #
2731
+ # * DELETE\_FAILED – The system failed to delete the volume.
2732
+ #
2733
+ # * DELETED – The volume is successfully deleted.
2734
+ # @return [String]
2735
+ #
2736
+ # @!attribute [rw] status_reason
2737
+ # The error message when a failed state occurs.
2738
+ # @return [String]
2739
+ #
2740
+ # @!attribute [rw] created_timestamp
2741
+ # The timestamp at which the volume was created in FinSpace. The value
2742
+ # is determined as epoch time in milliseconds. For example, the value
2743
+ # for Monday, November 1, 2021 12:00:00 PM UTC is specified as
2744
+ # 1635768000000.
2745
+ # @return [Time]
2746
+ #
2747
+ # @!attribute [rw] description
2748
+ # A description of the volume.
2749
+ # @return [String]
2750
+ #
2751
+ # @!attribute [rw] az_mode
2752
+ # The number of availability zones you want to assign per cluster.
2753
+ # Currently, FinSpace only support `SINGLE` for volumes.
2754
+ # @return [String]
2755
+ #
2756
+ # @!attribute [rw] availability_zone_ids
2757
+ # The identifier of the availability zones.
2758
+ # @return [Array<String>]
2759
+ #
2760
+ # @!attribute [rw] last_modified_timestamp
2761
+ # The last time that the volume was updated in FinSpace. The value is
2762
+ # determined as epoch time in milliseconds. For example, the value for
2763
+ # Monday, November 1, 2021 12:00:00 PM UTC is specified as
2764
+ # 1635768000000.
2765
+ # @return [Time]
2766
+ #
2767
+ # @!attribute [rw] attached_clusters
2768
+ # A list of cluster identifiers that a volume is attached to.
2769
+ # @return [Array<Types::KxAttachedCluster>]
2770
+ #
2771
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/GetKxVolumeResponse AWS API Documentation
2772
+ #
2773
+ class GetKxVolumeResponse < Struct.new(
2774
+ :environment_id,
2775
+ :volume_name,
2776
+ :volume_type,
2777
+ :volume_arn,
2778
+ :nas1_configuration,
2779
+ :status,
2780
+ :status_reason,
2781
+ :created_timestamp,
2782
+ :description,
2783
+ :az_mode,
2784
+ :availability_zone_ids,
2785
+ :last_modified_timestamp,
2786
+ :attached_clusters)
2787
+ SENSITIVE = []
2788
+ include Aws::Structure
2789
+ end
2790
+
1794
2791
  # Defines the ICMP protocol that consists of the ICMP type and code.
1795
2792
  #
1796
2793
  # @!attribute [rw] type
@@ -1839,6 +2836,47 @@ module Aws::Finspace
1839
2836
  include Aws::Structure
1840
2837
  end
1841
2838
 
2839
+ # The structure containing the metadata of the attached clusters.
2840
+ #
2841
+ # @!attribute [rw] cluster_name
2842
+ # A unique name for the attached cluster.
2843
+ # @return [String]
2844
+ #
2845
+ # @!attribute [rw] cluster_type
2846
+ # Specifies the type of cluster. The volume for TP and RDB cluster
2847
+ # types will be used for TP logs.
2848
+ # @return [String]
2849
+ #
2850
+ # @!attribute [rw] cluster_status
2851
+ # The status of the attached cluster.
2852
+ #
2853
+ # * PENDING – The cluster is pending creation.
2854
+ #
2855
+ # * CREATING – The cluster creation process is in progress.
2856
+ #
2857
+ # * CREATE\_FAILED – The cluster creation process has failed.
2858
+ #
2859
+ # * RUNNING – The cluster creation process is running.
2860
+ #
2861
+ # * UPDATING – The cluster is in the process of being updated.
2862
+ #
2863
+ # * DELETING – The cluster is in the process of being deleted.
2864
+ #
2865
+ # * DELETED – The cluster has been deleted.
2866
+ #
2867
+ # * DELETE\_FAILED – The cluster failed to delete.
2868
+ # @return [String]
2869
+ #
2870
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxAttachedCluster AWS API Documentation
2871
+ #
2872
+ class KxAttachedCluster < Struct.new(
2873
+ :cluster_name,
2874
+ :cluster_type,
2875
+ :cluster_status)
2876
+ SENSITIVE = []
2877
+ include Aws::Structure
2878
+ end
2879
+
1842
2880
  # The configuration for read only disk cache associated with a cluster.
1843
2881
  #
1844
2882
  # @!attribute [rw] type
@@ -1972,6 +3010,20 @@ module Aws::Finspace
1972
3010
  # processes in kdb systems. It allows you to create your own routing
1973
3011
  # logic using the initialization scripts and custom code. This type
1974
3012
  # of cluster does not require a writable local storage.
3013
+ #
3014
+ # * GP – A general purpose cluster allows you to quickly iterate on
3015
+ # code during development by granting greater access to system
3016
+ # commands and enabling a fast reload of custom code. This cluster
3017
+ # type can optionally mount databases including cache and savedown
3018
+ # storage. For this cluster type, the node count is fixed at 1. It
3019
+ # does not support autoscaling and supports only `SINGLE` AZ mode.
3020
+ #
3021
+ # * Tickerplant – A tickerplant cluster allows you to subscribe to
3022
+ # feed handlers based on IAM permissions. It can publish to RDBs,
3023
+ # other Tickerplants, and real-time subscribers (RTS). Tickerplants
3024
+ # can persist messages to log, which is readable by any RDB
3025
+ # environment. It supports only single-node that is only one kdb
3026
+ # process.
1975
3027
  # @return [String]
1976
3028
  #
1977
3029
  # @!attribute [rw] cluster_description
@@ -1982,6 +3034,10 @@ module Aws::Finspace
1982
3034
  # A version of the FinSpace managed kdb to run.
1983
3035
  # @return [String]
1984
3036
  #
3037
+ # @!attribute [rw] volumes
3038
+ # A list of volumes attached to the cluster.
3039
+ # @return [Array<Types::Volume>]
3040
+ #
1985
3041
  # @!attribute [rw] initialization_script
1986
3042
  # Specifies a Q program that will be run at launch of a cluster. It is
1987
3043
  # a relative path within *.zip* file that contains the custom code,
@@ -2030,6 +3086,7 @@ module Aws::Finspace
2030
3086
  :cluster_type,
2031
3087
  :cluster_description,
2032
3088
  :release_label,
3089
+ :volumes,
2033
3090
  :initialization_script,
2034
3091
  :execution_role,
2035
3092
  :az_mode,
@@ -2050,6 +3107,14 @@ module Aws::Finspace
2050
3107
  # * ROLLING – This options updates the cluster by stopping the exiting
2051
3108
  # q process and starting a new q process with updated configuration.
2052
3109
  #
3110
+ # * NO\_RESTART – This option updates the cluster without stopping the
3111
+ # running q process. It is only available for `GP` type cluster.
3112
+ # This option is quicker as it reduces the turn around time to
3113
+ # update configuration on a cluster.
3114
+ #
3115
+ # With this deployment mode, you cannot update the
3116
+ # `initializationScript` and `commandLineArguments` parameters.
3117
+ #
2053
3118
  # * FORCE – This option updates the cluster by immediately stopping
2054
3119
  # all the running processes before starting up new ones with the
2055
3120
  # updated configuration.
@@ -2100,11 +3165,17 @@ module Aws::Finspace
2100
3165
  # cache for access.
2101
3166
  # @return [Array<String>]
2102
3167
  #
3168
+ # @!attribute [rw] dataview_name
3169
+ # The name of the dataview to be used for caching historical data on
3170
+ # disk.
3171
+ # @return [String]
3172
+ #
2103
3173
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxDatabaseCacheConfiguration AWS API Documentation
2104
3174
  #
2105
3175
  class KxDatabaseCacheConfiguration < Struct.new(
2106
3176
  :cache_type,
2107
- :db_paths)
3177
+ :db_paths,
3178
+ :dataview_name)
2108
3179
  SENSITIVE = []
2109
3180
  include Aws::Structure
2110
3181
  end
@@ -2127,12 +3198,23 @@ module Aws::Finspace
2127
3198
  # cluster.
2128
3199
  # @return [String]
2129
3200
  #
3201
+ # @!attribute [rw] dataview_name
3202
+ # The name of the dataview to be used for caching historical data on
3203
+ # disk.
3204
+ # @return [String]
3205
+ #
3206
+ # @!attribute [rw] dataview_configuration
3207
+ # The configuration of the dataview to be used with specified cluster.
3208
+ # @return [Types::KxDataviewConfiguration]
3209
+ #
2130
3210
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxDatabaseConfiguration AWS API Documentation
2131
3211
  #
2132
3212
  class KxDatabaseConfiguration < Struct.new(
2133
3213
  :database_name,
2134
3214
  :cache_configurations,
2135
- :changeset_id)
3215
+ :changeset_id,
3216
+ :dataview_name,
3217
+ :dataview_configuration)
2136
3218
  SENSITIVE = []
2137
3219
  include Aws::Structure
2138
3220
  end
@@ -2157,12 +3239,204 @@ module Aws::Finspace
2157
3239
  # 1635768000000.
2158
3240
  # @return [Time]
2159
3241
  #
2160
- # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxDatabaseListEntry AWS API Documentation
3242
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxDatabaseListEntry AWS API Documentation
3243
+ #
3244
+ class KxDatabaseListEntry < Struct.new(
3245
+ :database_name,
3246
+ :created_timestamp,
3247
+ :last_modified_timestamp)
3248
+ SENSITIVE = []
3249
+ include Aws::Structure
3250
+ end
3251
+
3252
+ # The active version of the dataview that is currently in use by this
3253
+ # cluster.
3254
+ #
3255
+ # @!attribute [rw] changeset_id
3256
+ # A unique identifier for the changeset.
3257
+ # @return [String]
3258
+ #
3259
+ # @!attribute [rw] segment_configurations
3260
+ # The configuration that contains the database path of the data that
3261
+ # you want to place on each selected volume. Each segment must have a
3262
+ # unique database path for each volume. If you do not explicitly
3263
+ # specify any database path for a volume, they are accessible from the
3264
+ # cluster through the default S3/object store segment.
3265
+ # @return [Array<Types::KxDataviewSegmentConfiguration>]
3266
+ #
3267
+ # @!attribute [rw] attached_clusters
3268
+ # The list of clusters that are currently using this dataview.
3269
+ # @return [Array<String>]
3270
+ #
3271
+ # @!attribute [rw] created_timestamp
3272
+ # The timestamp at which the dataview version was active. The value is
3273
+ # determined as epoch time in milliseconds. For example, the value for
3274
+ # Monday, November 1, 2021 12:00:00 PM UTC is specified as
3275
+ # 1635768000000.
3276
+ # @return [Time]
3277
+ #
3278
+ # @!attribute [rw] version_id
3279
+ # A unique identifier of the active version.
3280
+ # @return [String]
3281
+ #
3282
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxDataviewActiveVersion AWS API Documentation
3283
+ #
3284
+ class KxDataviewActiveVersion < Struct.new(
3285
+ :changeset_id,
3286
+ :segment_configurations,
3287
+ :attached_clusters,
3288
+ :created_timestamp,
3289
+ :version_id)
3290
+ SENSITIVE = []
3291
+ include Aws::Structure
3292
+ end
3293
+
3294
+ # The structure that stores the configuration details of a dataview.
3295
+ #
3296
+ # @!attribute [rw] dataview_name
3297
+ # The unique identifier of the dataview.
3298
+ # @return [String]
3299
+ #
3300
+ # @!attribute [rw] dataview_version_id
3301
+ # The version of the dataview corresponding to a given changeset.
3302
+ # @return [String]
3303
+ #
3304
+ # @!attribute [rw] changeset_id
3305
+ # A unique identifier for the changeset.
3306
+ # @return [String]
3307
+ #
3308
+ # @!attribute [rw] segment_configurations
3309
+ # The db path and volume configuration for the segmented database.
3310
+ # @return [Array<Types::KxDataviewSegmentConfiguration>]
3311
+ #
3312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxDataviewConfiguration AWS API Documentation
3313
+ #
3314
+ class KxDataviewConfiguration < Struct.new(
3315
+ :dataview_name,
3316
+ :dataview_version_id,
3317
+ :changeset_id,
3318
+ :segment_configurations)
3319
+ SENSITIVE = []
3320
+ include Aws::Structure
3321
+ end
3322
+
3323
+ # A collection of kdb dataview entries.
3324
+ #
3325
+ # @!attribute [rw] environment_id
3326
+ # A unique identifier for the kdb environment.
3327
+ # @return [String]
3328
+ #
3329
+ # @!attribute [rw] database_name
3330
+ # A unique identifier of the database.
3331
+ # @return [String]
3332
+ #
3333
+ # @!attribute [rw] dataview_name
3334
+ # A unique identifier of the dataview.
3335
+ # @return [String]
3336
+ #
3337
+ # @!attribute [rw] az_mode
3338
+ # The number of availability zones you want to assign per cluster.
3339
+ # This can be one of the following
3340
+ #
3341
+ # * `SINGLE` – Assigns one availability zone per cluster.
3342
+ #
3343
+ # * `MULTI` – Assigns all the availability zones per cluster.
3344
+ # @return [String]
3345
+ #
3346
+ # @!attribute [rw] availability_zone_id
3347
+ # The identifier of the availability zones.
3348
+ # @return [String]
3349
+ #
3350
+ # @!attribute [rw] changeset_id
3351
+ # A unique identifier for the changeset.
3352
+ # @return [String]
3353
+ #
3354
+ # @!attribute [rw] segment_configurations
3355
+ # The configuration that contains the database path of the data that
3356
+ # you want to place on each selected volume. Each segment must have a
3357
+ # unique database path for each volume. If you do not explicitly
3358
+ # specify any database path for a volume, they are accessible from the
3359
+ # cluster through the default S3/object store segment.
3360
+ # @return [Array<Types::KxDataviewSegmentConfiguration>]
3361
+ #
3362
+ # @!attribute [rw] active_versions
3363
+ # The active changeset versions for the given dataview entry.
3364
+ # @return [Array<Types::KxDataviewActiveVersion>]
3365
+ #
3366
+ # @!attribute [rw] status
3367
+ # The status of a given dataview entry.
3368
+ # @return [String]
3369
+ #
3370
+ # @!attribute [rw] description
3371
+ # A description for the dataview list entry.
3372
+ # @return [String]
3373
+ #
3374
+ # @!attribute [rw] auto_update
3375
+ # The option to specify whether you want to apply all the future
3376
+ # additions and corrections automatically to the dataview when you
3377
+ # ingest new changesets. The default value is false.
3378
+ # @return [Boolean]
3379
+ #
3380
+ # @!attribute [rw] created_timestamp
3381
+ # The timestamp at which the dataview list entry was created in
3382
+ # FinSpace. The value is determined as epoch time in milliseconds. For
3383
+ # example, the value for Monday, November 1, 2021 12:00:00 PM UTC is
3384
+ # specified as 1635768000000.
3385
+ # @return [Time]
3386
+ #
3387
+ # @!attribute [rw] last_modified_timestamp
3388
+ # The last time that the dataview list was updated in FinSpace. The
3389
+ # value is determined as epoch time in milliseconds. For example, the
3390
+ # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
3391
+ # 1635768000000.
3392
+ # @return [Time]
3393
+ #
3394
+ # @!attribute [rw] status_reason
3395
+ # The error message when a failed state occurs.
3396
+ # @return [String]
3397
+ #
3398
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxDataviewListEntry AWS API Documentation
2161
3399
  #
2162
- class KxDatabaseListEntry < Struct.new(
3400
+ class KxDataviewListEntry < Struct.new(
3401
+ :environment_id,
2163
3402
  :database_name,
3403
+ :dataview_name,
3404
+ :az_mode,
3405
+ :availability_zone_id,
3406
+ :changeset_id,
3407
+ :segment_configurations,
3408
+ :active_versions,
3409
+ :status,
3410
+ :description,
3411
+ :auto_update,
2164
3412
  :created_timestamp,
2165
- :last_modified_timestamp)
3413
+ :last_modified_timestamp,
3414
+ :status_reason)
3415
+ SENSITIVE = []
3416
+ include Aws::Structure
3417
+ end
3418
+
3419
+ # The configuration that contains the database path of the data that you
3420
+ # want to place on each selected volume. Each segment must have a unique
3421
+ # database path for each volume. If you do not explicitly specify any
3422
+ # database path for a volume, they are accessible from the cluster
3423
+ # through the default S3/object store segment.
3424
+ #
3425
+ # @!attribute [rw] db_paths
3426
+ # The database path of the data that you want to place on each
3427
+ # selected volume for the segment. Each segment must have a unique
3428
+ # database path for each volume.
3429
+ # @return [Array<String>]
3430
+ #
3431
+ # @!attribute [rw] volume_name
3432
+ # The name of the volume where you want to add data.
3433
+ # @return [String]
3434
+ #
3435
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxDataviewSegmentConfiguration AWS API Documentation
3436
+ #
3437
+ class KxDataviewSegmentConfiguration < Struct.new(
3438
+ :db_paths,
3439
+ :volume_name)
2166
3440
  SENSITIVE = []
2167
3441
  include Aws::Structure
2168
3442
  end
@@ -2318,6 +3592,26 @@ module Aws::Finspace
2318
3592
  include Aws::Structure
2319
3593
  end
2320
3594
 
3595
+ # The structure containing the size and type of the network attached
3596
+ # storage (NAS\_1) file system volume.
3597
+ #
3598
+ # @!attribute [rw] type
3599
+ # The type of the network attached storage.
3600
+ # @return [String]
3601
+ #
3602
+ # @!attribute [rw] size
3603
+ # The size of the network attached storage.
3604
+ # @return [Integer]
3605
+ #
3606
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxNAS1Configuration AWS API Documentation
3607
+ #
3608
+ class KxNAS1Configuration < Struct.new(
3609
+ :type,
3610
+ :size)
3611
+ SENSITIVE = []
3612
+ include Aws::Structure
3613
+ end
3614
+
2321
3615
  # A structure that stores metadata for a kdb node.
2322
3616
  #
2323
3617
  # @!attribute [rw] node_id
@@ -2362,11 +3656,112 @@ module Aws::Finspace
2362
3656
  # The size of temporary storage in gibibytes.
2363
3657
  # @return [Integer]
2364
3658
  #
3659
+ # @!attribute [rw] volume_name
3660
+ # The name of the kdb volume that you want to use as writeable
3661
+ # save-down storage for clusters.
3662
+ # @return [String]
3663
+ #
2365
3664
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxSavedownStorageConfiguration AWS API Documentation
2366
3665
  #
2367
3666
  class KxSavedownStorageConfiguration < Struct.new(
2368
3667
  :type,
2369
- :size)
3668
+ :size,
3669
+ :volume_name)
3670
+ SENSITIVE = []
3671
+ include Aws::Structure
3672
+ end
3673
+
3674
+ # A structure for storing metadata of scaling group.
3675
+ #
3676
+ # @!attribute [rw] scaling_group_name
3677
+ # A unique identifier for the kdb scaling group.
3678
+ # @return [String]
3679
+ #
3680
+ # @!attribute [rw] host_type
3681
+ # The memory and CPU capabilities of the scaling group host on which
3682
+ # FinSpace Managed kdb clusters will be placed.
3683
+ # @return [String]
3684
+ #
3685
+ # @!attribute [rw] clusters
3686
+ # The list of clusters currently active in a given scaling group.
3687
+ # @return [Array<String>]
3688
+ #
3689
+ # @!attribute [rw] availability_zone_id
3690
+ # The identifier of the availability zones.
3691
+ # @return [String]
3692
+ #
3693
+ # @!attribute [rw] status
3694
+ # The status of scaling groups.
3695
+ # @return [String]
3696
+ #
3697
+ # @!attribute [rw] status_reason
3698
+ # The error message when a failed state occurs.
3699
+ # @return [String]
3700
+ #
3701
+ # @!attribute [rw] last_modified_timestamp
3702
+ # The last time that the scaling group was updated in FinSpace. The
3703
+ # value is determined as epoch time in milliseconds. For example, the
3704
+ # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
3705
+ # 1635768000000.
3706
+ # @return [Time]
3707
+ #
3708
+ # @!attribute [rw] created_timestamp
3709
+ # The timestamp at which the scaling group was created in FinSpace.
3710
+ # The value is determined as epoch time in milliseconds. For example,
3711
+ # the value for Monday, November 1, 2021 12:00:00 PM UTC is specified
3712
+ # as 1635768000000.
3713
+ # @return [Time]
3714
+ #
3715
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxScalingGroup AWS API Documentation
3716
+ #
3717
+ class KxScalingGroup < Struct.new(
3718
+ :scaling_group_name,
3719
+ :host_type,
3720
+ :clusters,
3721
+ :availability_zone_id,
3722
+ :status,
3723
+ :status_reason,
3724
+ :last_modified_timestamp,
3725
+ :created_timestamp)
3726
+ SENSITIVE = []
3727
+ include Aws::Structure
3728
+ end
3729
+
3730
+ # The structure that stores the capacity configuration details of a
3731
+ # scaling group.
3732
+ #
3733
+ # @!attribute [rw] scaling_group_name
3734
+ # A unique identifier for the kdb scaling group.
3735
+ # @return [String]
3736
+ #
3737
+ # @!attribute [rw] memory_limit
3738
+ # An optional hard limit on the amount of memory a kdb cluster can
3739
+ # use.
3740
+ # @return [Integer]
3741
+ #
3742
+ # @!attribute [rw] memory_reservation
3743
+ # A reservation of the minimum amount of memory that should be
3744
+ # available on the scaling group for a kdb cluster to be successfully
3745
+ # placed in a scaling group.
3746
+ # @return [Integer]
3747
+ #
3748
+ # @!attribute [rw] node_count
3749
+ # The number of kdb cluster nodes.
3750
+ # @return [Integer]
3751
+ #
3752
+ # @!attribute [rw] cpu
3753
+ # The number of vCPUs that you want to reserve for each node of this
3754
+ # kdb cluster on the scaling group host.
3755
+ # @return [Float]
3756
+ #
3757
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxScalingGroupConfiguration AWS API Documentation
3758
+ #
3759
+ class KxScalingGroupConfiguration < Struct.new(
3760
+ :scaling_group_name,
3761
+ :memory_limit,
3762
+ :memory_reservation,
3763
+ :node_count,
3764
+ :cpu)
2370
3765
  SENSITIVE = []
2371
3766
  include Aws::Structure
2372
3767
  end
@@ -2411,6 +3806,86 @@ module Aws::Finspace
2411
3806
  include Aws::Structure
2412
3807
  end
2413
3808
 
3809
+ # The structure that contains the metadata of the volume.
3810
+ #
3811
+ # @!attribute [rw] volume_name
3812
+ # A unique identifier for the volume.
3813
+ # @return [String]
3814
+ #
3815
+ # @!attribute [rw] volume_type
3816
+ # The type of file system volume. Currently, FinSpace only supports
3817
+ # `NAS_1` volume type.
3818
+ # @return [String]
3819
+ #
3820
+ # @!attribute [rw] status
3821
+ # The status of volume.
3822
+ #
3823
+ # * CREATING – The volume creation is in progress.
3824
+ #
3825
+ # * CREATE\_FAILED – The volume creation has failed.
3826
+ #
3827
+ # * ACTIVE – The volume is active.
3828
+ #
3829
+ # * UPDATING – The volume is in the process of being updated.
3830
+ #
3831
+ # * UPDATE\_FAILED – The update action failed.
3832
+ #
3833
+ # * UPDATED – The volume is successfully updated.
3834
+ #
3835
+ # * DELETING – The volume is in the process of being deleted.
3836
+ #
3837
+ # * DELETE\_FAILED – The system failed to delete the volume.
3838
+ #
3839
+ # * DELETED – The volume is successfully deleted.
3840
+ # @return [String]
3841
+ #
3842
+ # @!attribute [rw] description
3843
+ # A description of the volume.
3844
+ # @return [String]
3845
+ #
3846
+ # @!attribute [rw] status_reason
3847
+ # The error message when a failed state occurs.
3848
+ # @return [String]
3849
+ #
3850
+ # @!attribute [rw] az_mode
3851
+ # The number of availability zones assigned to the volume. Currently,
3852
+ # only `SINGLE` is supported.
3853
+ # @return [String]
3854
+ #
3855
+ # @!attribute [rw] availability_zone_ids
3856
+ # The identifier of the availability zones.
3857
+ # @return [Array<String>]
3858
+ #
3859
+ # @!attribute [rw] created_timestamp
3860
+ # The timestamp at which the volume was created in FinSpace. The value
3861
+ # is determined as epoch time in milliseconds. For example, the value
3862
+ # for Monday, November 1, 2021 12:00:00 PM UTC is specified as
3863
+ # 1635768000000.
3864
+ # @return [Time]
3865
+ #
3866
+ # @!attribute [rw] last_modified_timestamp
3867
+ # The last time that the volume was updated in FinSpace. The value is
3868
+ # determined as epoch time in milliseconds. For example, the value for
3869
+ # Monday, November 1, 2021 12:00:00 PM UTC is specified as
3870
+ # 1635768000000.
3871
+ # @return [Time]
3872
+ #
3873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/KxVolume AWS API Documentation
3874
+ #
3875
+ class KxVolume < Struct.new(
3876
+ :volume_name,
3877
+ :volume_type,
3878
+ :status,
3879
+ :description,
3880
+ :status_reason,
3881
+ :az_mode,
3882
+ :availability_zone_ids,
3883
+ :created_timestamp,
3884
+ :last_modified_timestamp)
3885
+ SENSITIVE = []
3886
+ include Aws::Structure
3887
+ end
3888
+
2414
3889
  # A service limit or quota is exceeded.
2415
3890
  #
2416
3891
  # @!attribute [rw] message
@@ -2574,6 +4049,20 @@ module Aws::Finspace
2574
4049
  # processes in kdb systems. It allows you to create your own routing
2575
4050
  # logic using the initialization scripts and custom code. This type
2576
4051
  # of cluster does not require a writable local storage.
4052
+ #
4053
+ # * GP – A general purpose cluster allows you to quickly iterate on
4054
+ # code during development by granting greater access to system
4055
+ # commands and enabling a fast reload of custom code. This cluster
4056
+ # type can optionally mount databases including cache and savedown
4057
+ # storage. For this cluster type, the node count is fixed at 1. It
4058
+ # does not support autoscaling and supports only `SINGLE` AZ mode.
4059
+ #
4060
+ # * Tickerplant – A tickerplant cluster allows you to subscribe to
4061
+ # feed handlers based on IAM permissions. It can publish to RDBs,
4062
+ # other Tickerplants, and real-time subscribers (RTS). Tickerplants
4063
+ # can persist messages to log, which is readable by any RDB
4064
+ # environment. It supports only single-node that is only one kdb
4065
+ # process.
2577
4066
  # @return [String]
2578
4067
  #
2579
4068
  # @!attribute [rw] max_results
@@ -2634,23 +4123,147 @@ module Aws::Finspace
2634
4123
  include Aws::Structure
2635
4124
  end
2636
4125
 
2637
- # @!attribute [rw] kx_databases
2638
- # A list of databases in the kdb environment.
2639
- # @return [Array<Types::KxDatabaseListEntry>]
4126
+ # @!attribute [rw] kx_databases
4127
+ # A list of databases in the kdb environment.
4128
+ # @return [Array<Types::KxDatabaseListEntry>]
4129
+ #
4130
+ # @!attribute [rw] next_token
4131
+ # A token that indicates where a results page should begin.
4132
+ # @return [String]
4133
+ #
4134
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxDatabasesResponse AWS API Documentation
4135
+ #
4136
+ class ListKxDatabasesResponse < Struct.new(
4137
+ :kx_databases,
4138
+ :next_token)
4139
+ SENSITIVE = []
4140
+ include Aws::Structure
4141
+ end
4142
+
4143
+ # @!attribute [rw] environment_id
4144
+ # A unique identifier for the kdb environment, for which you want to
4145
+ # retrieve a list of dataviews.
4146
+ # @return [String]
4147
+ #
4148
+ # @!attribute [rw] database_name
4149
+ # The name of the database where the dataviews were created.
4150
+ # @return [String]
4151
+ #
4152
+ # @!attribute [rw] next_token
4153
+ # A token that indicates where a results page should begin.
4154
+ # @return [String]
4155
+ #
4156
+ # @!attribute [rw] max_results
4157
+ # The maximum number of results to return in this request.
4158
+ # @return [Integer]
4159
+ #
4160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxDataviewsRequest AWS API Documentation
4161
+ #
4162
+ class ListKxDataviewsRequest < Struct.new(
4163
+ :environment_id,
4164
+ :database_name,
4165
+ :next_token,
4166
+ :max_results)
4167
+ SENSITIVE = []
4168
+ include Aws::Structure
4169
+ end
4170
+
4171
+ # @!attribute [rw] kx_dataviews
4172
+ # The list of kdb dataviews that are currently active for the given
4173
+ # database.
4174
+ # @return [Array<Types::KxDataviewListEntry>]
4175
+ #
4176
+ # @!attribute [rw] next_token
4177
+ # A token that indicates where a results page should begin.
4178
+ # @return [String]
4179
+ #
4180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxDataviewsResponse AWS API Documentation
4181
+ #
4182
+ class ListKxDataviewsResponse < Struct.new(
4183
+ :kx_dataviews,
4184
+ :next_token)
4185
+ SENSITIVE = []
4186
+ include Aws::Structure
4187
+ end
4188
+
4189
+ # @!attribute [rw] next_token
4190
+ # A token that indicates where a results page should begin.
4191
+ # @return [String]
4192
+ #
4193
+ # @!attribute [rw] max_results
4194
+ # The maximum number of results to return in this request.
4195
+ # @return [Integer]
4196
+ #
4197
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxEnvironmentsRequest AWS API Documentation
4198
+ #
4199
+ class ListKxEnvironmentsRequest < Struct.new(
4200
+ :next_token,
4201
+ :max_results)
4202
+ SENSITIVE = []
4203
+ include Aws::Structure
4204
+ end
4205
+
4206
+ # @!attribute [rw] environments
4207
+ # A list of environments in an account.
4208
+ # @return [Array<Types::KxEnvironment>]
4209
+ #
4210
+ # @!attribute [rw] next_token
4211
+ # A token that indicates where a results page should begin.
4212
+ # @return [String]
4213
+ #
4214
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxEnvironmentsResponse AWS API Documentation
4215
+ #
4216
+ class ListKxEnvironmentsResponse < Struct.new(
4217
+ :environments,
4218
+ :next_token)
4219
+ SENSITIVE = []
4220
+ include Aws::Structure
4221
+ end
4222
+
4223
+ # @!attribute [rw] environment_id
4224
+ # A unique identifier for the kdb environment, for which you want to
4225
+ # retrieve a list of scaling groups.
4226
+ # @return [String]
4227
+ #
4228
+ # @!attribute [rw] max_results
4229
+ # The maximum number of results to return in this request.
4230
+ # @return [Integer]
4231
+ #
4232
+ # @!attribute [rw] next_token
4233
+ # A token that indicates where a results page should begin.
4234
+ # @return [String]
4235
+ #
4236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxScalingGroupsRequest AWS API Documentation
4237
+ #
4238
+ class ListKxScalingGroupsRequest < Struct.new(
4239
+ :environment_id,
4240
+ :max_results,
4241
+ :next_token)
4242
+ SENSITIVE = []
4243
+ include Aws::Structure
4244
+ end
4245
+
4246
+ # @!attribute [rw] scaling_groups
4247
+ # A list of scaling groups available in a kdb environment.
4248
+ # @return [Array<Types::KxScalingGroup>]
2640
4249
  #
2641
4250
  # @!attribute [rw] next_token
2642
4251
  # A token that indicates where a results page should begin.
2643
4252
  # @return [String]
2644
4253
  #
2645
- # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxDatabasesResponse AWS API Documentation
4254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxScalingGroupsResponse AWS API Documentation
2646
4255
  #
2647
- class ListKxDatabasesResponse < Struct.new(
2648
- :kx_databases,
4256
+ class ListKxScalingGroupsResponse < Struct.new(
4257
+ :scaling_groups,
2649
4258
  :next_token)
2650
4259
  SENSITIVE = []
2651
4260
  include Aws::Structure
2652
4261
  end
2653
4262
 
4263
+ # @!attribute [rw] environment_id
4264
+ # A unique identifier for the kdb environment.
4265
+ # @return [String]
4266
+ #
2654
4267
  # @!attribute [rw] next_token
2655
4268
  # A token that indicates where a results page should begin.
2656
4269
  # @return [String]
@@ -2659,66 +4272,74 @@ module Aws::Finspace
2659
4272
  # The maximum number of results to return in this request.
2660
4273
  # @return [Integer]
2661
4274
  #
2662
- # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxEnvironmentsRequest AWS API Documentation
4275
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxUsersRequest AWS API Documentation
2663
4276
  #
2664
- class ListKxEnvironmentsRequest < Struct.new(
4277
+ class ListKxUsersRequest < Struct.new(
4278
+ :environment_id,
2665
4279
  :next_token,
2666
4280
  :max_results)
2667
4281
  SENSITIVE = []
2668
4282
  include Aws::Structure
2669
4283
  end
2670
4284
 
2671
- # @!attribute [rw] environments
2672
- # A list of environments in an account.
2673
- # @return [Array<Types::KxEnvironment>]
4285
+ # @!attribute [rw] users
4286
+ # A list of users in a kdb environment.
4287
+ # @return [Array<Types::KxUser>]
2674
4288
  #
2675
4289
  # @!attribute [rw] next_token
2676
4290
  # A token that indicates where a results page should begin.
2677
4291
  # @return [String]
2678
4292
  #
2679
- # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxEnvironmentsResponse AWS API Documentation
4293
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxUsersResponse AWS API Documentation
2680
4294
  #
2681
- class ListKxEnvironmentsResponse < Struct.new(
2682
- :environments,
4295
+ class ListKxUsersResponse < Struct.new(
4296
+ :users,
2683
4297
  :next_token)
2684
4298
  SENSITIVE = []
2685
4299
  include Aws::Structure
2686
4300
  end
2687
4301
 
2688
4302
  # @!attribute [rw] environment_id
2689
- # A unique identifier for the kdb environment.
4303
+ # A unique identifier for the kdb environment, whose clusters can
4304
+ # attach to the volume.
2690
4305
  # @return [String]
2691
4306
  #
4307
+ # @!attribute [rw] max_results
4308
+ # The maximum number of results to return in this request.
4309
+ # @return [Integer]
4310
+ #
2692
4311
  # @!attribute [rw] next_token
2693
4312
  # A token that indicates where a results page should begin.
2694
4313
  # @return [String]
2695
4314
  #
2696
- # @!attribute [rw] max_results
2697
- # The maximum number of results to return in this request.
2698
- # @return [Integer]
4315
+ # @!attribute [rw] volume_type
4316
+ # The type of file system volume. Currently, FinSpace only supports
4317
+ # `NAS_1` volume type.
4318
+ # @return [String]
2699
4319
  #
2700
- # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxUsersRequest AWS API Documentation
4320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxVolumesRequest AWS API Documentation
2701
4321
  #
2702
- class ListKxUsersRequest < Struct.new(
4322
+ class ListKxVolumesRequest < Struct.new(
2703
4323
  :environment_id,
4324
+ :max_results,
2704
4325
  :next_token,
2705
- :max_results)
4326
+ :volume_type)
2706
4327
  SENSITIVE = []
2707
4328
  include Aws::Structure
2708
4329
  end
2709
4330
 
2710
- # @!attribute [rw] users
2711
- # A list of users in a kdb environment.
2712
- # @return [Array<Types::KxUser>]
4331
+ # @!attribute [rw] kx_volume_summaries
4332
+ # A summary of volumes.
4333
+ # @return [Array<Types::KxVolume>]
2713
4334
  #
2714
4335
  # @!attribute [rw] next_token
2715
4336
  # A token that indicates where a results page should begin.
2716
4337
  # @return [String]
2717
4338
  #
2718
- # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxUsersResponse AWS API Documentation
4339
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/ListKxVolumesResponse AWS API Documentation
2719
4340
  #
2720
- class ListKxUsersResponse < Struct.new(
2721
- :users,
4341
+ class ListKxVolumesResponse < Struct.new(
4342
+ :kx_volume_summaries,
2722
4343
  :next_token)
2723
4344
  SENSITIVE = []
2724
4345
  include Aws::Structure
@@ -2915,6 +4536,23 @@ module Aws::Finspace
2915
4536
  include Aws::Structure
2916
4537
  end
2917
4538
 
4539
+ # A configuration to store the Tickerplant logs. It consists of a list
4540
+ # of volumes that will be mounted to your cluster. For the cluster type
4541
+ # `Tickerplant`, the location of the TP volume on the cluster will be
4542
+ # available by using the global variable `.aws.tp_log_path`.
4543
+ #
4544
+ # @!attribute [rw] tickerplant_log_volumes
4545
+ # The name of the volumes for tickerplant logs.
4546
+ # @return [Array<String>]
4547
+ #
4548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/TickerplantLogConfiguration AWS API Documentation
4549
+ #
4550
+ class TickerplantLogConfiguration < Struct.new(
4551
+ :tickerplant_log_volumes)
4552
+ SENSITIVE = []
4553
+ include Aws::Structure
4554
+ end
4555
+
2918
4556
  # The structure of the transit gateway and network configuration that is
2919
4557
  # used to connect the kdb environment to an internal network.
2920
4558
  #
@@ -3042,11 +4680,15 @@ module Aws::Finspace
3042
4680
  # a relative path within *.zip* file that contains the custom code,
3043
4681
  # which will be loaded on the cluster. It must include the file name
3044
4682
  # itself. For example, `somedir/init.q`.
4683
+ #
4684
+ # You cannot update this parameter for a `NO_RESTART` deployment.
3045
4685
  # @return [String]
3046
4686
  #
3047
4687
  # @!attribute [rw] command_line_arguments
3048
4688
  # Specifies the key-value pairs to make them available inside the
3049
4689
  # cluster.
4690
+ #
4691
+ # You cannot update this parameter for a `NO_RESTART` deployment.
3050
4692
  # @return [Array<Types::KxCommandLineArgument>]
3051
4693
  #
3052
4694
  # @!attribute [rw] deployment_configuration
@@ -3172,6 +4814,153 @@ module Aws::Finspace
3172
4814
  include Aws::Structure
3173
4815
  end
3174
4816
 
4817
+ # @!attribute [rw] environment_id
4818
+ # A unique identifier for the kdb environment, where you want to
4819
+ # update the dataview.
4820
+ # @return [String]
4821
+ #
4822
+ # @!attribute [rw] database_name
4823
+ # The name of the database.
4824
+ # @return [String]
4825
+ #
4826
+ # @!attribute [rw] dataview_name
4827
+ # The name of the dataview that you want to update.
4828
+ # @return [String]
4829
+ #
4830
+ # @!attribute [rw] description
4831
+ # The description for a dataview.
4832
+ # @return [String]
4833
+ #
4834
+ # @!attribute [rw] changeset_id
4835
+ # A unique identifier for the changeset.
4836
+ # @return [String]
4837
+ #
4838
+ # @!attribute [rw] segment_configurations
4839
+ # The configuration that contains the database path of the data that
4840
+ # you want to place on each selected volume. Each segment must have a
4841
+ # unique database path for each volume. If you do not explicitly
4842
+ # specify any database path for a volume, they are accessible from the
4843
+ # cluster through the default S3/object store segment.
4844
+ # @return [Array<Types::KxDataviewSegmentConfiguration>]
4845
+ #
4846
+ # @!attribute [rw] client_token
4847
+ # A token that ensures idempotency. This token expires in 10 minutes.
4848
+ #
4849
+ # **A suitable default value is auto-generated.** You should normally
4850
+ # not need to pass this option.
4851
+ # @return [String]
4852
+ #
4853
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxDataviewRequest AWS API Documentation
4854
+ #
4855
+ class UpdateKxDataviewRequest < Struct.new(
4856
+ :environment_id,
4857
+ :database_name,
4858
+ :dataview_name,
4859
+ :description,
4860
+ :changeset_id,
4861
+ :segment_configurations,
4862
+ :client_token)
4863
+ SENSITIVE = []
4864
+ include Aws::Structure
4865
+ end
4866
+
4867
+ # @!attribute [rw] environment_id
4868
+ # A unique identifier for the kdb environment, where you want to
4869
+ # update the dataview.
4870
+ # @return [String]
4871
+ #
4872
+ # @!attribute [rw] database_name
4873
+ # The name of the database.
4874
+ # @return [String]
4875
+ #
4876
+ # @!attribute [rw] dataview_name
4877
+ # The name of the database under which the dataview was created.
4878
+ # @return [String]
4879
+ #
4880
+ # @!attribute [rw] az_mode
4881
+ # The number of availability zones you want to assign per cluster.
4882
+ # This can be one of the following
4883
+ #
4884
+ # * `SINGLE` – Assigns one availability zone per cluster.
4885
+ #
4886
+ # * `MULTI` – Assigns all the availability zones per cluster.
4887
+ # @return [String]
4888
+ #
4889
+ # @!attribute [rw] availability_zone_id
4890
+ # The identifier of the availability zones.
4891
+ # @return [String]
4892
+ #
4893
+ # @!attribute [rw] changeset_id
4894
+ # A unique identifier for the changeset.
4895
+ # @return [String]
4896
+ #
4897
+ # @!attribute [rw] segment_configurations
4898
+ # The configuration that contains the database path of the data that
4899
+ # you want to place on each selected volume. Each segment must have a
4900
+ # unique database path for each volume. If you do not explicitly
4901
+ # specify any database path for a volume, they are accessible from the
4902
+ # cluster through the default S3/object store segment.
4903
+ # @return [Array<Types::KxDataviewSegmentConfiguration>]
4904
+ #
4905
+ # @!attribute [rw] active_versions
4906
+ # The current active changeset versions of the database on the given
4907
+ # dataview.
4908
+ # @return [Array<Types::KxDataviewActiveVersion>]
4909
+ #
4910
+ # @!attribute [rw] status
4911
+ # The status of dataview creation.
4912
+ #
4913
+ # * `CREATING` – The dataview creation is in progress.
4914
+ #
4915
+ # * `UPDATING` – The dataview is in the process of being updated.
4916
+ #
4917
+ # * `ACTIVE` – The dataview is active.
4918
+ # @return [String]
4919
+ #
4920
+ # @!attribute [rw] auto_update
4921
+ # The option to specify whether you want to apply all the future
4922
+ # additions and corrections automatically to the dataview when new
4923
+ # changesets are ingested. The default value is false.
4924
+ # @return [Boolean]
4925
+ #
4926
+ # @!attribute [rw] description
4927
+ # A description of the dataview.
4928
+ # @return [String]
4929
+ #
4930
+ # @!attribute [rw] created_timestamp
4931
+ # The timestamp at which the dataview was created in FinSpace. The
4932
+ # value is determined as epoch time in milliseconds. For example, the
4933
+ # value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
4934
+ # 1635768000000.
4935
+ # @return [Time]
4936
+ #
4937
+ # @!attribute [rw] last_modified_timestamp
4938
+ # The last time that the dataview was updated in FinSpace. The value
4939
+ # is determined as epoch time in milliseconds. For example, the value
4940
+ # for Monday, November 1, 2021 12:00:00 PM UTC is specified as
4941
+ # 1635768000000.
4942
+ # @return [Time]
4943
+ #
4944
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxDataviewResponse AWS API Documentation
4945
+ #
4946
+ class UpdateKxDataviewResponse < Struct.new(
4947
+ :environment_id,
4948
+ :database_name,
4949
+ :dataview_name,
4950
+ :az_mode,
4951
+ :availability_zone_id,
4952
+ :changeset_id,
4953
+ :segment_configurations,
4954
+ :active_versions,
4955
+ :status,
4956
+ :auto_update,
4957
+ :description,
4958
+ :created_timestamp,
4959
+ :last_modified_timestamp)
4960
+ SENSITIVE = []
4961
+ include Aws::Structure
4962
+ end
4963
+
3175
4964
  # @!attribute [rw] environment_id
3176
4965
  # A unique identifier for the kdb environment.
3177
4966
  # @return [String]
@@ -3188,6 +4977,9 @@ module Aws::Finspace
3188
4977
  #
3189
4978
  # @!attribute [rw] client_token
3190
4979
  # A token that ensures idempotency. This token expires in 10 minutes.
4980
+ #
4981
+ # **A suitable default value is auto-generated.** You should normally
4982
+ # not need to pass this option.
3191
4983
  # @return [String]
3192
4984
  #
3193
4985
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxEnvironmentNetworkRequest AWS API Documentation
@@ -3306,6 +5098,9 @@ module Aws::Finspace
3306
5098
  #
3307
5099
  # @!attribute [rw] client_token
3308
5100
  # A token that ensures idempotency. This token expires in 10 minutes.
5101
+ #
5102
+ # **A suitable default value is auto-generated.** You should normally
5103
+ # not need to pass this option.
3309
5104
  # @return [String]
3310
5105
  #
3311
5106
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxEnvironmentRequest AWS API Documentation
@@ -3424,6 +5219,9 @@ module Aws::Finspace
3424
5219
  #
3425
5220
  # @!attribute [rw] client_token
3426
5221
  # A token that ensures idempotency. This token expires in 10 minutes.
5222
+ #
5223
+ # **A suitable default value is auto-generated.** You should normally
5224
+ # not need to pass this option.
3427
5225
  # @return [String]
3428
5226
  #
3429
5227
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxUserRequest AWS API Documentation
@@ -3470,6 +5268,143 @@ module Aws::Finspace
3470
5268
  include Aws::Structure
3471
5269
  end
3472
5270
 
5271
+ # @!attribute [rw] environment_id
5272
+ # A unique identifier for the kdb environment where you created the
5273
+ # storage volume.
5274
+ # @return [String]
5275
+ #
5276
+ # @!attribute [rw] volume_name
5277
+ # A unique identifier for the volume.
5278
+ # @return [String]
5279
+ #
5280
+ # @!attribute [rw] description
5281
+ # A description of the volume.
5282
+ # @return [String]
5283
+ #
5284
+ # @!attribute [rw] client_token
5285
+ # A token that ensures idempotency. This token expires in 10 minutes.
5286
+ #
5287
+ # **A suitable default value is auto-generated.** You should normally
5288
+ # not need to pass this option.
5289
+ # @return [String]
5290
+ #
5291
+ # @!attribute [rw] nas1_configuration
5292
+ # Specifies the configuration for the Network attached storage
5293
+ # (NAS\_1) file system volume.
5294
+ # @return [Types::KxNAS1Configuration]
5295
+ #
5296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxVolumeRequest AWS API Documentation
5297
+ #
5298
+ class UpdateKxVolumeRequest < Struct.new(
5299
+ :environment_id,
5300
+ :volume_name,
5301
+ :description,
5302
+ :client_token,
5303
+ :nas1_configuration)
5304
+ SENSITIVE = []
5305
+ include Aws::Structure
5306
+ end
5307
+
5308
+ # @!attribute [rw] environment_id
5309
+ # A unique identifier for the kdb environment where you want to update
5310
+ # the volume.
5311
+ # @return [String]
5312
+ #
5313
+ # @!attribute [rw] volume_name
5314
+ # A unique identifier for the volume that you want to update.
5315
+ # @return [String]
5316
+ #
5317
+ # @!attribute [rw] volume_type
5318
+ # The type of file system volume. Currently, FinSpace only supports
5319
+ # `NAS_1` volume type.
5320
+ # @return [String]
5321
+ #
5322
+ # @!attribute [rw] volume_arn
5323
+ # The ARN identifier of the volume.
5324
+ # @return [String]
5325
+ #
5326
+ # @!attribute [rw] nas1_configuration
5327
+ # Specifies the configuration for the Network attached storage
5328
+ # (NAS\_1) file system volume.
5329
+ # @return [Types::KxNAS1Configuration]
5330
+ #
5331
+ # @!attribute [rw] status
5332
+ # The status of the volume.
5333
+ #
5334
+ # * CREATING – The volume creation is in progress.
5335
+ #
5336
+ # * CREATE\_FAILED – The volume creation has failed.
5337
+ #
5338
+ # * ACTIVE – The volume is active.
5339
+ #
5340
+ # * UPDATING – The volume is in the process of being updated.
5341
+ #
5342
+ # * UPDATE\_FAILED – The update action failed.
5343
+ #
5344
+ # * UPDATED – The volume is successfully updated.
5345
+ #
5346
+ # * DELETING – The volume is in the process of being deleted.
5347
+ #
5348
+ # * DELETE\_FAILED – The system failed to delete the volume.
5349
+ #
5350
+ # * DELETED – The volume is successfully deleted.
5351
+ # @return [String]
5352
+ #
5353
+ # @!attribute [rw] description
5354
+ # The description for the volume.
5355
+ # @return [String]
5356
+ #
5357
+ # @!attribute [rw] status_reason
5358
+ # The error message when a failed state occurs.
5359
+ # @return [String]
5360
+ #
5361
+ # @!attribute [rw] created_timestamp
5362
+ # The timestamp at which the volume was created in FinSpace. The value
5363
+ # is determined as epoch time in milliseconds. For example, the value
5364
+ # for Monday, November 1, 2021 12:00:00 PM UTC is specified as
5365
+ # 1635768000000.
5366
+ # @return [Time]
5367
+ #
5368
+ # @!attribute [rw] az_mode
5369
+ # The number of availability zones you want to assign per cluster.
5370
+ # Currently, FinSpace only support `SINGLE` for volumes.
5371
+ # @return [String]
5372
+ #
5373
+ # @!attribute [rw] availability_zone_ids
5374
+ # The identifier of the availability zones.
5375
+ # @return [Array<String>]
5376
+ #
5377
+ # @!attribute [rw] last_modified_timestamp
5378
+ # The last time that the volume was updated in FinSpace. The value is
5379
+ # determined as epoch time in milliseconds. For example, the value for
5380
+ # Monday, November 1, 2021 12:00:00 PM UTC is specified as
5381
+ # 1635768000000.
5382
+ # @return [Time]
5383
+ #
5384
+ # @!attribute [rw] attached_clusters
5385
+ # Specifies the clusters that a volume is attached to.
5386
+ # @return [Array<Types::KxAttachedCluster>]
5387
+ #
5388
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/UpdateKxVolumeResponse AWS API Documentation
5389
+ #
5390
+ class UpdateKxVolumeResponse < Struct.new(
5391
+ :environment_id,
5392
+ :volume_name,
5393
+ :volume_type,
5394
+ :volume_arn,
5395
+ :nas1_configuration,
5396
+ :status,
5397
+ :description,
5398
+ :status_reason,
5399
+ :created_timestamp,
5400
+ :az_mode,
5401
+ :availability_zone_ids,
5402
+ :last_modified_timestamp,
5403
+ :attached_clusters)
5404
+ SENSITIVE = []
5405
+ include Aws::Structure
5406
+ end
5407
+
3473
5408
  # The input fails to satisfy the constraints specified by an AWS
3474
5409
  # service.
3475
5410
  #
@@ -3484,6 +5419,26 @@ module Aws::Finspace
3484
5419
  include Aws::Structure
3485
5420
  end
3486
5421
 
5422
+ # The structure that consists of name and type of volume.
5423
+ #
5424
+ # @!attribute [rw] volume_name
5425
+ # A unique identifier for the volume.
5426
+ # @return [String]
5427
+ #
5428
+ # @!attribute [rw] volume_type
5429
+ # The type of file system volume. Currently, FinSpace only supports
5430
+ # `NAS_1` volume type.
5431
+ # @return [String]
5432
+ #
5433
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/Volume AWS API Documentation
5434
+ #
5435
+ class Volume < Struct.new(
5436
+ :volume_name,
5437
+ :volume_type)
5438
+ SENSITIVE = []
5439
+ include Aws::Structure
5440
+ end
5441
+
3487
5442
  # Configuration details about the network where the Privatelink endpoint
3488
5443
  # of the cluster resides.
3489
5444
  #