@aws-sdk/client-finspace 3.465.0 → 3.468.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -141,6 +141,7 @@ exports.KxAzMode = {
141
141
  };
142
142
  exports.KxClusterType = {
143
143
  GATEWAY: "GATEWAY",
144
+ GP: "GP",
144
145
  HDB: "HDB",
145
146
  RDB: "RDB",
146
147
  };
@@ -221,6 +222,7 @@ class InvalidRequestException extends FinspaceServiceException_1.FinspaceService
221
222
  exports.InvalidRequestException = InvalidRequestException;
222
223
  exports.KxClusterCodeDeploymentStrategy = {
223
224
  FORCE: "FORCE",
225
+ NO_RESTART: "NO_RESTART",
224
226
  ROLLING: "ROLLING",
225
227
  };
226
228
  exports.KxDeploymentStrategy = {
@@ -130,6 +130,7 @@ export const KxAzMode = {
130
130
  };
131
131
  export const KxClusterType = {
132
132
  GATEWAY: "GATEWAY",
133
+ GP: "GP",
133
134
  HDB: "HDB",
134
135
  RDB: "RDB",
135
136
  };
@@ -208,6 +209,7 @@ export class InvalidRequestException extends __BaseException {
208
209
  }
209
210
  export const KxClusterCodeDeploymentStrategy = {
210
211
  FORCE: "FORCE",
212
+ NO_RESTART: "NO_RESTART",
211
213
  ROLLING: "ROLLING",
212
214
  };
213
215
  export const KxDeploymentStrategy = {
@@ -34,7 +34,7 @@ export interface CreateKxClusterCommandOutput extends CreateKxClusterResponse, _
34
34
  * clientToken: "STRING_VALUE",
35
35
  * environmentId: "STRING_VALUE", // required
36
36
  * clusterName: "STRING_VALUE", // required
37
- * clusterType: "HDB" || "RDB" || "GATEWAY", // required
37
+ * clusterType: "HDB" || "RDB" || "GATEWAY" || "GP", // required
38
38
  * databases: [ // KxDatabaseConfigurations
39
39
  * { // KxDatabaseConfiguration
40
40
  * databaseName: "STRING_VALUE", // required
@@ -109,7 +109,7 @@ export interface CreateKxClusterCommandOutput extends CreateKxClusterResponse, _
109
109
  * // status: "PENDING" || "CREATING" || "CREATE_FAILED" || "RUNNING" || "UPDATING" || "DELETING" || "DELETED" || "DELETE_FAILED",
110
110
  * // statusReason: "STRING_VALUE",
111
111
  * // clusterName: "STRING_VALUE",
112
- * // clusterType: "HDB" || "RDB" || "GATEWAY",
112
+ * // clusterType: "HDB" || "RDB" || "GATEWAY" || "GP",
113
113
  * // databases: [ // KxDatabaseConfigurations
114
114
  * // { // KxDatabaseConfiguration
115
115
  * // databaseName: "STRING_VALUE", // required
@@ -40,7 +40,7 @@ export interface GetKxClusterCommandOutput extends GetKxClusterResponse, __Metad
40
40
  * // status: "PENDING" || "CREATING" || "CREATE_FAILED" || "RUNNING" || "UPDATING" || "DELETING" || "DELETED" || "DELETE_FAILED",
41
41
  * // statusReason: "STRING_VALUE",
42
42
  * // clusterName: "STRING_VALUE",
43
- * // clusterType: "HDB" || "RDB" || "GATEWAY",
43
+ * // clusterType: "HDB" || "RDB" || "GATEWAY" || "GP",
44
44
  * // databases: [ // KxDatabaseConfigurations
45
45
  * // { // KxDatabaseConfiguration
46
46
  * // databaseName: "STRING_VALUE", // required
@@ -32,7 +32,7 @@ export interface ListKxClustersCommandOutput extends ListKxClustersResponse, __M
32
32
  * const client = new FinspaceClient(config);
33
33
  * const input = { // ListKxClustersRequest
34
34
  * environmentId: "STRING_VALUE", // required
35
- * clusterType: "HDB" || "RDB" || "GATEWAY",
35
+ * clusterType: "HDB" || "RDB" || "GATEWAY" || "GP",
36
36
  * maxResults: Number("int"),
37
37
  * nextToken: "STRING_VALUE",
38
38
  * };
@@ -44,7 +44,7 @@ export interface ListKxClustersCommandOutput extends ListKxClustersResponse, __M
44
44
  * // status: "PENDING" || "CREATING" || "CREATE_FAILED" || "RUNNING" || "UPDATING" || "DELETING" || "DELETED" || "DELETE_FAILED",
45
45
  * // statusReason: "STRING_VALUE",
46
46
  * // clusterName: "STRING_VALUE",
47
- * // clusterType: "HDB" || "RDB" || "GATEWAY",
47
+ * // clusterType: "HDB" || "RDB" || "GATEWAY" || "GP",
48
48
  * // clusterDescription: "STRING_VALUE",
49
49
  * // releaseLabel: "STRING_VALUE",
50
50
  * // initializationScript: "STRING_VALUE",
@@ -50,7 +50,7 @@ export interface UpdateKxClusterCodeConfigurationCommandOutput extends UpdateKxC
50
50
  * },
51
51
  * ],
52
52
  * deploymentConfiguration: { // KxClusterCodeDeploymentConfiguration
53
- * deploymentStrategy: "ROLLING" || "FORCE", // required
53
+ * deploymentStrategy: "NO_RESTART" || "ROLLING" || "FORCE", // required
54
54
  * },
55
55
  * };
56
56
  * const command = new UpdateKxClusterCodeConfigurationCommand(input);
@@ -353,7 +353,7 @@ export interface CreateKxChangesetRequest {
353
353
  databaseName: string | undefined;
354
354
  /**
355
355
  * @public
356
- * <p>A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath.
356
+ * <p>A list of change request objects that are run in order. A change request object consists of <code>changeType</code> , <code>s3Path</code>, and <code>dbPath</code>.
357
357
  * A changeType can has the following values: </p>
358
358
  * <ul>
359
359
  * <li>
@@ -363,24 +363,53 @@ export interface CreateKxChangesetRequest {
363
363
  * <p>DELETE – Deletes files in a database.</p>
364
364
  * </li>
365
365
  * </ul>
366
- * <p>All the change requests require a mandatory <i>dbPath</i> attribute that
367
- * defines the path within the database directory. The <i>s3Path</i> attribute
368
- * defines the s3 source file path and is required for a PUT change type.</p>
369
- * <p>Here is an example
370
- * of how you can use the change request object:</p>
371
- * <p>
372
- * <code>[
373
- * \{ "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"\},
374
- * \{ "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"\},
375
- * \{ "changeType": "DELETE", "dbPath": "/2020.01.01/"\}
376
- * ]</code>
377
- * </p>
378
- * <p>In this example, the first request with <i>PUT</i> change type allows you to
379
- * add files in the given s3Path under the <i>2020.01.02</i> partition of the
380
- * database. The second request with <i>PUT</i> change type allows you to add a
381
- * single sym file at database root location. The last request with
382
- * <i>DELETE</i> change type allows you to delete the files under the
383
- * <i>2020.01.01</i> partition of the database. </p>
366
+ * <p>All the change requests require a mandatory <code>dbPath</code> attribute that defines the
367
+ * path within the database directory. All database paths must start with a leading / and end
368
+ * with a trailing /. The <code>s3Path</code> attribute defines the s3 source file path and is
369
+ * required for a PUT change type. The <code>s3path</code> must end with a trailing / if it is
370
+ * a directory and must end without a trailing / if it is a file. </p>
371
+ * <p>Here are few examples of how you can use the change request object:</p>
372
+ * <ol>
373
+ * <li>
374
+ * <p>This request adds a single sym file at database root location. </p>
375
+ * <p>
376
+ * <code>\{ "changeType": "PUT", "s3Path":"s3://bucket/db/sym",
377
+ * "dbPath":"/"\}</code>
378
+ * </p>
379
+ * </li>
380
+ * <li>
381
+ * <p>This request adds files in the given <code>s3Path</code> under the 2020.01.02
382
+ * partition of the database.</p>
383
+ * <p>
384
+ * <code>\{ "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/",
385
+ * "dbPath":"/2020.01.02/"\}</code>
386
+ * </p>
387
+ * </li>
388
+ * <li>
389
+ * <p>This request adds files in the given <code>s3Path</code> under the
390
+ * <i>taq</i> table partition of the database.</p>
391
+ * <p>
392
+ * <code>[ \{ "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/",
393
+ * "dbPath":"/2020.01.02/taq/"\}]</code>
394
+ * </p>
395
+ * </li>
396
+ * <li>
397
+ * <p>This request deletes the 2020.01.02 partition of the database.</p>
398
+ * <p>
399
+ * <code>[\{ "changeType": "DELETE", "dbPath": "/2020.01.02/"\} ]</code>
400
+ * </p>
401
+ * </li>
402
+ * <li>
403
+ * <p>The <i>DELETE</i> request allows you to delete the existing files under the
404
+ * 2020.01.02 partition of the database, and the <i>PUT</i> request adds a
405
+ * new taq table under it.</p>
406
+ * <p>
407
+ * <code>[ \{"changeType": "DELETE", "dbPath":"/2020.01.02/"\}, \{"changeType": "PUT",
408
+ * "s3Path":"s3://bucket/db/2020.01.02/taq/",
409
+ * "dbPath":"/2020.01.02/taq/"\}]</code>
410
+ * </p>
411
+ * </li>
412
+ * </ol>
384
413
  */
385
414
  changeRequests: ChangeRequest[] | undefined;
386
415
  /**
@@ -601,6 +630,7 @@ export interface CapacityConfiguration {
601
630
  */
602
631
  export declare const KxClusterType: {
603
632
  readonly GATEWAY: "GATEWAY";
633
+ readonly GP: "GP";
604
634
  readonly HDB: "HDB";
605
635
  readonly RDB: "RDB";
606
636
  };
@@ -793,6 +823,9 @@ export interface CreateKxClusterRequest {
793
823
  * <li>
794
824
  * <p>GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.</p>
795
825
  * </li>
826
+ * <li>
827
+ * <p>GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only <code>SINGLE</code> AZ mode.</p>
828
+ * </li>
796
829
  * </ul>
797
830
  */
798
831
  clusterType: KxClusterType | undefined;
@@ -966,6 +999,9 @@ export interface CreateKxClusterResponse {
966
999
  * <li>
967
1000
  * <p>GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.</p>
968
1001
  * </li>
1002
+ * <li>
1003
+ * <p>GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only <code>SINGLE</code> AZ mode.</p>
1004
+ * </li>
969
1005
  * </ul>
970
1006
  */
971
1007
  clusterType?: KxClusterType;
@@ -1640,6 +1676,9 @@ export interface GetKxClusterResponse {
1640
1676
  * <li>
1641
1677
  * <p>GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.</p>
1642
1678
  * </li>
1679
+ * <li>
1680
+ * <p>GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only <code>SINGLE</code> AZ mode.</p>
1681
+ * </li>
1643
1682
  * </ul>
1644
1683
  */
1645
1684
  clusterType?: KxClusterType;
@@ -2366,6 +2405,9 @@ export interface ListKxClustersRequest {
2366
2405
  * <li>
2367
2406
  * <p>GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.</p>
2368
2407
  * </li>
2408
+ * <li>
2409
+ * <p>GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only <code>SINGLE</code> AZ mode.</p>
2410
+ * </li>
2369
2411
  * </ul>
2370
2412
  */
2371
2413
  clusterType?: KxClusterType;
@@ -2439,6 +2481,9 @@ export interface KxCluster {
2439
2481
  * <li>
2440
2482
  * <p>GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.</p>
2441
2483
  * </li>
2484
+ * <li>
2485
+ * <p>GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only <code>SINGLE</code> AZ mode.</p>
2486
+ * </li>
2442
2487
  * </ul>
2443
2488
  */
2444
2489
  clusterType?: KxClusterType;
@@ -2918,6 +2963,7 @@ export interface UpdateEnvironmentResponse {
2918
2963
  */
2919
2964
  export declare const KxClusterCodeDeploymentStrategy: {
2920
2965
  readonly FORCE: "FORCE";
2966
+ readonly NO_RESTART: "NO_RESTART";
2921
2967
  readonly ROLLING: "ROLLING";
2922
2968
  };
2923
2969
  /**
@@ -2942,6 +2988,10 @@ export interface KxClusterCodeDeploymentConfiguration {
2942
2988
  * <p>ROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.</p>
2943
2989
  * </li>
2944
2990
  * <li>
2991
+ * <p>NO_RESTART – This option updates the cluster without stopping the running q process. It is only available for <code>GP</code> type cluster. This option is quicker as it reduces the turn around time to update configuration on a cluster. </p>
2992
+ * <p>With this deployment mode, you cannot update the <code>initializationScript</code> and <code>commandLineArguments</code> parameters.</p>
2993
+ * </li>
2994
+ * <li>
2945
2995
  * <p>FORCE – This option updates the cluster by immediately stopping all the running processes before starting up new ones with the updated configuration. </p>
2946
2996
  * </li>
2947
2997
  * </ul>
@@ -2980,11 +3030,13 @@ export interface UpdateKxClusterCodeConfigurationRequest {
2980
3030
  * <i>.zip</i> file that contains the custom code, which will be loaded on
2981
3031
  * the cluster. It must include the file name itself. For example,
2982
3032
  * <code>somedir/init.q</code>.</p>
3033
+ * <p>You cannot update this parameter for a <code>NO_RESTART</code> deployment.</p>
2983
3034
  */
2984
3035
  initializationScript?: string;
2985
3036
  /**
2986
3037
  * @public
2987
3038
  * <p>Specifies the key-value pairs to make them available inside the cluster.</p>
3039
+ * <p>You cannot update this parameter for a <code>NO_RESTART</code> deployment.</p>
2988
3040
  */
2989
3041
  commandLineArguments?: KxCommandLineArgument[];
2990
3042
  /**
@@ -166,6 +166,7 @@ export interface CapacityConfiguration {
166
166
  }
167
167
  export declare const KxClusterType: {
168
168
  readonly GATEWAY: "GATEWAY";
169
+ readonly GP: "GP";
169
170
  readonly HDB: "HDB";
170
171
  readonly RDB: "RDB";
171
172
  };
@@ -676,6 +677,7 @@ export interface UpdateEnvironmentResponse {
676
677
  }
677
678
  export declare const KxClusterCodeDeploymentStrategy: {
678
679
  readonly FORCE: "FORCE";
680
+ readonly NO_RESTART: "NO_RESTART";
679
681
  readonly ROLLING: "ROLLING";
680
682
  };
681
683
  export type KxClusterCodeDeploymentStrategy =
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-finspace",
3
3
  "description": "AWS SDK for JavaScript Finspace Client for Node.js, Browser and React Native",
4
- "version": "3.465.0",
4
+ "version": "3.468.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,41 +20,41 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.465.0",
24
- "@aws-sdk/core": "3.465.0",
25
- "@aws-sdk/credential-provider-node": "3.465.0",
26
- "@aws-sdk/middleware-host-header": "3.465.0",
27
- "@aws-sdk/middleware-logger": "3.465.0",
28
- "@aws-sdk/middleware-recursion-detection": "3.465.0",
29
- "@aws-sdk/middleware-signing": "3.465.0",
30
- "@aws-sdk/middleware-user-agent": "3.465.0",
31
- "@aws-sdk/region-config-resolver": "3.465.0",
32
- "@aws-sdk/types": "3.465.0",
33
- "@aws-sdk/util-endpoints": "3.465.0",
34
- "@aws-sdk/util-user-agent-browser": "3.465.0",
35
- "@aws-sdk/util-user-agent-node": "3.465.0",
36
- "@smithy/config-resolver": "^2.0.18",
37
- "@smithy/fetch-http-handler": "^2.2.6",
38
- "@smithy/hash-node": "^2.0.15",
39
- "@smithy/invalid-dependency": "^2.0.13",
40
- "@smithy/middleware-content-length": "^2.0.15",
41
- "@smithy/middleware-endpoint": "^2.2.0",
42
- "@smithy/middleware-retry": "^2.0.20",
43
- "@smithy/middleware-serde": "^2.0.13",
44
- "@smithy/middleware-stack": "^2.0.7",
45
- "@smithy/node-config-provider": "^2.1.5",
46
- "@smithy/node-http-handler": "^2.1.9",
47
- "@smithy/protocol-http": "^3.0.9",
48
- "@smithy/smithy-client": "^2.1.15",
49
- "@smithy/types": "^2.5.0",
50
- "@smithy/url-parser": "^2.0.13",
23
+ "@aws-sdk/client-sts": "3.468.0",
24
+ "@aws-sdk/core": "3.468.0",
25
+ "@aws-sdk/credential-provider-node": "3.468.0",
26
+ "@aws-sdk/middleware-host-header": "3.468.0",
27
+ "@aws-sdk/middleware-logger": "3.468.0",
28
+ "@aws-sdk/middleware-recursion-detection": "3.468.0",
29
+ "@aws-sdk/middleware-signing": "3.468.0",
30
+ "@aws-sdk/middleware-user-agent": "3.468.0",
31
+ "@aws-sdk/region-config-resolver": "3.468.0",
32
+ "@aws-sdk/types": "3.468.0",
33
+ "@aws-sdk/util-endpoints": "3.468.0",
34
+ "@aws-sdk/util-user-agent-browser": "3.468.0",
35
+ "@aws-sdk/util-user-agent-node": "3.468.0",
36
+ "@smithy/config-resolver": "^2.0.20",
37
+ "@smithy/fetch-http-handler": "^2.3.1",
38
+ "@smithy/hash-node": "^2.0.17",
39
+ "@smithy/invalid-dependency": "^2.0.15",
40
+ "@smithy/middleware-content-length": "^2.0.17",
41
+ "@smithy/middleware-endpoint": "^2.2.2",
42
+ "@smithy/middleware-retry": "^2.0.23",
43
+ "@smithy/middleware-serde": "^2.0.15",
44
+ "@smithy/middleware-stack": "^2.0.9",
45
+ "@smithy/node-config-provider": "^2.1.7",
46
+ "@smithy/node-http-handler": "^2.2.1",
47
+ "@smithy/protocol-http": "^3.0.11",
48
+ "@smithy/smithy-client": "^2.1.18",
49
+ "@smithy/types": "^2.7.0",
50
+ "@smithy/url-parser": "^2.0.15",
51
51
  "@smithy/util-base64": "^2.0.1",
52
- "@smithy/util-body-length-browser": "^2.0.0",
52
+ "@smithy/util-body-length-browser": "^2.0.1",
53
53
  "@smithy/util-body-length-node": "^2.1.0",
54
- "@smithy/util-defaults-mode-browser": "^2.0.19",
55
- "@smithy/util-defaults-mode-node": "^2.0.25",
56
- "@smithy/util-endpoints": "^1.0.4",
57
- "@smithy/util-retry": "^2.0.6",
54
+ "@smithy/util-defaults-mode-browser": "^2.0.22",
55
+ "@smithy/util-defaults-mode-node": "^2.0.28",
56
+ "@smithy/util-endpoints": "^1.0.6",
57
+ "@smithy/util-retry": "^2.0.8",
58
58
  "@smithy/util-utf8": "^2.0.2",
59
59
  "tslib": "^2.5.0",
60
60
  "uuid": "^8.3.2"