@aws-sdk/client-keyspaces 3.345.0 → 3.346.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.
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.TableStatus = exports.ResourceNotFoundException = exports.TimeToLiveStatus = exports.PointInTimeRecoveryStatus = exports.EncryptionType = exports.ValidationException = exports.ServiceQuotaExceededException = exports.InternalServerException = exports.ConflictException = exports.SortOrder = exports.ClientSideTimestampsStatus = exports.ThroughputMode = exports.AccessDeniedException = void 0;
3
+ exports.TableStatus = exports.ResourceNotFoundException = exports.TimeToLiveStatus = exports.PointInTimeRecoveryStatus = exports.EncryptionType = exports.ValidationException = exports.ServiceQuotaExceededException = exports.InternalServerException = exports.Rs = exports.ConflictException = exports.SortOrder = exports.ClientSideTimestampsStatus = exports.ThroughputMode = exports.AccessDeniedException = void 0;
4
4
  const KeyspacesServiceException_1 = require("./KeyspacesServiceException");
5
5
  class AccessDeniedException extends KeyspacesServiceException_1.KeyspacesServiceException {
6
6
  constructor(opts) {
@@ -39,6 +39,10 @@ class ConflictException extends KeyspacesServiceException_1.KeyspacesServiceExce
39
39
  }
40
40
  }
41
41
  exports.ConflictException = ConflictException;
42
+ exports.Rs = {
43
+ MULTI_REGION: "MULTI_REGION",
44
+ SINGLE_REGION: "SINGLE_REGION",
45
+ };
42
46
  class InternalServerException extends KeyspacesServiceException_1.KeyspacesServiceException {
43
47
  constructor(opts) {
44
48
  super({
@@ -34,6 +34,10 @@ export class ConflictException extends __BaseException {
34
34
  Object.setPrototypeOf(this, ConflictException.prototype);
35
35
  }
36
36
  }
37
+ export const Rs = {
38
+ MULTI_REGION: "MULTI_REGION",
39
+ SINGLE_REGION: "SINGLE_REGION",
40
+ };
37
41
  export class InternalServerException extends __BaseException {
38
42
  constructor(opts) {
39
43
  super({
@@ -44,6 +44,12 @@ export interface CreateKeyspaceCommandOutput extends CreateKeyspaceResponse, __M
44
44
  * value: "STRING_VALUE", // required
45
45
  * },
46
46
  * ],
47
+ * replicationSpecification: { // ReplicationSpecification
48
+ * replicationStrategy: "STRING_VALUE", // required
49
+ * regionList: [ // RegionList
50
+ * "STRING_VALUE",
51
+ * ],
52
+ * },
47
53
  * };
48
54
  * const command = new CreateKeyspaceCommand(input);
49
55
  * const response = await client.send(command);
@@ -38,6 +38,10 @@ export interface GetKeyspaceCommandOutput extends GetKeyspaceResponse, __Metadat
38
38
  * // { // GetKeyspaceResponse
39
39
  * // keyspaceName: "STRING_VALUE", // required
40
40
  * // resourceArn: "STRING_VALUE", // required
41
+ * // replicationStrategy: "STRING_VALUE", // required
42
+ * // replicationRegions: [ // RegionList
43
+ * // "STRING_VALUE",
44
+ * // ],
41
45
  * // };
42
46
  *
43
47
  * ```
@@ -42,6 +42,10 @@ export interface ListKeyspacesCommandOutput extends ListKeyspacesResponse, __Met
42
42
  * // { // KeyspaceSummary
43
43
  * // keyspaceName: "STRING_VALUE", // required
44
44
  * // resourceArn: "STRING_VALUE", // required
45
+ * // replicationStrategy: "STRING_VALUE", // required
46
+ * // replicationRegions: [ // RegionList
47
+ * // "STRING_VALUE",
48
+ * // ],
45
49
  * // },
46
50
  * // ],
47
51
  * // };
@@ -28,7 +28,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
28
28
  * For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer
29
29
  * Guide</i>.</p>
30
30
  * <p>For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags,
31
- * see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/security_iam_id-based-policy-examples-tags">Amazon Keyspaces resource access based on tags</a>
31
+ * see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-tags">Amazon Keyspaces resource access based on tags</a>
32
32
  * in the <i>Amazon Keyspaces Developer Guide</i>.</p>
33
33
  * @example
34
34
  * Use a bare-bones client and the command you need to make an API call.
@@ -208,6 +208,49 @@ export declare class ConflictException extends __BaseException {
208
208
  */
209
209
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
210
210
  }
211
+ /**
212
+ * @public
213
+ * @enum
214
+ */
215
+ export declare const Rs: {
216
+ readonly MULTI_REGION: "MULTI_REGION";
217
+ readonly SINGLE_REGION: "SINGLE_REGION";
218
+ };
219
+ /**
220
+ * @public
221
+ */
222
+ export type Rs = (typeof Rs)[keyof typeof Rs];
223
+ /**
224
+ * @public
225
+ * <p>
226
+ * The replication specification of the keyspace includes:</p>
227
+ * <ul>
228
+ * <li>
229
+ * <p>
230
+ * <code>regionList</code> - up to six Amazon Web Services Regions where the keyspace is replicated in.</p>
231
+ * </li>
232
+ * <li>
233
+ * <p>
234
+ * <code>replicationStrategy</code> - the required value is <code>SINGLE_REGION</code> or
235
+ * <code>MULTI_REGION</code>.</p>
236
+ * </li>
237
+ * </ul>
238
+ */
239
+ export interface ReplicationSpecification {
240
+ /**
241
+ * <p>
242
+ * The <code>replicationStrategy</code> of a keyspace, the required value is <code>SINGLE_REGION</code> or
243
+ * <code>MULTI_REGION</code>.
244
+ * </p>
245
+ */
246
+ replicationStrategy: Rs | string | undefined;
247
+ /**
248
+ * <p>
249
+ * The <code>regionList</code> can contain up to six Amazon Web Services Regions where the keyspace is replicated in.
250
+ * </p>
251
+ */
252
+ regionList?: string[];
253
+ }
211
254
  /**
212
255
  * @public
213
256
  * <p>Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource.</p>
@@ -242,6 +285,25 @@ export interface CreateKeyspaceRequest {
242
285
  * Guide</i>.</p>
243
286
  */
244
287
  tags?: Tag[];
288
+ /**
289
+ * <p>
290
+ * The replication specification of the keyspace includes:</p>
291
+ * <ul>
292
+ * <li>
293
+ * <p>
294
+ * <code>replicationStrategy</code> - the required value is <code>SINGLE_REGION</code> or
295
+ * <code>MULTI_REGION</code>.</p>
296
+ * </li>
297
+ * <li>
298
+ * <p>
299
+ * <code>regionList</code> - if the <code>replicationStrategy</code> is <code>MULTI_REGION</code>, the
300
+ * <code>regionList</code> requires the current Region and at least one additional Amazon Web Services Region where
301
+ * the keyspace is going to be replicated in. The maximum number of supported replication Regions including the current
302
+ * Region is six.</p>
303
+ * </li>
304
+ * </ul>
305
+ */
306
+ replicationSpecification?: ReplicationSpecification;
245
307
  }
246
308
  /**
247
309
  * @public
@@ -709,9 +771,21 @@ export interface GetKeyspaceResponse {
709
771
  */
710
772
  keyspaceName: string | undefined;
711
773
  /**
712
- * <p>The ARN of the keyspace.</p>
774
+ * <p>Returns the ARN of the keyspace.</p>
713
775
  */
714
776
  resourceArn: string | undefined;
777
+ /**
778
+ * <p>
779
+ * Returns the replication strategy of the keyspace. The options are <code>SINGLE_REGION</code> or <code>MULTI_REGION</code>.
780
+ * </p>
781
+ */
782
+ replicationStrategy: Rs | string | undefined;
783
+ /**
784
+ * <p>
785
+ * If the <code>replicationStrategy</code> of the keyspace is <code>MULTI_REGION</code>, a list of replication Regions is returned.
786
+ * </p>
787
+ */
788
+ replicationRegions?: string[];
715
789
  }
716
790
  /**
717
791
  * @public
@@ -855,6 +929,19 @@ export interface KeyspaceSummary {
855
929
  * <p>The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).</p>
856
930
  */
857
931
  resourceArn: string | undefined;
932
+ /**
933
+ * <p>
934
+ * This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available
935
+ * values are <code>SINGLE_REGION</code> or <code>MULTI_REGION</code>.
936
+ * </p>
937
+ */
938
+ replicationStrategy: Rs | string | undefined;
939
+ /**
940
+ * <p>
941
+ * If the <code>replicationStrategy</code> of the keyspace is <code>MULTI_REGION</code>, a list of replication Regions is returned.
942
+ * </p>
943
+ */
944
+ replicationRegions?: string[];
858
945
  }
859
946
  /**
860
947
  * @public
@@ -53,6 +53,15 @@ export declare class ConflictException extends __BaseException {
53
53
  readonly $fault: "client";
54
54
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
55
55
  }
56
+ export declare const Rs: {
57
+ readonly MULTI_REGION: "MULTI_REGION";
58
+ readonly SINGLE_REGION: "SINGLE_REGION";
59
+ };
60
+ export type Rs = (typeof Rs)[keyof typeof Rs];
61
+ export interface ReplicationSpecification {
62
+ replicationStrategy: Rs | string | undefined;
63
+ regionList?: string[];
64
+ }
56
65
  export interface Tag {
57
66
  key: string | undefined;
58
67
  value: string | undefined;
@@ -60,6 +69,7 @@ export interface Tag {
60
69
  export interface CreateKeyspaceRequest {
61
70
  keyspaceName: string | undefined;
62
71
  tags?: Tag[];
72
+ replicationSpecification?: ReplicationSpecification;
63
73
  }
64
74
  export interface CreateKeyspaceResponse {
65
75
  resourceArn: string | undefined;
@@ -163,6 +173,8 @@ export interface GetKeyspaceRequest {
163
173
  export interface GetKeyspaceResponse {
164
174
  keyspaceName: string | undefined;
165
175
  resourceArn: string | undefined;
176
+ replicationStrategy: Rs | string | undefined;
177
+ replicationRegions?: string[];
166
178
  }
167
179
  export interface GetTableRequest {
168
180
  keyspaceName: string | undefined;
@@ -204,6 +216,8 @@ export interface ListKeyspacesRequest {
204
216
  export interface KeyspaceSummary {
205
217
  keyspaceName: string | undefined;
206
218
  resourceArn: string | undefined;
219
+ replicationStrategy: Rs | string | undefined;
220
+ replicationRegions?: string[];
207
221
  }
208
222
  export interface ListKeyspacesResponse {
209
223
  nextToken?: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-keyspaces",
3
3
  "description": "AWS SDK for JavaScript Keyspaces Client for Node.js, Browser and React Native",
4
- "version": "3.345.0",
4
+ "version": "3.346.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",