@aws-sdk/client-keyspaces 3.835.0 → 3.839.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.
- package/README.md +1 -14
- package/dist-cjs/index.js +26 -0
- package/dist-es/models/models_0.js +16 -0
- package/dist-es/protocols/Aws_json1_0.js +4 -0
- package/dist-types/Keyspaces.d.ts +1 -14
- package/dist-types/KeyspacesClient.d.ts +1 -14
- package/dist-types/commands/CreateKeyspaceCommand.d.ts +3 -12
- package/dist-types/commands/CreateTableCommand.d.ts +15 -15
- package/dist-types/commands/CreateTypeCommand.d.ts +4 -14
- package/dist-types/commands/DeleteKeyspaceCommand.d.ts +3 -7
- package/dist-types/commands/DeleteTableCommand.d.ts +4 -12
- package/dist-types/commands/DeleteTypeCommand.d.ts +4 -13
- package/dist-types/commands/GetKeyspaceCommand.d.ts +3 -6
- package/dist-types/commands/GetTableAutoScalingSettingsCommand.d.ts +3 -27
- package/dist-types/commands/GetTableCommand.d.ts +8 -9
- package/dist-types/commands/GetTypeCommand.d.ts +3 -12
- package/dist-types/commands/ListKeyspacesCommand.d.ts +2 -4
- package/dist-types/commands/ListTablesCommand.d.ts +3 -8
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -8
- package/dist-types/commands/ListTypesCommand.d.ts +3 -11
- package/dist-types/commands/RestoreTableCommand.d.ts +4 -53
- package/dist-types/commands/TagResourceCommand.d.ts +4 -14
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -7
- package/dist-types/commands/UpdateKeyspaceCommand.d.ts +4 -108
- package/dist-types/commands/UpdateTableCommand.d.ts +15 -10
- package/dist-types/index.d.ts +1 -14
- package/dist-types/models/models_0.d.ts +225 -814
- package/dist-types/ts3.4/models/models_0.d.ts +38 -4
- package/package.json +11 -11
|
@@ -18,109 +18,39 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
18
18
|
*/
|
|
19
19
|
export interface TargetTrackingScalingPolicyConfiguration {
|
|
20
20
|
/**
|
|
21
|
-
* <p>Specifies if <code>scale-in</code> is enabled.</p>
|
|
22
|
-
* <p>When auto scaling automatically decreases capacity for a table,
|
|
23
|
-
* the table <i>scales in</i>. When scaling policies are set, they can't
|
|
24
|
-
* scale in the table lower than its minimum capacity.</p>
|
|
21
|
+
* <p>Specifies if <code>scale-in</code> is enabled.</p> <p>When auto scaling automatically decreases capacity for a table, the table <i>scales in</i>. When scaling policies are set, they can't scale in the table lower than its minimum capacity.</p>
|
|
25
22
|
* @public
|
|
26
23
|
*/
|
|
27
24
|
disableScaleIn?: boolean | undefined;
|
|
28
25
|
/**
|
|
29
|
-
* <p>Specifies a <code>scale-in</code> cool down period.</p>
|
|
30
|
-
* <p>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </p>
|
|
26
|
+
* <p>Specifies a <code>scale-in</code> cool down period.</p> <p>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </p>
|
|
31
27
|
* @public
|
|
32
28
|
*/
|
|
33
29
|
scaleInCooldown?: number | undefined;
|
|
34
30
|
/**
|
|
35
|
-
* <p>Specifies a scale out cool down period.</p>
|
|
36
|
-
* <p>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </p>
|
|
31
|
+
* <p>Specifies a scale out cool down period.</p> <p>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </p>
|
|
37
32
|
* @public
|
|
38
33
|
*/
|
|
39
34
|
scaleOutCooldown?: number | undefined;
|
|
40
35
|
/**
|
|
41
|
-
* <p>Specifies the target value for the target tracking auto scaling policy.</p>
|
|
42
|
-
* <p>Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization
|
|
43
|
-
* rate, and then back down when it falls below the target. This ensures that the ratio of
|
|
44
|
-
* consumed capacity to provisioned capacity stays at or near this value. You
|
|
45
|
-
* define <code>targetValue</code> as a percentage. A <code>double</code> between 20 and 90.</p>
|
|
36
|
+
* <p>Specifies the target value for the target tracking auto scaling policy.</p> <p>Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define <code>targetValue</code> as a percentage. A <code>double</code> between 20 and 90.</p>
|
|
46
37
|
* @public
|
|
47
38
|
*/
|
|
48
39
|
targetValue: number | undefined;
|
|
49
40
|
}
|
|
50
41
|
/**
|
|
51
|
-
* <p>Amazon Keyspaces supports the <code>target tracking</code> auto scaling policy. With this policy, Amazon Keyspaces auto scaling
|
|
52
|
-
* ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You
|
|
53
|
-
* define the target value as a percentage between 20 and 90.</p>
|
|
42
|
+
* <p>Amazon Keyspaces supports the <code>target tracking</code> auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.</p>
|
|
54
43
|
* @public
|
|
55
44
|
*/
|
|
56
45
|
export interface AutoScalingPolicy {
|
|
57
46
|
/**
|
|
58
|
-
* <p>Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down
|
|
59
|
-
* when it falls below the target. A <code>double</code> between 20 and 90.</p>
|
|
47
|
+
* <p>Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. A <code>double</code> between 20 and 90.</p>
|
|
60
48
|
* @public
|
|
61
49
|
*/
|
|
62
50
|
targetTrackingScalingPolicyConfiguration?: TargetTrackingScalingPolicyConfiguration | undefined;
|
|
63
51
|
}
|
|
64
52
|
/**
|
|
65
|
-
* <p>The optional auto scaling settings for a table with provisioned throughput capacity.</p>
|
|
66
|
-
* <p>To turn on auto scaling for a table in <code>throughputMode:PROVISIONED</code>,
|
|
67
|
-
* you must specify the following parameters. </p>
|
|
68
|
-
* <p>Configure the minimum and maximum capacity units. The auto scaling policy ensures that
|
|
69
|
-
* capacity never goes below the minimum or above the maximum range.</p>
|
|
70
|
-
* <ul>
|
|
71
|
-
* <li>
|
|
72
|
-
* <p>
|
|
73
|
-
* <code>minimumUnits</code>: The minimum level of throughput the table should always be ready to support. The value must be between 1
|
|
74
|
-
* and the max throughput per second quota for your account (40,000 by default).</p>
|
|
75
|
-
* </li>
|
|
76
|
-
* <li>
|
|
77
|
-
* <p>
|
|
78
|
-
* <code>maximumUnits</code>: The maximum level of throughput the table should always be ready to
|
|
79
|
-
* support. The value must be between 1 and the max throughput per second quota for your
|
|
80
|
-
* account (40,000 by default).</p>
|
|
81
|
-
* </li>
|
|
82
|
-
* <li>
|
|
83
|
-
* <p>
|
|
84
|
-
* <code>scalingPolicy</code>: Amazon Keyspaces supports the <code>target tracking</code> scaling policy.
|
|
85
|
-
* The auto scaling target is the provisioned capacity of the table.
|
|
86
|
-
* </p>
|
|
87
|
-
* <ul>
|
|
88
|
-
* <li>
|
|
89
|
-
* <p>
|
|
90
|
-
* <code>targetTrackingScalingPolicyConfiguration</code>: To define the target tracking policy, you must define the target value.
|
|
91
|
-
* </p>
|
|
92
|
-
* <ul>
|
|
93
|
-
* <li>
|
|
94
|
-
* <p>
|
|
95
|
-
* <code>targetValue</code>: The target utilization rate of the table. Amazon Keyspaces auto scaling ensures that the ratio of
|
|
96
|
-
* consumed capacity to provisioned capacity stays at or near this value. You
|
|
97
|
-
* define <code>targetValue</code> as a percentage. A <code>double</code> between 20 and 90. (Required)</p>
|
|
98
|
-
* </li>
|
|
99
|
-
* <li>
|
|
100
|
-
* <p>
|
|
101
|
-
* <code>disableScaleIn</code>: A <code>boolean</code> that specifies if <code>scale-in</code> is
|
|
102
|
-
* disabled or enabled for the table. This parameter is disabled by default.
|
|
103
|
-
* To turn on <code>scale-in</code>, set the <code>boolean</code> value to
|
|
104
|
-
* <code>FALSE</code>. This means that capacity for a table can be
|
|
105
|
-
* automatically scaled down on your behalf. (Optional) </p>
|
|
106
|
-
* </li>
|
|
107
|
-
* <li>
|
|
108
|
-
* <p>
|
|
109
|
-
* <code>scaleInCooldown</code>: A cooldown period in seconds between scaling activities that lets the table stabilize
|
|
110
|
-
* before another scale in activity starts. If no value is provided, the default is 0. (Optional) </p>
|
|
111
|
-
* </li>
|
|
112
|
-
* <li>
|
|
113
|
-
* <p>
|
|
114
|
-
* <code>scaleOutCooldown</code>: A cooldown period in seconds between scaling activities that lets the table stabilize
|
|
115
|
-
* before another scale out activity starts. If no value is provided, the default is 0. (Optional) </p>
|
|
116
|
-
* </li>
|
|
117
|
-
* </ul>
|
|
118
|
-
* </li>
|
|
119
|
-
* </ul>
|
|
120
|
-
* </li>
|
|
121
|
-
* </ul>
|
|
122
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer
|
|
123
|
-
* Guide</i>.</p>
|
|
53
|
+
* <p>The optional auto scaling settings for a table with provisioned throughput capacity.</p> <p>To turn on auto scaling for a table in <code>throughputMode:PROVISIONED</code>, you must specify the following parameters. </p> <p>Configure the minimum and maximum capacity units. The auto scaling policy ensures that capacity never goes below the minimum or above the maximum range.</p> <ul> <li> <p> <code>minimumUnits</code>: The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</p> </li> <li> <p> <code>maximumUnits</code>: The maximum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</p> </li> <li> <p> <code>scalingPolicy</code>: Amazon Keyspaces supports the <code>target tracking</code> scaling policy. The auto scaling target is the provisioned capacity of the table. </p> <ul> <li> <p> <code>targetTrackingScalingPolicyConfiguration</code>: To define the target tracking policy, you must define the target value. </p> <ul> <li> <p> <code>targetValue</code>: The target utilization rate of the table. Amazon Keyspaces auto scaling ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define <code>targetValue</code> as a percentage. A <code>double</code> between 20 and 90. (Required)</p> </li> <li> <p> <code>disableScaleIn</code>: A <code>boolean</code> that specifies if <code>scale-in</code> is disabled or enabled for the table. This parameter is disabled by default. To turn on <code>scale-in</code>, set the <code>boolean</code> value to <code>FALSE</code>. This means that capacity for a table can be automatically scaled down on your behalf. (Optional) </p> </li> <li> <p> <code>scaleInCooldown</code>: A cooldown period in seconds between scaling activities that lets the table stabilize before another scale in activity starts. If no value is provided, the default is 0. (Optional) </p> </li> <li> <p> <code>scaleOutCooldown</code>: A cooldown period in seconds between scaling activities that lets the table stabilize before another scale out activity starts. If no value is provided, the default is 0. (Optional) </p> </li> </ul> </li> </ul> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
124
54
|
* @public
|
|
125
55
|
*/
|
|
126
56
|
export interface AutoScalingSettings {
|
|
@@ -130,21 +60,17 @@ export interface AutoScalingSettings {
|
|
|
130
60
|
*/
|
|
131
61
|
autoScalingDisabled?: boolean | undefined;
|
|
132
62
|
/**
|
|
133
|
-
* <p>The minimum level of throughput the table should always be ready to support. The value must be between 1
|
|
134
|
-
* and the max throughput per second quota for your account (40,000 by default).</p>
|
|
63
|
+
* <p>The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</p>
|
|
135
64
|
* @public
|
|
136
65
|
*/
|
|
137
66
|
minimumUnits?: number | undefined;
|
|
138
67
|
/**
|
|
139
|
-
* <p>Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1
|
|
140
|
-
* and the max throughput per second quota for your account (40,000 by default).</p>
|
|
68
|
+
* <p>Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</p>
|
|
141
69
|
* @public
|
|
142
70
|
*/
|
|
143
71
|
maximumUnits?: number | undefined;
|
|
144
72
|
/**
|
|
145
|
-
* <p>Amazon Keyspaces supports the <code>target tracking</code> auto scaling policy. With this policy, Amazon Keyspaces auto scaling
|
|
146
|
-
* ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You
|
|
147
|
-
* define the target value as a percentage between 20 and 90.</p>
|
|
73
|
+
* <p>Amazon Keyspaces supports the <code>target tracking</code> auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90.</p>
|
|
148
74
|
* @public
|
|
149
75
|
*/
|
|
150
76
|
scalingPolicy?: AutoScalingPolicy | undefined;
|
|
@@ -178,99 +104,43 @@ export declare const ThroughputMode: {
|
|
|
178
104
|
*/
|
|
179
105
|
export type ThroughputMode = (typeof ThroughputMode)[keyof typeof ThroughputMode];
|
|
180
106
|
/**
|
|
181
|
-
* <p>Amazon Keyspaces has two read/write capacity modes for processing reads and writes on your tables: </p>
|
|
182
|
-
* <ul>
|
|
183
|
-
* <li>
|
|
184
|
-
* <p>On-demand (default)</p>
|
|
185
|
-
* </li>
|
|
186
|
-
* <li>
|
|
187
|
-
* <p>Provisioned</p>
|
|
188
|
-
* </li>
|
|
189
|
-
* </ul>
|
|
190
|
-
* <p>The read/write capacity mode that you choose controls how you are charged for read and
|
|
191
|
-
* write throughput and how table throughput capacity is managed.</p>
|
|
192
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
193
|
-
* Guide</i>.</p>
|
|
107
|
+
* <p>Amazon Keyspaces has two read/write capacity modes for processing reads and writes on your tables: </p> <ul> <li> <p>On-demand (default)</p> </li> <li> <p>Provisioned</p> </li> </ul> <p>The read/write capacity mode that you choose controls how you are charged for read and write throughput and how table throughput capacity is managed.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
194
108
|
* @public
|
|
195
109
|
*/
|
|
196
110
|
export interface CapacitySpecification {
|
|
197
111
|
/**
|
|
198
|
-
* <p>The read/write throughput capacity mode for a table. The options are:</p>
|
|
199
|
-
* <ul>
|
|
200
|
-
* <li>
|
|
201
|
-
* <p>
|
|
202
|
-
* <code>throughputMode:PAY_PER_REQUEST</code> and </p>
|
|
203
|
-
* </li>
|
|
204
|
-
* <li>
|
|
205
|
-
* <p>
|
|
206
|
-
* <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires
|
|
207
|
-
* <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p>
|
|
208
|
-
* </li>
|
|
209
|
-
* </ul>
|
|
210
|
-
* <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p>
|
|
211
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
212
|
-
* Guide</i>.</p>
|
|
112
|
+
* <p>The read/write throughput capacity mode for a table. The options are:</p> <ul> <li> <p> <code>throughputMode:PAY_PER_REQUEST</code> and </p> </li> <li> <p> <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p> </li> </ul> <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
213
113
|
* @public
|
|
214
114
|
*/
|
|
215
115
|
throughputMode: ThroughputMode | undefined;
|
|
216
116
|
/**
|
|
217
|
-
* <p>The throughput capacity specified for <code>read</code> operations defined in <code>read capacity units</code>
|
|
218
|
-
* <code>(RCUs)</code>.</p>
|
|
117
|
+
* <p>The throughput capacity specified for <code>read</code> operations defined in <code>read capacity units</code> <code>(RCUs)</code>.</p>
|
|
219
118
|
* @public
|
|
220
119
|
*/
|
|
221
120
|
readCapacityUnits?: number | undefined;
|
|
222
121
|
/**
|
|
223
|
-
* <p>The throughput capacity specified for <code>write</code> operations defined in <code>write capacity units</code>
|
|
224
|
-
* <code>(WCUs)</code>.</p>
|
|
122
|
+
* <p>The throughput capacity specified for <code>write</code> operations defined in <code>write capacity units</code> <code>(WCUs)</code>.</p>
|
|
225
123
|
* @public
|
|
226
124
|
*/
|
|
227
125
|
writeCapacityUnits?: number | undefined;
|
|
228
126
|
}
|
|
229
127
|
/**
|
|
230
|
-
* <p>The read/write throughput capacity mode for a table. The options are:</p>
|
|
231
|
-
* <ul>
|
|
232
|
-
* <li>
|
|
233
|
-
* <p>
|
|
234
|
-
* <code>throughputMode:PAY_PER_REQUEST</code> and </p>
|
|
235
|
-
* </li>
|
|
236
|
-
* <li>
|
|
237
|
-
* <p>
|
|
238
|
-
* <code>throughputMode:PROVISIONED</code>.</p>
|
|
239
|
-
* </li>
|
|
240
|
-
* </ul>
|
|
241
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
242
|
-
* Guide</i>.</p>
|
|
128
|
+
* <p>The read/write throughput capacity mode for a table. The options are:</p> <ul> <li> <p> <code>throughputMode:PAY_PER_REQUEST</code> and </p> </li> <li> <p> <code>throughputMode:PROVISIONED</code>.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
243
129
|
* @public
|
|
244
130
|
*/
|
|
245
131
|
export interface CapacitySpecificationSummary {
|
|
246
132
|
/**
|
|
247
|
-
* <p>The read/write throughput capacity mode for a table. The options are:</p>
|
|
248
|
-
* <ul>
|
|
249
|
-
* <li>
|
|
250
|
-
* <p>
|
|
251
|
-
* <code>throughputMode:PAY_PER_REQUEST</code> and </p>
|
|
252
|
-
* </li>
|
|
253
|
-
* <li>
|
|
254
|
-
* <p>
|
|
255
|
-
* <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires
|
|
256
|
-
* <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input. </p>
|
|
257
|
-
* </li>
|
|
258
|
-
* </ul>
|
|
259
|
-
* <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p>
|
|
260
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
261
|
-
* Guide</i>.</p>
|
|
133
|
+
* <p>The read/write throughput capacity mode for a table. The options are:</p> <ul> <li> <p> <code>throughputMode:PAY_PER_REQUEST</code> and </p> </li> <li> <p> <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input. </p> </li> </ul> <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
262
134
|
* @public
|
|
263
135
|
*/
|
|
264
136
|
throughputMode: ThroughputMode | undefined;
|
|
265
137
|
/**
|
|
266
|
-
* <p>The throughput capacity specified for <code>read</code> operations defined in <code>read capacity units</code>
|
|
267
|
-
* <code>(RCUs)</code>.</p>
|
|
138
|
+
* <p>The throughput capacity specified for <code>read</code> operations defined in <code>read capacity units</code> <code>(RCUs)</code>.</p>
|
|
268
139
|
* @public
|
|
269
140
|
*/
|
|
270
141
|
readCapacityUnits?: number | undefined;
|
|
271
142
|
/**
|
|
272
|
-
* <p>The throughput capacity specified for <code>write</code> operations defined in <code>write capacity units</code>
|
|
273
|
-
* <code>(WCUs)</code>.</p>
|
|
143
|
+
* <p>The throughput capacity specified for <code>write</code> operations defined in <code>write capacity units</code> <code>(WCUs)</code>.</p>
|
|
274
144
|
* @public
|
|
275
145
|
*/
|
|
276
146
|
writeCapacityUnits?: number | undefined;
|
|
@@ -280,6 +150,104 @@ export interface CapacitySpecificationSummary {
|
|
|
280
150
|
*/
|
|
281
151
|
lastUpdateToPayPerRequestTimestamp?: Date | undefined;
|
|
282
152
|
}
|
|
153
|
+
/**
|
|
154
|
+
* @public
|
|
155
|
+
* @enum
|
|
156
|
+
*/
|
|
157
|
+
export declare const CdcPropagateTags: {
|
|
158
|
+
readonly NONE: "NONE";
|
|
159
|
+
readonly TABLE: "TABLE";
|
|
160
|
+
};
|
|
161
|
+
/**
|
|
162
|
+
* @public
|
|
163
|
+
*/
|
|
164
|
+
export type CdcPropagateTags = (typeof CdcPropagateTags)[keyof typeof CdcPropagateTags];
|
|
165
|
+
/**
|
|
166
|
+
* @public
|
|
167
|
+
* @enum
|
|
168
|
+
*/
|
|
169
|
+
export declare const CdcStatus: {
|
|
170
|
+
readonly DISABLED: "DISABLED";
|
|
171
|
+
readonly DISABLING: "DISABLING";
|
|
172
|
+
readonly ENABLED: "ENABLED";
|
|
173
|
+
readonly ENABLING: "ENABLING";
|
|
174
|
+
};
|
|
175
|
+
/**
|
|
176
|
+
* @public
|
|
177
|
+
*/
|
|
178
|
+
export type CdcStatus = (typeof CdcStatus)[keyof typeof CdcStatus];
|
|
179
|
+
/**
|
|
180
|
+
* <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> <p>Amazon Web Services-assigned tag names and values are automatically assigned the <code>aws:</code> prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix <code>user:</code> in the Cost Allocation Report. You cannot backdate the application of a tag.</p> <p>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 Guide</i>.</p>
|
|
181
|
+
* @public
|
|
182
|
+
*/
|
|
183
|
+
export interface Tag {
|
|
184
|
+
/**
|
|
185
|
+
* <p>The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.</p>
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
key: string | undefined;
|
|
189
|
+
/**
|
|
190
|
+
* <p>The value of the tag. Tag values are case-sensitive and can be null.</p>
|
|
191
|
+
* @public
|
|
192
|
+
*/
|
|
193
|
+
value: string | undefined;
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* @public
|
|
197
|
+
* @enum
|
|
198
|
+
*/
|
|
199
|
+
export declare const ViewType: {
|
|
200
|
+
readonly KEYS_ONLY: "KEYS_ONLY";
|
|
201
|
+
readonly NEW_AND_OLD_IMAGES: "NEW_AND_OLD_IMAGES";
|
|
202
|
+
readonly NEW_IMAGE: "NEW_IMAGE";
|
|
203
|
+
readonly OLD_IMAGE: "OLD_IMAGE";
|
|
204
|
+
};
|
|
205
|
+
/**
|
|
206
|
+
* @public
|
|
207
|
+
*/
|
|
208
|
+
export type ViewType = (typeof ViewType)[keyof typeof ViewType];
|
|
209
|
+
/**
|
|
210
|
+
* <p>The settings for the CDC stream of a table. For more information about CDC streams, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cdc.html">Working with change data capture (CDC) streams in Amazon Keyspaces</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
213
|
+
export interface CdcSpecification {
|
|
214
|
+
/**
|
|
215
|
+
* <p>The status of the CDC stream. You can enable or disable a stream for a table.</p>
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
status: CdcStatus | undefined;
|
|
219
|
+
/**
|
|
220
|
+
* <p>The view type specifies the changes Amazon Keyspaces records for each changed row in the stream. After you create the stream, you can't make changes to this selection. </p> <p>The options are:</p> <ul> <li> <p> <code>NEW_AND_OLD_IMAGES</code> - both versions of the row, before and after the change. This is the default.</p> </li> <li> <p> <code>NEW_IMAGE</code> - the version of the row after the change.</p> </li> <li> <p> <code>OLD_IMAGE</code> - the version of the row before the change.</p> </li> <li> <p> <code>KEYS_ONLY</code> - the partition and clustering keys of the row that was changed.</p> </li> </ul>
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
viewType?: ViewType | undefined;
|
|
224
|
+
/**
|
|
225
|
+
* <p>The tags (key-value pairs) that you want to apply to the stream.</p>
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
228
|
+
tags?: Tag[] | undefined;
|
|
229
|
+
/**
|
|
230
|
+
* <p>Specifies that the stream inherits the tags from the table.</p>
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
propagateTags?: CdcPropagateTags | undefined;
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* <p>The settings of the CDC stream of the table. For more information about CDC streams, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cdc.html">Working with change data capture (CDC) streams in Amazon Keyspaces</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
237
|
+
* @public
|
|
238
|
+
*/
|
|
239
|
+
export interface CdcSpecificationSummary {
|
|
240
|
+
/**
|
|
241
|
+
* <p>The status of the CDC stream. Specifies if the table has a CDC stream.</p>
|
|
242
|
+
* @public
|
|
243
|
+
*/
|
|
244
|
+
status: CdcStatus | undefined;
|
|
245
|
+
/**
|
|
246
|
+
* <p>The view type specifies the changes Amazon Keyspaces records for each changed row in the stream. This setting can't be changed, after the stream has been created. </p> <p>The options are:</p> <ul> <li> <p> <code>NEW_AND_OLD_IMAGES</code> - both versions of the row, before and after the change. This is the default.</p> </li> <li> <p> <code>NEW_IMAGE</code> - the version of the row after the change.</p> </li> <li> <p> <code>OLD_IMAGE</code> - the version of the row before the change.</p> </li> <li> <p> <code>KEYS_ONLY</code> - the partition and clustering keys of the row that was changed.</p> </li> </ul>
|
|
247
|
+
* @public
|
|
248
|
+
*/
|
|
249
|
+
viewType?: ViewType | undefined;
|
|
250
|
+
}
|
|
283
251
|
/**
|
|
284
252
|
* @public
|
|
285
253
|
* @enum
|
|
@@ -292,9 +260,7 @@ export declare const ClientSideTimestampsStatus: {
|
|
|
292
260
|
*/
|
|
293
261
|
export type ClientSideTimestampsStatus = (typeof ClientSideTimestampsStatus)[keyof typeof ClientSideTimestampsStatus];
|
|
294
262
|
/**
|
|
295
|
-
* <p>The client-side timestamp setting of the table.</p>
|
|
296
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/client-side-timestamps-how-it-works.html">How it works: Amazon Keyspaces client-side timestamps</a> in the <i>Amazon Keyspaces Developer
|
|
297
|
-
* Guide</i>.</p>
|
|
263
|
+
* <p>The client-side timestamp setting of the table.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/client-side-timestamps-how-it-works.html">How it works: Amazon Keyspaces client-side timestamps</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
298
264
|
* @public
|
|
299
265
|
*/
|
|
300
266
|
export interface ClientSideTimestamps {
|
|
@@ -343,8 +309,7 @@ export interface ColumnDefinition {
|
|
|
343
309
|
*/
|
|
344
310
|
name: string | undefined;
|
|
345
311
|
/**
|
|
346
|
-
* <p>The data type of the column. For a list of available data types, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types">Data types</a> in the <i>Amazon Keyspaces Developer
|
|
347
|
-
* Guide</i>.</p>
|
|
312
|
+
* <p>The data type of the column. For a list of available data types, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types">Data types</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
348
313
|
* @public
|
|
349
314
|
*/
|
|
350
315
|
type: string | undefined;
|
|
@@ -361,9 +326,7 @@ export interface Comment {
|
|
|
361
326
|
message: string | undefined;
|
|
362
327
|
}
|
|
363
328
|
/**
|
|
364
|
-
* <p>Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to
|
|
365
|
-
* perform an action and the same or a different action is already
|
|
366
|
-
* in progress, or if you try to create a resource that already exists. </p>
|
|
329
|
+
* <p>Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists. </p>
|
|
367
330
|
* @public
|
|
368
331
|
*/
|
|
369
332
|
export declare class ConflictException extends __BaseException {
|
|
@@ -387,60 +350,21 @@ export declare const Rs: {
|
|
|
387
350
|
*/
|
|
388
351
|
export type Rs = (typeof Rs)[keyof typeof Rs];
|
|
389
352
|
/**
|
|
390
|
-
* <p>
|
|
391
|
-
* The replication specification of the keyspace includes:</p>
|
|
392
|
-
* <ul>
|
|
393
|
-
* <li>
|
|
394
|
-
* <p>
|
|
395
|
-
* <code>regionList</code> - the Amazon Web Services Regions where the keyspace is replicated in.</p>
|
|
396
|
-
* </li>
|
|
397
|
-
* <li>
|
|
398
|
-
* <p>
|
|
399
|
-
* <code>replicationStrategy</code> - the required value is <code>SINGLE_REGION</code> or
|
|
400
|
-
* <code>MULTI_REGION</code>.</p>
|
|
401
|
-
* </li>
|
|
402
|
-
* </ul>
|
|
353
|
+
* <p> The replication specification of the keyspace includes:</p> <ul> <li> <p> <code>regionList</code> - the Amazon Web Services Regions where the keyspace is replicated in.</p> </li> <li> <p> <code>replicationStrategy</code> - the required value is <code>SINGLE_REGION</code> or <code>MULTI_REGION</code>.</p> </li> </ul>
|
|
403
354
|
* @public
|
|
404
355
|
*/
|
|
405
356
|
export interface ReplicationSpecification {
|
|
406
357
|
/**
|
|
407
|
-
* <p>
|
|
408
|
-
* The <code>replicationStrategy</code> of a keyspace, the required value is <code>SINGLE_REGION</code> or
|
|
409
|
-
* <code>MULTI_REGION</code>.
|
|
410
|
-
* </p>
|
|
358
|
+
* <p> The <code>replicationStrategy</code> of a keyspace, the required value is <code>SINGLE_REGION</code> or <code>MULTI_REGION</code>. </p>
|
|
411
359
|
* @public
|
|
412
360
|
*/
|
|
413
361
|
replicationStrategy: Rs | undefined;
|
|
414
362
|
/**
|
|
415
|
-
* <p>
|
|
416
|
-
* The <code>regionList</code> contains the Amazon Web Services Regions where the keyspace is replicated in.
|
|
417
|
-
* </p>
|
|
363
|
+
* <p> The <code>regionList</code> contains the Amazon Web Services Regions where the keyspace is replicated in. </p>
|
|
418
364
|
* @public
|
|
419
365
|
*/
|
|
420
366
|
regionList?: string[] | undefined;
|
|
421
367
|
}
|
|
422
|
-
/**
|
|
423
|
-
* <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>
|
|
424
|
-
* <p>Amazon Web Services-assigned tag names and values are automatically assigned the <code>aws:</code> prefix, which the user cannot assign.
|
|
425
|
-
* Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the
|
|
426
|
-
* prefix <code>user:</code> in the Cost Allocation Report. You cannot backdate the application of a tag.</p>
|
|
427
|
-
* <p>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
|
|
428
|
-
* Guide</i>.</p>
|
|
429
|
-
* @public
|
|
430
|
-
*/
|
|
431
|
-
export interface Tag {
|
|
432
|
-
/**
|
|
433
|
-
* <p>The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an
|
|
434
|
-
* existing tag (same key), the existing tag value will be updated to the new value.</p>
|
|
435
|
-
* @public
|
|
436
|
-
*/
|
|
437
|
-
key: string | undefined;
|
|
438
|
-
/**
|
|
439
|
-
* <p>The value of the tag. Tag values are case-sensitive and can be null.</p>
|
|
440
|
-
* @public
|
|
441
|
-
*/
|
|
442
|
-
value: string | undefined;
|
|
443
|
-
}
|
|
444
368
|
/**
|
|
445
369
|
* @public
|
|
446
370
|
*/
|
|
@@ -451,28 +375,12 @@ export interface CreateKeyspaceRequest {
|
|
|
451
375
|
*/
|
|
452
376
|
keyspaceName: string | undefined;
|
|
453
377
|
/**
|
|
454
|
-
* <p>A list of key-value pair tags to be attached to the keyspace.</p>
|
|
455
|
-
* <p>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
|
|
456
|
-
* Guide</i>.</p>
|
|
378
|
+
* <p>A list of key-value pair tags to be attached to the keyspace.</p> <p>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 Guide</i>.</p>
|
|
457
379
|
* @public
|
|
458
380
|
*/
|
|
459
381
|
tags?: Tag[] | undefined;
|
|
460
382
|
/**
|
|
461
|
-
* <p>
|
|
462
|
-
* The replication specification of the keyspace includes:</p>
|
|
463
|
-
* <ul>
|
|
464
|
-
* <li>
|
|
465
|
-
* <p>
|
|
466
|
-
* <code>replicationStrategy</code> - the required value is <code>SINGLE_REGION</code> or
|
|
467
|
-
* <code>MULTI_REGION</code>.</p>
|
|
468
|
-
* </li>
|
|
469
|
-
* <li>
|
|
470
|
-
* <p>
|
|
471
|
-
* <code>regionList</code> - if the <code>replicationStrategy</code> is <code>MULTI_REGION</code>, the
|
|
472
|
-
* <code>regionList</code> requires the current Region and at least one additional Amazon Web Services Region where
|
|
473
|
-
* the keyspace is going to be replicated in.</p>
|
|
474
|
-
* </li>
|
|
475
|
-
* </ul>
|
|
383
|
+
* <p> The replication specification of the keyspace includes:</p> <ul> <li> <p> <code>replicationStrategy</code> - the required value is <code>SINGLE_REGION</code> or <code>MULTI_REGION</code>.</p> </li> <li> <p> <code>regionList</code> - if the <code>replicationStrategy</code> is <code>MULTI_REGION</code>, the <code>regionList</code> requires the current Region and at least one additional Amazon Web Services Region where the keyspace is going to be replicated in.</p> </li> </ul>
|
|
476
384
|
* @public
|
|
477
385
|
*/
|
|
478
386
|
replicationSpecification?: ReplicationSpecification | undefined;
|
|
@@ -500,8 +408,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
500
408
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
501
409
|
}
|
|
502
410
|
/**
|
|
503
|
-
* <p>The operation exceeded the service quota for this resource.
|
|
504
|
-
* Guide</i>.</p>
|
|
411
|
+
* <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
505
412
|
* @public
|
|
506
413
|
*/
|
|
507
414
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
@@ -537,40 +444,12 @@ export declare const EncryptionType: {
|
|
|
537
444
|
*/
|
|
538
445
|
export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType];
|
|
539
446
|
/**
|
|
540
|
-
* <p>Amazon Keyspaces encrypts and decrypts the table data at rest transparently and integrates with Key Management Service for storing and managing the encryption key.
|
|
541
|
-
* You can choose one of the following KMS keys (KMS keys):</p>
|
|
542
|
-
* <ul>
|
|
543
|
-
* <li>
|
|
544
|
-
* <p>Amazon Web Services owned key - This is the default encryption type. The key is owned by Amazon Keyspaces (no additional charge). </p>
|
|
545
|
-
* </li>
|
|
546
|
-
* <li>
|
|
547
|
-
* <p>Customer managed key - This key is stored in your account and is created, owned, and managed by you. You have full control over the customer
|
|
548
|
-
* managed key (KMS charges apply).</p>
|
|
549
|
-
* </li>
|
|
550
|
-
* </ul>
|
|
551
|
-
* <p>For more information about encryption at rest in Amazon Keyspaces, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer
|
|
552
|
-
* Guide</i>.</p>
|
|
553
|
-
* <p>For more information about KMS, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">KMS management service concepts</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
447
|
+
* <p>Amazon Keyspaces encrypts and decrypts the table data at rest transparently and integrates with Key Management Service for storing and managing the encryption key. You can choose one of the following KMS keys (KMS keys):</p> <ul> <li> <p>Amazon Web Services owned key - This is the default encryption type. The key is owned by Amazon Keyspaces (no additional charge). </p> </li> <li> <p>Customer managed key - This key is stored in your account and is created, owned, and managed by you. You have full control over the customer managed key (KMS charges apply).</p> </li> </ul> <p>For more information about encryption at rest in Amazon Keyspaces, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>For more information about KMS, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">KMS management service concepts</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
554
448
|
* @public
|
|
555
449
|
*/
|
|
556
450
|
export interface EncryptionSpecification {
|
|
557
451
|
/**
|
|
558
|
-
* <p>The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):</p>
|
|
559
|
-
* <ul>
|
|
560
|
-
* <li>
|
|
561
|
-
* <p>
|
|
562
|
-
* <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p>
|
|
563
|
-
* </li>
|
|
564
|
-
* <li>
|
|
565
|
-
* <p>
|
|
566
|
-
* <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you.
|
|
567
|
-
* This option
|
|
568
|
-
* requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p>
|
|
569
|
-
* </li>
|
|
570
|
-
* </ul>
|
|
571
|
-
* <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>. </p>
|
|
572
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer
|
|
573
|
-
* Guide</i>.</p>
|
|
452
|
+
* <p>The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):</p> <ul> <li> <p> <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p> </li> <li> <p> <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p> </li> </ul> <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
574
453
|
* @public
|
|
575
454
|
*/
|
|
576
455
|
type: EncryptionType | undefined;
|
|
@@ -593,47 +472,18 @@ export declare const PointInTimeRecoveryStatus: {
|
|
|
593
472
|
*/
|
|
594
473
|
export type PointInTimeRecoveryStatus = (typeof PointInTimeRecoveryStatus)[keyof typeof PointInTimeRecoveryStatus];
|
|
595
474
|
/**
|
|
596
|
-
* <p>Point-in-time recovery (PITR) helps protect your Amazon Keyspaces tables from accidental write or delete operations by providing you continuous backups of your table data.</p>
|
|
597
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer
|
|
598
|
-
* Guide</i>.</p>
|
|
475
|
+
* <p>Point-in-time recovery (PITR) helps protect your Amazon Keyspaces tables from accidental write or delete operations by providing you continuous backups of your table data.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
599
476
|
* @public
|
|
600
477
|
*/
|
|
601
478
|
export interface PointInTimeRecovery {
|
|
602
479
|
/**
|
|
603
|
-
* <p>The options are:</p>
|
|
604
|
-
* <ul>
|
|
605
|
-
* <li>
|
|
606
|
-
* <p>
|
|
607
|
-
* <code>status=ENABLED</code>
|
|
608
|
-
* </p>
|
|
609
|
-
* </li>
|
|
610
|
-
* <li>
|
|
611
|
-
* <p>
|
|
612
|
-
* <code>status=DISABLED</code>
|
|
613
|
-
* </p>
|
|
614
|
-
* </li>
|
|
615
|
-
* </ul>
|
|
480
|
+
* <p>The options are:</p> <ul> <li> <p> <code>status=ENABLED</code> </p> </li> <li> <p> <code>status=DISABLED</code> </p> </li> </ul>
|
|
616
481
|
* @public
|
|
617
482
|
*/
|
|
618
483
|
status: PointInTimeRecoveryStatus | undefined;
|
|
619
484
|
}
|
|
620
485
|
/**
|
|
621
|
-
* <p>The Amazon Web Services Region specific settings of a multi-Region table.</p>
|
|
622
|
-
* <p>For a multi-Region table, you can configure the table's read capacity differently per Amazon Web Services Region. You can do this by configuring the following parameters.</p>
|
|
623
|
-
* <ul>
|
|
624
|
-
* <li>
|
|
625
|
-
* <p>
|
|
626
|
-
* <code>region</code>: The Region where these settings are applied. (Required)</p>
|
|
627
|
-
* </li>
|
|
628
|
-
* <li>
|
|
629
|
-
* <p>
|
|
630
|
-
* <code>readCapacityUnits</code>: The provisioned read capacity units. (Optional)</p>
|
|
631
|
-
* </li>
|
|
632
|
-
* <li>
|
|
633
|
-
* <p>
|
|
634
|
-
* <code>readCapacityAutoScaling</code>: The read capacity auto scaling settings for the table. (Optional)</p>
|
|
635
|
-
* </li>
|
|
636
|
-
* </ul>
|
|
486
|
+
* <p>The Amazon Web Services Region specific settings of a multi-Region table.</p> <p>For a multi-Region table, you can configure the table's read capacity differently per Amazon Web Services Region. You can do this by configuring the following parameters.</p> <ul> <li> <p> <code>region</code>: The Region where these settings are applied. (Required)</p> </li> <li> <p> <code>readCapacityUnits</code>: The provisioned read capacity units. (Optional)</p> </li> <li> <p> <code>readCapacityAutoScaling</code>: The read capacity auto scaling settings for the table. (Optional)</p> </li> </ul>
|
|
637
487
|
* @public
|
|
638
488
|
*/
|
|
639
489
|
export interface ReplicaSpecification {
|
|
@@ -648,16 +498,13 @@ export interface ReplicaSpecification {
|
|
|
648
498
|
*/
|
|
649
499
|
readCapacityUnits?: number | undefined;
|
|
650
500
|
/**
|
|
651
|
-
* <p>The read capacity auto scaling settings for the multi-Region
|
|
652
|
-
* table in the specified Amazon Web Services Region.</p>
|
|
501
|
+
* <p>The read capacity auto scaling settings for the multi-Region table in the specified Amazon Web Services Region.</p>
|
|
653
502
|
* @public
|
|
654
503
|
*/
|
|
655
504
|
readCapacityAutoScaling?: AutoScalingSettings | undefined;
|
|
656
505
|
}
|
|
657
506
|
/**
|
|
658
|
-
* <p>The partition key portion of the primary key is required
|
|
659
|
-
* and determines how Amazon Keyspaces stores the data.
|
|
660
|
-
* The partition key can be a single column, or it can be a compound value composed of two or more columns.</p>
|
|
507
|
+
* <p>The partition key portion of the primary key is required and determines how Amazon Keyspaces stores the data. The partition key can be a single column, or it can be a compound value composed of two or more columns.</p>
|
|
661
508
|
* @public
|
|
662
509
|
*/
|
|
663
510
|
export interface PartitionKey {
|
|
@@ -716,9 +563,7 @@ export declare const TimeToLiveStatus: {
|
|
|
716
563
|
*/
|
|
717
564
|
export type TimeToLiveStatus = (typeof TimeToLiveStatus)[keyof typeof TimeToLiveStatus];
|
|
718
565
|
/**
|
|
719
|
-
* <p>Enable custom Time to Live (TTL) settings for rows and columns without setting a TTL default for the specified table.</p>
|
|
720
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_enabling">Enabling TTL on tables</a> in the <i>Amazon Keyspaces Developer
|
|
721
|
-
* Guide</i>.</p>
|
|
566
|
+
* <p>Enable custom Time to Live (TTL) settings for rows and columns without setting a TTL default for the specified table.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_enabling">Enabling TTL on tables</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
722
567
|
* @public
|
|
723
568
|
*/
|
|
724
569
|
export interface TimeToLive {
|
|
@@ -743,64 +588,7 @@ export interface CreateTableRequest {
|
|
|
743
588
|
*/
|
|
744
589
|
tableName: string | undefined;
|
|
745
590
|
/**
|
|
746
|
-
* <p>The <code>schemaDefinition</code> consists of the
|
|
747
|
-
* following parameters.</p>
|
|
748
|
-
* <p>For each column to be created:</p>
|
|
749
|
-
* <ul>
|
|
750
|
-
* <li>
|
|
751
|
-
* <p>
|
|
752
|
-
* <code>name</code> - The name
|
|
753
|
-
* of the column.</p>
|
|
754
|
-
* </li>
|
|
755
|
-
* <li>
|
|
756
|
-
* <p>
|
|
757
|
-
* <code>type</code> - An Amazon Keyspaces
|
|
758
|
-
* data type. For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types">Data types</a> in the <i>Amazon Keyspaces Developer
|
|
759
|
-
* Guide</i>.</p>
|
|
760
|
-
* </li>
|
|
761
|
-
* </ul>
|
|
762
|
-
* <p>The primary key of the table consists of the
|
|
763
|
-
* following columns:</p>
|
|
764
|
-
* <ul>
|
|
765
|
-
* <li>
|
|
766
|
-
* <p>
|
|
767
|
-
* <code>partitionKeys</code> - The partition key can be a single column, or it can be a
|
|
768
|
-
* compound value composed of two or more columns. The partition
|
|
769
|
-
* key portion of the primary key is required and determines how
|
|
770
|
-
* Amazon Keyspaces stores your data.</p>
|
|
771
|
-
* </li>
|
|
772
|
-
* <li>
|
|
773
|
-
* <p>
|
|
774
|
-
* <code>name</code> - The name of each partition key column.</p>
|
|
775
|
-
* </li>
|
|
776
|
-
* <li>
|
|
777
|
-
* <p>
|
|
778
|
-
* <code>clusteringKeys</code> - The optional clustering column portion of your primary key
|
|
779
|
-
* determines how the data is clustered and sorted within each
|
|
780
|
-
* partition.</p>
|
|
781
|
-
* </li>
|
|
782
|
-
* <li>
|
|
783
|
-
* <p>
|
|
784
|
-
* <code>name</code> - The name of the clustering column. </p>
|
|
785
|
-
* </li>
|
|
786
|
-
* <li>
|
|
787
|
-
* <p>
|
|
788
|
-
* <code>orderBy</code> - Sets the
|
|
789
|
-
* ascendant (<code>ASC</code>) or descendant (<code>DESC</code>) order modifier.</p>
|
|
790
|
-
* <p>To define a column as static use <code>staticColumns</code> -
|
|
791
|
-
* Static columns store values that are shared by all rows in the same partition:</p>
|
|
792
|
-
* </li>
|
|
793
|
-
* <li>
|
|
794
|
-
* <p>
|
|
795
|
-
* <code>name</code> - The name
|
|
796
|
-
* of the column.</p>
|
|
797
|
-
* </li>
|
|
798
|
-
* <li>
|
|
799
|
-
* <p>
|
|
800
|
-
* <code>type</code> - An Amazon Keyspaces
|
|
801
|
-
* data type.</p>
|
|
802
|
-
* </li>
|
|
803
|
-
* </ul>
|
|
591
|
+
* <p>The <code>schemaDefinition</code> consists of the following parameters.</p> <p>For each column to be created:</p> <ul> <li> <p> <code>name</code> - The name of the column.</p> </li> <li> <p> <code>type</code> - An Amazon Keyspaces data type. For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types">Data types</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> </li> </ul> <p>The primary key of the table consists of the following columns:</p> <ul> <li> <p> <code>partitionKeys</code> - The partition key can be a single column, or it can be a compound value composed of two or more columns. The partition key portion of the primary key is required and determines how Amazon Keyspaces stores your data.</p> </li> <li> <p> <code>name</code> - The name of each partition key column.</p> </li> <li> <p> <code>clusteringKeys</code> - The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.</p> </li> <li> <p> <code>name</code> - The name of the clustering column. </p> </li> <li> <p> <code>orderBy</code> - Sets the ascendant (<code>ASC</code>) or descendant (<code>DESC</code>) order modifier.</p> <p>To define a column as static use <code>staticColumns</code> - Static columns store values that are shared by all rows in the same partition:</p> </li> <li> <p> <code>name</code> - The name of the column.</p> </li> <li> <p> <code>type</code> - An Amazon Keyspaces data type.</p> </li> </ul>
|
|
804
592
|
* @public
|
|
805
593
|
*/
|
|
806
594
|
schemaDefinition: SchemaDefinition | undefined;
|
|
@@ -810,155 +598,55 @@ export interface CreateTableRequest {
|
|
|
810
598
|
*/
|
|
811
599
|
comment?: Comment | undefined;
|
|
812
600
|
/**
|
|
813
|
-
* <p>Specifies the read/write throughput capacity mode for the table. The options are:</p>
|
|
814
|
-
* <ul>
|
|
815
|
-
* <li>
|
|
816
|
-
* <p>
|
|
817
|
-
* <code>throughputMode:PAY_PER_REQUEST</code> and </p>
|
|
818
|
-
* </li>
|
|
819
|
-
* <li>
|
|
820
|
-
* <p>
|
|
821
|
-
* <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires
|
|
822
|
-
* <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p>
|
|
823
|
-
* </li>
|
|
824
|
-
* </ul>
|
|
825
|
-
* <p>The default is
|
|
826
|
-
* <code>throughput_mode:PAY_PER_REQUEST</code>.</p>
|
|
827
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
828
|
-
* Guide</i>.</p>
|
|
601
|
+
* <p>Specifies the read/write throughput capacity mode for the table. The options are:</p> <ul> <li> <p> <code>throughputMode:PAY_PER_REQUEST</code> and </p> </li> <li> <p> <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p> </li> </ul> <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
829
602
|
* @public
|
|
830
603
|
*/
|
|
831
604
|
capacitySpecification?: CapacitySpecification | undefined;
|
|
832
605
|
/**
|
|
833
|
-
* <p>Specifies how the encryption key for encryption at rest is managed for the table.
|
|
834
|
-
* You can choose one of the following KMS key (KMS key):</p>
|
|
835
|
-
* <ul>
|
|
836
|
-
* <li>
|
|
837
|
-
* <p>
|
|
838
|
-
* <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p>
|
|
839
|
-
* </li>
|
|
840
|
-
* <li>
|
|
841
|
-
* <p>
|
|
842
|
-
* <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you.
|
|
843
|
-
* This option
|
|
844
|
-
* requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input.</p>
|
|
845
|
-
* </li>
|
|
846
|
-
* </ul>
|
|
847
|
-
* <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>.</p>
|
|
848
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer
|
|
849
|
-
* Guide</i>.</p>
|
|
606
|
+
* <p>Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of the following KMS key (KMS key):</p> <ul> <li> <p> <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p> </li> <li> <p> <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input.</p> </li> </ul> <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
850
607
|
* @public
|
|
851
608
|
*/
|
|
852
609
|
encryptionSpecification?: EncryptionSpecification | undefined;
|
|
853
610
|
/**
|
|
854
|
-
* <p>Specifies if <code>pointInTimeRecovery</code> is enabled or disabled for the
|
|
855
|
-
* table. The options are:</p>
|
|
856
|
-
* <ul>
|
|
857
|
-
* <li>
|
|
858
|
-
* <p>
|
|
859
|
-
* <code>status=ENABLED</code>
|
|
860
|
-
* </p>
|
|
861
|
-
* </li>
|
|
862
|
-
* <li>
|
|
863
|
-
* <p>
|
|
864
|
-
* <code>status=DISABLED</code>
|
|
865
|
-
* </p>
|
|
866
|
-
* </li>
|
|
867
|
-
* </ul>
|
|
868
|
-
* <p>If it's not specified, the
|
|
869
|
-
* default is <code>status=DISABLED</code>.</p>
|
|
870
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer
|
|
871
|
-
* Guide</i>.</p>
|
|
611
|
+
* <p>Specifies if <code>pointInTimeRecovery</code> is enabled or disabled for the table. The options are:</p> <ul> <li> <p> <code>status=ENABLED</code> </p> </li> <li> <p> <code>status=DISABLED</code> </p> </li> </ul> <p>If it's not specified, the default is <code>status=DISABLED</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
872
612
|
* @public
|
|
873
613
|
*/
|
|
874
614
|
pointInTimeRecovery?: PointInTimeRecovery | undefined;
|
|
875
615
|
/**
|
|
876
|
-
* <p>Enables Time to Live custom settings for the
|
|
877
|
-
* table. The options are:</p>
|
|
878
|
-
* <ul>
|
|
879
|
-
* <li>
|
|
880
|
-
* <p>
|
|
881
|
-
* <code>status:enabled</code>
|
|
882
|
-
* </p>
|
|
883
|
-
* </li>
|
|
884
|
-
* <li>
|
|
885
|
-
* <p>
|
|
886
|
-
* <code>status:disabled</code>
|
|
887
|
-
* </p>
|
|
888
|
-
* </li>
|
|
889
|
-
* </ul>
|
|
890
|
-
* <p>The default is <code>status:disabled</code>. After
|
|
891
|
-
* <code>ttl</code> is enabled, you can't disable it
|
|
892
|
-
* for the table.</p>
|
|
893
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html">Expiring data by using Amazon Keyspaces Time to Live (TTL)</a> in the <i>Amazon Keyspaces Developer
|
|
894
|
-
* Guide</i>.</p>
|
|
616
|
+
* <p>Enables Time to Live custom settings for the table. The options are:</p> <ul> <li> <p> <code>status:enabled</code> </p> </li> <li> <p> <code>status:disabled</code> </p> </li> </ul> <p>The default is <code>status:disabled</code>. After <code>ttl</code> is enabled, you can't disable it for the table.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html">Expiring data by using Amazon Keyspaces Time to Live (TTL)</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
895
617
|
* @public
|
|
896
618
|
*/
|
|
897
619
|
ttl?: TimeToLive | undefined;
|
|
898
620
|
/**
|
|
899
|
-
* <p>The default Time to Live setting in seconds for the
|
|
900
|
-
* table.</p>
|
|
901
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl">Setting the default TTL value for a table</a> in the <i>Amazon Keyspaces Developer
|
|
902
|
-
* Guide</i>.</p>
|
|
621
|
+
* <p>The default Time to Live setting in seconds for the table.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl">Setting the default TTL value for a table</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
903
622
|
* @public
|
|
904
623
|
*/
|
|
905
624
|
defaultTimeToLive?: number | undefined;
|
|
906
625
|
/**
|
|
907
|
-
* <p>A list of key-value pair tags to be
|
|
908
|
-
* attached to the resource. </p>
|
|
909
|
-
* <p>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
|
|
910
|
-
* Guide</i>.</p>
|
|
626
|
+
* <p>A list of key-value pair tags to be attached to the resource. </p> <p>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 Guide</i>.</p>
|
|
911
627
|
* @public
|
|
912
628
|
*/
|
|
913
629
|
tags?: Tag[] | undefined;
|
|
914
630
|
/**
|
|
915
|
-
* <p>
|
|
916
|
-
* Enables client-side timestamps for the table. By default, the setting is disabled. You can enable
|
|
917
|
-
* client-side timestamps with the following option:</p>
|
|
918
|
-
* <ul>
|
|
919
|
-
* <li>
|
|
920
|
-
* <p>
|
|
921
|
-
* <code>status: "enabled"</code>
|
|
922
|
-
* </p>
|
|
923
|
-
* </li>
|
|
924
|
-
* </ul>
|
|
925
|
-
* <p>Once client-side timestamps are enabled for a table, this setting cannot be disabled.</p>
|
|
631
|
+
* <p> Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option:</p> <ul> <li> <p> <code>status: "enabled"</code> </p> </li> </ul> <p>Once client-side timestamps are enabled for a table, this setting cannot be disabled.</p>
|
|
926
632
|
* @public
|
|
927
633
|
*/
|
|
928
634
|
clientSideTimestamps?: ClientSideTimestamps | undefined;
|
|
929
635
|
/**
|
|
930
|
-
* <p>The optional auto scaling settings for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity
|
|
931
|
-
* automatically on your behalf.</p>
|
|
932
|
-
* <p>Auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing
|
|
933
|
-
* your table's read and write capacity automatically in response to application traffic. For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer
|
|
934
|
-
* Guide</i>.</p>
|
|
935
|
-
* <p>By default, auto scaling is disabled for a table. </p>
|
|
636
|
+
* <p>The optional auto scaling settings for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity automatically on your behalf.</p> <p>Auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>By default, auto scaling is disabled for a table. </p>
|
|
936
637
|
* @public
|
|
937
638
|
*/
|
|
938
639
|
autoScalingSpecification?: AutoScalingSpecification | undefined;
|
|
939
640
|
/**
|
|
940
|
-
* <p>The optional Amazon Web Services Region specific settings of a multi-Region table.
|
|
941
|
-
* These settings overwrite the general settings of the table for the specified Region. </p>
|
|
942
|
-
* <p>For a multi-Region table in provisioned capacity mode, you can configure the table's read capacity differently for each Region's replica. The write capacity, however,
|
|
943
|
-
* remains synchronized between all replicas to ensure that there's enough capacity to replicate writes across all Regions. To define the read capacity for a table
|
|
944
|
-
* replica in a specific Region, you can do so by configuring the following parameters.</p>
|
|
945
|
-
* <ul>
|
|
946
|
-
* <li>
|
|
947
|
-
* <p>
|
|
948
|
-
* <code>region</code>: The Region where these settings are applied. (Required)</p>
|
|
949
|
-
* </li>
|
|
950
|
-
* <li>
|
|
951
|
-
* <p>
|
|
952
|
-
* <code>readCapacityUnits</code>: The provisioned read capacity units. (Optional)</p>
|
|
953
|
-
* </li>
|
|
954
|
-
* <li>
|
|
955
|
-
* <p>
|
|
956
|
-
* <code>readCapacityAutoScaling</code>: The read capacity auto scaling settings for the table. (Optional) </p>
|
|
957
|
-
* </li>
|
|
958
|
-
* </ul>
|
|
641
|
+
* <p>The optional Amazon Web Services Region specific settings of a multi-Region table. These settings overwrite the general settings of the table for the specified Region. </p> <p>For a multi-Region table in provisioned capacity mode, you can configure the table's read capacity differently for each Region's replica. The write capacity, however, remains synchronized between all replicas to ensure that there's enough capacity to replicate writes across all Regions. To define the read capacity for a table replica in a specific Region, you can do so by configuring the following parameters.</p> <ul> <li> <p> <code>region</code>: The Region where these settings are applied. (Required)</p> </li> <li> <p> <code>readCapacityUnits</code>: The provisioned read capacity units. (Optional)</p> </li> <li> <p> <code>readCapacityAutoScaling</code>: The read capacity auto scaling settings for the table. (Optional) </p> </li> </ul>
|
|
959
642
|
* @public
|
|
960
643
|
*/
|
|
961
644
|
replicaSpecifications?: ReplicaSpecification[] | undefined;
|
|
645
|
+
/**
|
|
646
|
+
* <p>The CDC stream settings of the table.</p>
|
|
647
|
+
* @public
|
|
648
|
+
*/
|
|
649
|
+
cdcSpecification?: CdcSpecification | undefined;
|
|
962
650
|
}
|
|
963
651
|
/**
|
|
964
652
|
* @public
|
|
@@ -971,8 +659,7 @@ export interface CreateTableResponse {
|
|
|
971
659
|
resourceArn: string | undefined;
|
|
972
660
|
}
|
|
973
661
|
/**
|
|
974
|
-
* <p>The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly,
|
|
975
|
-
* or its status might not be <code>ACTIVE</code>.</p>
|
|
662
|
+
* <p>The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
|
|
976
663
|
* @public
|
|
977
664
|
*/
|
|
978
665
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
@@ -989,26 +676,17 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
989
676
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
990
677
|
}
|
|
991
678
|
/**
|
|
992
|
-
* <p>
|
|
993
|
-
* A field definition consists out of a name and a type.
|
|
994
|
-
* </p>
|
|
679
|
+
* <p> A field definition consists out of a name and a type. </p>
|
|
995
680
|
* @public
|
|
996
681
|
*/
|
|
997
682
|
export interface FieldDefinition {
|
|
998
683
|
/**
|
|
999
|
-
* <p>
|
|
1000
|
-
* The identifier.
|
|
1001
|
-
* </p>
|
|
684
|
+
* <p> The identifier. </p>
|
|
1002
685
|
* @public
|
|
1003
686
|
*/
|
|
1004
687
|
name: string | undefined;
|
|
1005
688
|
/**
|
|
1006
|
-
* <p>
|
|
1007
|
-
* Any supported Cassandra data type, including collections and other user-defined types that are
|
|
1008
|
-
* contained in the same keyspace.
|
|
1009
|
-
* </p>
|
|
1010
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html#cassandra-data-type">Cassandra data type support</a> in the <i>Amazon Keyspaces Developer
|
|
1011
|
-
* Guide</i>.</p>
|
|
689
|
+
* <p> Any supported Cassandra data type, including collections and other user-defined types that are contained in the same keyspace. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html#cassandra-data-type">Cassandra data type support</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
1012
690
|
* @public
|
|
1013
691
|
*/
|
|
1014
692
|
type: string | undefined;
|
|
@@ -1018,31 +696,17 @@ export interface FieldDefinition {
|
|
|
1018
696
|
*/
|
|
1019
697
|
export interface CreateTypeRequest {
|
|
1020
698
|
/**
|
|
1021
|
-
* <p>
|
|
1022
|
-
* The name of the keyspace.
|
|
1023
|
-
* </p>
|
|
699
|
+
* <p> The name of the keyspace. </p>
|
|
1024
700
|
* @public
|
|
1025
701
|
*/
|
|
1026
702
|
keyspaceName: string | undefined;
|
|
1027
703
|
/**
|
|
1028
|
-
* <p>
|
|
1029
|
-
* The name of the user-defined type.
|
|
1030
|
-
* </p>
|
|
1031
|
-
* <p>UDT names must contain 48 characters or less, must begin with an alphabetic character, and
|
|
1032
|
-
* can only contain alpha-numeric characters and underscores. Amazon Keyspaces converts upper case characters automatically
|
|
1033
|
-
* into lower case characters. </p>
|
|
1034
|
-
* <p>Alternatively, you can declare a UDT name in double quotes. When declaring a UDT name inside double quotes,
|
|
1035
|
-
* Amazon Keyspaces preserves upper casing and allows special characters.</p>
|
|
1036
|
-
* <p>You can also use double quotes as part of the
|
|
1037
|
-
* name when you create the UDT, but you must escape each double quote character with an additional
|
|
1038
|
-
* double quote character.</p>
|
|
704
|
+
* <p> The name of the user-defined type. </p> <p>UDT names must contain 48 characters or less, must begin with an alphabetic character, and can only contain alpha-numeric characters and underscores. Amazon Keyspaces converts upper case characters automatically into lower case characters. </p> <p>Alternatively, you can declare a UDT name in double quotes. When declaring a UDT name inside double quotes, Amazon Keyspaces preserves upper casing and allows special characters.</p> <p>You can also use double quotes as part of the name when you create the UDT, but you must escape each double quote character with an additional double quote character.</p>
|
|
1039
705
|
* @public
|
|
1040
706
|
*/
|
|
1041
707
|
typeName: string | undefined;
|
|
1042
708
|
/**
|
|
1043
|
-
* <p>
|
|
1044
|
-
* The field definitions, consisting of names and types, that define this type.
|
|
1045
|
-
* </p>
|
|
709
|
+
* <p> The field definitions, consisting of names and types, that define this type. </p>
|
|
1046
710
|
* @public
|
|
1047
711
|
*/
|
|
1048
712
|
fieldDefinitions: FieldDefinition[] | undefined;
|
|
@@ -1052,17 +716,12 @@ export interface CreateTypeRequest {
|
|
|
1052
716
|
*/
|
|
1053
717
|
export interface CreateTypeResponse {
|
|
1054
718
|
/**
|
|
1055
|
-
* <p>
|
|
1056
|
-
* The unique identifier of the keyspace that contains the new type in the format of an Amazon Resource Name (ARN).
|
|
1057
|
-
* </p>
|
|
719
|
+
* <p> The unique identifier of the keyspace that contains the new type in the format of an Amazon Resource Name (ARN). </p>
|
|
1058
720
|
* @public
|
|
1059
721
|
*/
|
|
1060
722
|
keyspaceArn: string | undefined;
|
|
1061
723
|
/**
|
|
1062
|
-
* <p>
|
|
1063
|
-
* The formatted name of the user-defined type that was created. Note that Amazon Keyspaces requires the formatted name of the type for
|
|
1064
|
-
* other operations, for example <code>GetType</code>.
|
|
1065
|
-
* </p>
|
|
724
|
+
* <p> The formatted name of the user-defined type that was created. Note that Amazon Keyspaces requires the formatted name of the type for other operations, for example <code>GetType</code>. </p>
|
|
1066
725
|
* @public
|
|
1067
726
|
*/
|
|
1068
727
|
typeName: string | undefined;
|
|
@@ -1107,16 +766,12 @@ export interface DeleteTableResponse {
|
|
|
1107
766
|
*/
|
|
1108
767
|
export interface DeleteTypeRequest {
|
|
1109
768
|
/**
|
|
1110
|
-
* <p>
|
|
1111
|
-
* The name of the keyspace of the to be deleted type.
|
|
1112
|
-
* </p>
|
|
769
|
+
* <p> The name of the keyspace of the to be deleted type. </p>
|
|
1113
770
|
* @public
|
|
1114
771
|
*/
|
|
1115
772
|
keyspaceName: string | undefined;
|
|
1116
773
|
/**
|
|
1117
|
-
* <p>
|
|
1118
|
-
* The name of the type to be deleted.
|
|
1119
|
-
* </p>
|
|
774
|
+
* <p> The name of the type to be deleted. </p>
|
|
1120
775
|
* @public
|
|
1121
776
|
*/
|
|
1122
777
|
typeName: string | undefined;
|
|
@@ -1126,16 +781,12 @@ export interface DeleteTypeRequest {
|
|
|
1126
781
|
*/
|
|
1127
782
|
export interface DeleteTypeResponse {
|
|
1128
783
|
/**
|
|
1129
|
-
* <p>
|
|
1130
|
-
* The unique identifier of the keyspace from which the type was deleted in the format of an Amazon Resource Name (ARN).
|
|
1131
|
-
* </p>
|
|
784
|
+
* <p> The unique identifier of the keyspace from which the type was deleted in the format of an Amazon Resource Name (ARN). </p>
|
|
1132
785
|
* @public
|
|
1133
786
|
*/
|
|
1134
787
|
keyspaceArn: string | undefined;
|
|
1135
788
|
/**
|
|
1136
|
-
* <p>
|
|
1137
|
-
* The name of the type that was deleted.
|
|
1138
|
-
* </p>
|
|
789
|
+
* <p> The name of the type that was deleted. </p>
|
|
1139
790
|
* @public
|
|
1140
791
|
*/
|
|
1141
792
|
typeName: string | undefined;
|
|
@@ -1165,31 +816,22 @@ export declare const KeyspaceStatus: {
|
|
|
1165
816
|
*/
|
|
1166
817
|
export type KeyspaceStatus = (typeof KeyspaceStatus)[keyof typeof KeyspaceStatus];
|
|
1167
818
|
/**
|
|
1168
|
-
* <p>
|
|
1169
|
-
* This shows the summary status of the keyspace after a new Amazon Web Services Region was added.
|
|
1170
|
-
* </p>
|
|
819
|
+
* <p> This shows the summary status of the keyspace after a new Amazon Web Services Region was added. </p>
|
|
1171
820
|
* @public
|
|
1172
821
|
*/
|
|
1173
822
|
export interface ReplicationGroupStatus {
|
|
1174
823
|
/**
|
|
1175
|
-
* <p>
|
|
1176
|
-
* The name of the Region that was added to the keyspace.
|
|
1177
|
-
* </p>
|
|
824
|
+
* <p> The name of the Region that was added to the keyspace. </p>
|
|
1178
825
|
* @public
|
|
1179
826
|
*/
|
|
1180
827
|
region: string | undefined;
|
|
1181
828
|
/**
|
|
1182
|
-
* <p>
|
|
1183
|
-
* The status of the keyspace.
|
|
1184
|
-
* </p>
|
|
829
|
+
* <p> The status of the keyspace. </p>
|
|
1185
830
|
* @public
|
|
1186
831
|
*/
|
|
1187
832
|
keyspaceStatus: KeyspaceStatus | undefined;
|
|
1188
833
|
/**
|
|
1189
|
-
* <p>
|
|
1190
|
-
* This shows the replication progress of tables in the keyspace. The value is expressed as a percentage of the newly replicated tables
|
|
1191
|
-
* with status <code>Active</code> compared to the total number of tables in the keyspace.
|
|
1192
|
-
* </p>
|
|
834
|
+
* <p> This shows the replication progress of tables in the keyspace. The value is expressed as a percentage of the newly replicated tables with status <code>Active</code> compared to the total number of tables in the keyspace. </p>
|
|
1193
835
|
* @public
|
|
1194
836
|
*/
|
|
1195
837
|
tablesReplicationProgress?: string | undefined;
|
|
@@ -1209,23 +851,17 @@ export interface GetKeyspaceResponse {
|
|
|
1209
851
|
*/
|
|
1210
852
|
resourceArn: string | undefined;
|
|
1211
853
|
/**
|
|
1212
|
-
* <p>
|
|
1213
|
-
* Returns the replication strategy of the keyspace. The options are <code>SINGLE_REGION</code> or <code>MULTI_REGION</code>.
|
|
1214
|
-
* </p>
|
|
854
|
+
* <p> Returns the replication strategy of the keyspace. The options are <code>SINGLE_REGION</code> or <code>MULTI_REGION</code>. </p>
|
|
1215
855
|
* @public
|
|
1216
856
|
*/
|
|
1217
857
|
replicationStrategy: Rs | undefined;
|
|
1218
858
|
/**
|
|
1219
|
-
* <p>
|
|
1220
|
-
* If the <code>replicationStrategy</code> of the keyspace is <code>MULTI_REGION</code>, a list of replication Regions is returned.
|
|
1221
|
-
* </p>
|
|
859
|
+
* <p> If the <code>replicationStrategy</code> of the keyspace is <code>MULTI_REGION</code>, a list of replication Regions is returned. </p>
|
|
1222
860
|
* @public
|
|
1223
861
|
*/
|
|
1224
862
|
replicationRegions?: string[] | undefined;
|
|
1225
863
|
/**
|
|
1226
|
-
* <p>
|
|
1227
|
-
* A list of all Regions the keyspace is replicated in after the update keyspace operation and their status.
|
|
1228
|
-
* </p>
|
|
864
|
+
* <p> A list of all Regions the keyspace is replicated in after the update keyspace operation and their status. </p>
|
|
1229
865
|
* @public
|
|
1230
866
|
*/
|
|
1231
867
|
replicationGroupStatuses?: ReplicationGroupStatus[] | undefined;
|
|
@@ -1279,11 +915,7 @@ export declare const TableStatus: {
|
|
|
1279
915
|
*/
|
|
1280
916
|
export type TableStatus = (typeof TableStatus)[keyof typeof TableStatus];
|
|
1281
917
|
/**
|
|
1282
|
-
* <p>The Region-specific settings of a multi-Region table in the specified Amazon Web Services Region.</p>
|
|
1283
|
-
* <p>If the multi-Region table is using provisioned capacity and has optional auto scaling policies configured, note that
|
|
1284
|
-
* the Region specific summary returns both read and write capacity settings. But only Region specific read capacity settings can be configured for a
|
|
1285
|
-
* multi-Region table. In a multi-Region table, your write capacity units will be synced across all Amazon Web Services Regions to ensure that there is enough
|
|
1286
|
-
* capacity to replicate write events across Regions.</p>
|
|
918
|
+
* <p>The Region-specific settings of a multi-Region table in the specified Amazon Web Services Region.</p> <p>If the multi-Region table is using provisioned capacity and has optional auto scaling policies configured, note that the Region specific summary returns both read and write capacity settings. But only Region specific read capacity settings can be configured for a multi-Region table. In a multi-Region table, your write capacity units will be synced across all Amazon Web Services Regions to ensure that there is enough capacity to replicate write events across Regions.</p>
|
|
1287
919
|
* @public
|
|
1288
920
|
*/
|
|
1289
921
|
export interface ReplicaSpecificationSummary {
|
|
@@ -1298,19 +930,7 @@ export interface ReplicaSpecificationSummary {
|
|
|
1298
930
|
*/
|
|
1299
931
|
status?: TableStatus | undefined;
|
|
1300
932
|
/**
|
|
1301
|
-
* <p>The read/write throughput capacity mode for a table. The options are:</p>
|
|
1302
|
-
* <ul>
|
|
1303
|
-
* <li>
|
|
1304
|
-
* <p>
|
|
1305
|
-
* <code>throughputMode:PAY_PER_REQUEST</code> and </p>
|
|
1306
|
-
* </li>
|
|
1307
|
-
* <li>
|
|
1308
|
-
* <p>
|
|
1309
|
-
* <code>throughputMode:PROVISIONED</code>.</p>
|
|
1310
|
-
* </li>
|
|
1311
|
-
* </ul>
|
|
1312
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
1313
|
-
* Guide</i>.</p>
|
|
933
|
+
* <p>The read/write throughput capacity mode for a table. The options are:</p> <ul> <li> <p> <code>throughputMode:PAY_PER_REQUEST</code> and </p> </li> <li> <p> <code>throughputMode:PROVISIONED</code>.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
1314
934
|
* @public
|
|
1315
935
|
*/
|
|
1316
936
|
capacitySpecification?: CapacitySpecificationSummary | undefined;
|
|
@@ -1350,19 +970,7 @@ export interface GetTableResponse {
|
|
|
1350
970
|
*/
|
|
1351
971
|
schemaDefinition?: SchemaDefinition | undefined;
|
|
1352
972
|
/**
|
|
1353
|
-
* <p>The read/write throughput capacity mode for a table. The options are:</p>
|
|
1354
|
-
* <ul>
|
|
1355
|
-
* <li>
|
|
1356
|
-
* <p>
|
|
1357
|
-
* <code>throughputMode:PAY_PER_REQUEST</code>
|
|
1358
|
-
* </p>
|
|
1359
|
-
* </li>
|
|
1360
|
-
* <li>
|
|
1361
|
-
* <p>
|
|
1362
|
-
* <code>throughputMode:PROVISIONED</code>
|
|
1363
|
-
* </p>
|
|
1364
|
-
* </li>
|
|
1365
|
-
* </ul>
|
|
973
|
+
* <p>The read/write throughput capacity mode for a table. The options are:</p> <ul> <li> <p> <code>throughputMode:PAY_PER_REQUEST</code> </p> </li> <li> <p> <code>throughputMode:PROVISIONED</code> </p> </li> </ul>
|
|
1366
974
|
* @public
|
|
1367
975
|
*/
|
|
1368
976
|
capacitySpecification?: CapacitySpecificationSummary | undefined;
|
|
@@ -1392,8 +1000,7 @@ export interface GetTableResponse {
|
|
|
1392
1000
|
*/
|
|
1393
1001
|
comment?: Comment | undefined;
|
|
1394
1002
|
/**
|
|
1395
|
-
* <p>
|
|
1396
|
-
* The client-side timestamps setting of the table.</p>
|
|
1003
|
+
* <p> The client-side timestamps setting of the table.</p>
|
|
1397
1004
|
* @public
|
|
1398
1005
|
*/
|
|
1399
1006
|
clientSideTimestamps?: ClientSideTimestamps | undefined;
|
|
@@ -1402,6 +1009,16 @@ export interface GetTableResponse {
|
|
|
1402
1009
|
* @public
|
|
1403
1010
|
*/
|
|
1404
1011
|
replicaSpecifications?: ReplicaSpecificationSummary[] | undefined;
|
|
1012
|
+
/**
|
|
1013
|
+
* <p>The Amazon Resource Name (ARN) of the stream.</p>
|
|
1014
|
+
* @public
|
|
1015
|
+
*/
|
|
1016
|
+
latestStreamArn?: string | undefined;
|
|
1017
|
+
/**
|
|
1018
|
+
* <p>The CDC stream settings of the table.</p>
|
|
1019
|
+
* @public
|
|
1020
|
+
*/
|
|
1021
|
+
cdcSpecification?: CdcSpecificationSummary | undefined;
|
|
1405
1022
|
}
|
|
1406
1023
|
/**
|
|
1407
1024
|
* @public
|
|
@@ -1469,16 +1086,12 @@ export interface GetTableAutoScalingSettingsResponse {
|
|
|
1469
1086
|
*/
|
|
1470
1087
|
export interface GetTypeRequest {
|
|
1471
1088
|
/**
|
|
1472
|
-
* <p>
|
|
1473
|
-
* The name of the keyspace that contains this type.
|
|
1474
|
-
* </p>
|
|
1089
|
+
* <p> The name of the keyspace that contains this type. </p>
|
|
1475
1090
|
* @public
|
|
1476
1091
|
*/
|
|
1477
1092
|
keyspaceName: string | undefined;
|
|
1478
1093
|
/**
|
|
1479
|
-
* <p>The formatted name of the type. For example, if the name of the type was created
|
|
1480
|
-
* without double quotes, Amazon Keyspaces saved the name in lower-case characters. If the name was
|
|
1481
|
-
* created in double quotes, you must use double quotes to specify the type name. </p>
|
|
1094
|
+
* <p>The formatted name of the type. For example, if the name of the type was created without double quotes, Amazon Keyspaces saved the name in lower-case characters. If the name was created in double quotes, you must use double quotes to specify the type name. </p>
|
|
1482
1095
|
* @public
|
|
1483
1096
|
*/
|
|
1484
1097
|
typeName: string | undefined;
|
|
@@ -1502,65 +1115,47 @@ export type TypeStatus = (typeof TypeStatus)[keyof typeof TypeStatus];
|
|
|
1502
1115
|
*/
|
|
1503
1116
|
export interface GetTypeResponse {
|
|
1504
1117
|
/**
|
|
1505
|
-
* <p>
|
|
1506
|
-
* The name of the keyspace that contains this type.
|
|
1507
|
-
* </p>
|
|
1118
|
+
* <p> The name of the keyspace that contains this type. </p>
|
|
1508
1119
|
* @public
|
|
1509
1120
|
*/
|
|
1510
1121
|
keyspaceName: string | undefined;
|
|
1511
1122
|
/**
|
|
1512
|
-
* <p>
|
|
1513
|
-
* The name of the type.
|
|
1514
|
-
* </p>
|
|
1123
|
+
* <p> The name of the type. </p>
|
|
1515
1124
|
* @public
|
|
1516
1125
|
*/
|
|
1517
1126
|
typeName: string | undefined;
|
|
1518
1127
|
/**
|
|
1519
|
-
* <p>
|
|
1520
|
-
* The names and types that define this type.
|
|
1521
|
-
* </p>
|
|
1128
|
+
* <p> The names and types that define this type. </p>
|
|
1522
1129
|
* @public
|
|
1523
1130
|
*/
|
|
1524
1131
|
fieldDefinitions?: FieldDefinition[] | undefined;
|
|
1525
1132
|
/**
|
|
1526
|
-
* <p>
|
|
1527
|
-
* The timestamp that shows when this type was last modified.
|
|
1528
|
-
* </p>
|
|
1133
|
+
* <p> The timestamp that shows when this type was last modified. </p>
|
|
1529
1134
|
* @public
|
|
1530
1135
|
*/
|
|
1531
1136
|
lastModifiedTimestamp?: Date | undefined;
|
|
1532
1137
|
/**
|
|
1533
|
-
* <p>
|
|
1534
|
-
* The status of this type.
|
|
1535
|
-
* </p>
|
|
1138
|
+
* <p> The status of this type. </p>
|
|
1536
1139
|
* @public
|
|
1537
1140
|
*/
|
|
1538
1141
|
status?: TypeStatus | undefined;
|
|
1539
1142
|
/**
|
|
1540
|
-
* <p>
|
|
1541
|
-
* The tables that use this type.
|
|
1542
|
-
* </p>
|
|
1143
|
+
* <p> The tables that use this type. </p>
|
|
1543
1144
|
* @public
|
|
1544
1145
|
*/
|
|
1545
1146
|
directReferringTables?: string[] | undefined;
|
|
1546
1147
|
/**
|
|
1547
|
-
* <p>
|
|
1548
|
-
* The types that use this type.
|
|
1549
|
-
* </p>
|
|
1148
|
+
* <p> The types that use this type. </p>
|
|
1550
1149
|
* @public
|
|
1551
1150
|
*/
|
|
1552
1151
|
directParentTypes?: string[] | undefined;
|
|
1553
1152
|
/**
|
|
1554
|
-
* <p>
|
|
1555
|
-
* The level of nesting implemented for this type.
|
|
1556
|
-
* </p>
|
|
1153
|
+
* <p> The level of nesting implemented for this type. </p>
|
|
1557
1154
|
* @public
|
|
1558
1155
|
*/
|
|
1559
1156
|
maxNestingDepth?: number | undefined;
|
|
1560
1157
|
/**
|
|
1561
|
-
* <p>
|
|
1562
|
-
* The unique identifier of the keyspace that contains this type in the format of an Amazon Resource Name (ARN).
|
|
1563
|
-
* </p>
|
|
1158
|
+
* <p> The unique identifier of the keyspace that contains this type in the format of an Amazon Resource Name (ARN). </p>
|
|
1564
1159
|
* @public
|
|
1565
1160
|
*/
|
|
1566
1161
|
keyspaceArn: string | undefined;
|
|
@@ -1575,9 +1170,7 @@ export interface ListKeyspacesRequest {
|
|
|
1575
1170
|
*/
|
|
1576
1171
|
nextToken?: string | undefined;
|
|
1577
1172
|
/**
|
|
1578
|
-
* <p>The total number of keyspaces to return in the output. If the total number of keyspaces available
|
|
1579
|
-
* is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination,
|
|
1580
|
-
* provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>
|
|
1173
|
+
* <p>The total number of keyspaces to return in the output. If the total number of keyspaces available is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>
|
|
1581
1174
|
* @public
|
|
1582
1175
|
*/
|
|
1583
1176
|
maxResults?: number | undefined;
|
|
@@ -1598,17 +1191,12 @@ export interface KeyspaceSummary {
|
|
|
1598
1191
|
*/
|
|
1599
1192
|
resourceArn: string | undefined;
|
|
1600
1193
|
/**
|
|
1601
|
-
* <p>
|
|
1602
|
-
* This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available
|
|
1603
|
-
* values are <code>SINGLE_REGION</code> or <code>MULTI_REGION</code>.
|
|
1604
|
-
* </p>
|
|
1194
|
+
* <p> This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available values are <code>SINGLE_REGION</code> or <code>MULTI_REGION</code>. </p>
|
|
1605
1195
|
* @public
|
|
1606
1196
|
*/
|
|
1607
1197
|
replicationStrategy: Rs | undefined;
|
|
1608
1198
|
/**
|
|
1609
|
-
* <p>
|
|
1610
|
-
* If the <code>replicationStrategy</code> of the keyspace is <code>MULTI_REGION</code>, a list of replication Regions is returned.
|
|
1611
|
-
* </p>
|
|
1199
|
+
* <p> If the <code>replicationStrategy</code> of the keyspace is <code>MULTI_REGION</code>, a list of replication Regions is returned. </p>
|
|
1612
1200
|
* @public
|
|
1613
1201
|
*/
|
|
1614
1202
|
replicationRegions?: string[] | undefined;
|
|
@@ -1638,9 +1226,7 @@ export interface ListTablesRequest {
|
|
|
1638
1226
|
*/
|
|
1639
1227
|
nextToken?: string | undefined;
|
|
1640
1228
|
/**
|
|
1641
|
-
* <p>The total number of tables to return in the output. If the total number of tables available
|
|
1642
|
-
* is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination,
|
|
1643
|
-
* provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>
|
|
1229
|
+
* <p>The total number of tables to return in the output. If the total number of tables available is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>
|
|
1644
1230
|
* @public
|
|
1645
1231
|
*/
|
|
1646
1232
|
maxResults?: number | undefined;
|
|
@@ -1701,9 +1287,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1701
1287
|
*/
|
|
1702
1288
|
nextToken?: string | undefined;
|
|
1703
1289
|
/**
|
|
1704
|
-
* <p>The total number of tags to return in the output. If the total number of tags available
|
|
1705
|
-
* is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination,
|
|
1706
|
-
* provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>
|
|
1290
|
+
* <p>The total number of tags to return in the output. If the total number of tags available is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>
|
|
1707
1291
|
* @public
|
|
1708
1292
|
*/
|
|
1709
1293
|
maxResults?: number | undefined;
|
|
@@ -1728,25 +1312,17 @@ export interface ListTagsForResourceResponse {
|
|
|
1728
1312
|
*/
|
|
1729
1313
|
export interface ListTypesRequest {
|
|
1730
1314
|
/**
|
|
1731
|
-
* <p>
|
|
1732
|
-
* The pagination token. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.
|
|
1733
|
-
* </p>
|
|
1315
|
+
* <p> The pagination token. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation. </p>
|
|
1734
1316
|
* @public
|
|
1735
1317
|
*/
|
|
1736
1318
|
nextToken?: string | undefined;
|
|
1737
1319
|
/**
|
|
1738
|
-
* <p>
|
|
1739
|
-
* The total number of types to return in the output. If the total number of types available is more than the value specified,
|
|
1740
|
-
* a <code>NextToken</code> is provided in the output. To resume pagination, provide the <code>NextToken</code> value as an
|
|
1741
|
-
* argument of a subsequent API invocation.
|
|
1742
|
-
* </p>
|
|
1320
|
+
* <p> The total number of types to return in the output. If the total number of types available is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation. </p>
|
|
1743
1321
|
* @public
|
|
1744
1322
|
*/
|
|
1745
1323
|
maxResults?: number | undefined;
|
|
1746
1324
|
/**
|
|
1747
|
-
* <p>
|
|
1748
|
-
* The name of the keyspace that contains the listed types.
|
|
1749
|
-
* </p>
|
|
1325
|
+
* <p> The name of the keyspace that contains the listed types. </p>
|
|
1750
1326
|
* @public
|
|
1751
1327
|
*/
|
|
1752
1328
|
keyspaceName: string | undefined;
|
|
@@ -1756,16 +1332,12 @@ export interface ListTypesRequest {
|
|
|
1756
1332
|
*/
|
|
1757
1333
|
export interface ListTypesResponse {
|
|
1758
1334
|
/**
|
|
1759
|
-
* <p>
|
|
1760
|
-
* The pagination token. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.
|
|
1761
|
-
* </p>
|
|
1335
|
+
* <p> The pagination token. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation. </p>
|
|
1762
1336
|
* @public
|
|
1763
1337
|
*/
|
|
1764
1338
|
nextToken?: string | undefined;
|
|
1765
1339
|
/**
|
|
1766
|
-
* <p>
|
|
1767
|
-
* The list of types contained in the specified keyspace.
|
|
1768
|
-
* </p>
|
|
1340
|
+
* <p> The list of types contained in the specified keyspace. </p>
|
|
1769
1341
|
* @public
|
|
1770
1342
|
*/
|
|
1771
1343
|
types: string[] | undefined;
|
|
@@ -1800,82 +1372,27 @@ export interface RestoreTableRequest {
|
|
|
1800
1372
|
*/
|
|
1801
1373
|
restoreTimestamp?: Date | undefined;
|
|
1802
1374
|
/**
|
|
1803
|
-
* <p>Specifies the read/write throughput capacity mode for the target table. The options are:</p>
|
|
1804
|
-
* <ul>
|
|
1805
|
-
* <li>
|
|
1806
|
-
* <p>
|
|
1807
|
-
* <code>throughputMode:PAY_PER_REQUEST</code>
|
|
1808
|
-
* </p>
|
|
1809
|
-
* </li>
|
|
1810
|
-
* <li>
|
|
1811
|
-
* <p>
|
|
1812
|
-
* <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires
|
|
1813
|
-
* <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p>
|
|
1814
|
-
* </li>
|
|
1815
|
-
* </ul>
|
|
1816
|
-
* <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p>
|
|
1817
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
1818
|
-
* Guide</i>.</p>
|
|
1375
|
+
* <p>Specifies the read/write throughput capacity mode for the target table. The options are:</p> <ul> <li> <p> <code>throughputMode:PAY_PER_REQUEST</code> </p> </li> <li> <p> <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p> </li> </ul> <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
1819
1376
|
* @public
|
|
1820
1377
|
*/
|
|
1821
1378
|
capacitySpecificationOverride?: CapacitySpecification | undefined;
|
|
1822
1379
|
/**
|
|
1823
|
-
* <p>Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):</p>
|
|
1824
|
-
* <ul>
|
|
1825
|
-
* <li>
|
|
1826
|
-
* <p>
|
|
1827
|
-
* <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p>
|
|
1828
|
-
* </li>
|
|
1829
|
-
* <li>
|
|
1830
|
-
* <p>
|
|
1831
|
-
* <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you.
|
|
1832
|
-
* This option
|
|
1833
|
-
* requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p>
|
|
1834
|
-
* </li>
|
|
1835
|
-
* </ul>
|
|
1836
|
-
* <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>.</p>
|
|
1837
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer
|
|
1838
|
-
* Guide</i>.</p>
|
|
1380
|
+
* <p>Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):</p> <ul> <li> <p> <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p> </li> <li> <p> <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p> </li> </ul> <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
1839
1381
|
* @public
|
|
1840
1382
|
*/
|
|
1841
1383
|
encryptionSpecificationOverride?: EncryptionSpecification | undefined;
|
|
1842
1384
|
/**
|
|
1843
|
-
* <p>Specifies the <code>pointInTimeRecovery</code> settings for the target
|
|
1844
|
-
* table. The options are:</p>
|
|
1845
|
-
* <ul>
|
|
1846
|
-
* <li>
|
|
1847
|
-
* <p>
|
|
1848
|
-
* <code>status=ENABLED</code>
|
|
1849
|
-
* </p>
|
|
1850
|
-
* </li>
|
|
1851
|
-
* <li>
|
|
1852
|
-
* <p>
|
|
1853
|
-
* <code>status=DISABLED</code>
|
|
1854
|
-
* </p>
|
|
1855
|
-
* </li>
|
|
1856
|
-
* </ul>
|
|
1857
|
-
* <p>If it's not specified, the default is <code>status=DISABLED</code>.</p>
|
|
1858
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer
|
|
1859
|
-
* Guide</i>.</p>
|
|
1385
|
+
* <p>Specifies the <code>pointInTimeRecovery</code> settings for the target table. The options are:</p> <ul> <li> <p> <code>status=ENABLED</code> </p> </li> <li> <p> <code>status=DISABLED</code> </p> </li> </ul> <p>If it's not specified, the default is <code>status=DISABLED</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
1860
1386
|
* @public
|
|
1861
1387
|
*/
|
|
1862
1388
|
pointInTimeRecoveryOverride?: PointInTimeRecovery | undefined;
|
|
1863
1389
|
/**
|
|
1864
|
-
* <p>A list of key-value pair tags to be
|
|
1865
|
-
* attached to the restored table. </p>
|
|
1866
|
-
* <p>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
|
|
1867
|
-
* Guide</i>.</p>
|
|
1390
|
+
* <p>A list of key-value pair tags to be attached to the restored table. </p> <p>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 Guide</i>.</p>
|
|
1868
1391
|
* @public
|
|
1869
1392
|
*/
|
|
1870
1393
|
tagsOverride?: Tag[] | undefined;
|
|
1871
1394
|
/**
|
|
1872
|
-
* <p>The optional auto scaling settings for the restored table in provisioned capacity mode.
|
|
1873
|
-
* Specifies if the service can manage throughput capacity of a provisioned table
|
|
1874
|
-
* automatically on your behalf.
|
|
1875
|
-
* Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing
|
|
1876
|
-
* your table's read and write capacity automatically in response to application traffic.</p>
|
|
1877
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer
|
|
1878
|
-
* Guide</i>.</p>
|
|
1395
|
+
* <p>The optional auto scaling settings for the restored table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
1879
1396
|
* @public
|
|
1880
1397
|
*/
|
|
1881
1398
|
autoScalingSpecification?: AutoScalingSpecification | undefined;
|
|
@@ -1940,33 +1457,17 @@ export interface UntagResourceResponse {
|
|
|
1940
1457
|
*/
|
|
1941
1458
|
export interface UpdateKeyspaceRequest {
|
|
1942
1459
|
/**
|
|
1943
|
-
* <p>
|
|
1944
|
-
* The name of the keyspace.
|
|
1945
|
-
* </p>
|
|
1460
|
+
* <p> The name of the keyspace. </p>
|
|
1946
1461
|
* @public
|
|
1947
1462
|
*/
|
|
1948
1463
|
keyspaceName: string | undefined;
|
|
1949
1464
|
/**
|
|
1950
|
-
* <p>
|
|
1951
|
-
* The replication specification of the keyspace includes:</p>
|
|
1952
|
-
* <ul>
|
|
1953
|
-
* <li>
|
|
1954
|
-
* <p>
|
|
1955
|
-
* <code>regionList</code> - the Amazon Web Services Regions where the keyspace is replicated in.</p>
|
|
1956
|
-
* </li>
|
|
1957
|
-
* <li>
|
|
1958
|
-
* <p>
|
|
1959
|
-
* <code>replicationStrategy</code> - the required value is <code>SINGLE_REGION</code> or
|
|
1960
|
-
* <code>MULTI_REGION</code>.</p>
|
|
1961
|
-
* </li>
|
|
1962
|
-
* </ul>
|
|
1465
|
+
* <p> The replication specification of the keyspace includes:</p> <ul> <li> <p> <code>regionList</code> - the Amazon Web Services Regions where the keyspace is replicated in.</p> </li> <li> <p> <code>replicationStrategy</code> - the required value is <code>SINGLE_REGION</code> or <code>MULTI_REGION</code>.</p> </li> </ul>
|
|
1963
1466
|
* @public
|
|
1964
1467
|
*/
|
|
1965
1468
|
replicationSpecification: ReplicationSpecification | undefined;
|
|
1966
1469
|
/**
|
|
1967
|
-
* <p>The client-side timestamp setting of the table.</p>
|
|
1968
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/client-side-timestamps-how-it-works.html">How it works: Amazon Keyspaces client-side timestamps</a> in the <i>Amazon Keyspaces Developer
|
|
1969
|
-
* Guide</i>.</p>
|
|
1470
|
+
* <p>The client-side timestamp setting of the table.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/client-side-timestamps-how-it-works.html">How it works: Amazon Keyspaces client-side timestamps</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
1970
1471
|
* @public
|
|
1971
1472
|
*/
|
|
1972
1473
|
clientSideTimestamps?: ClientSideTimestamps | undefined;
|
|
@@ -1976,9 +1477,7 @@ export interface UpdateKeyspaceRequest {
|
|
|
1976
1477
|
*/
|
|
1977
1478
|
export interface UpdateKeyspaceResponse {
|
|
1978
1479
|
/**
|
|
1979
|
-
* <p>
|
|
1980
|
-
* The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).
|
|
1981
|
-
* </p>
|
|
1480
|
+
* <p> The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN). </p>
|
|
1982
1481
|
* @public
|
|
1983
1482
|
*/
|
|
1984
1483
|
resourceArn: string | undefined;
|
|
@@ -1998,135 +1497,42 @@ export interface UpdateTableRequest {
|
|
|
1998
1497
|
*/
|
|
1999
1498
|
tableName: string | undefined;
|
|
2000
1499
|
/**
|
|
2001
|
-
* <p>For each column to be added to the specified table:</p>
|
|
2002
|
-
* <ul>
|
|
2003
|
-
* <li>
|
|
2004
|
-
* <p>
|
|
2005
|
-
* <code>name</code> - The name
|
|
2006
|
-
* of the column.</p>
|
|
2007
|
-
* </li>
|
|
2008
|
-
* <li>
|
|
2009
|
-
* <p>
|
|
2010
|
-
* <code>type</code> - An Amazon Keyspaces
|
|
2011
|
-
* data type. For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types">Data types</a> in the <i>Amazon Keyspaces Developer
|
|
2012
|
-
* Guide</i>.</p>
|
|
2013
|
-
* </li>
|
|
2014
|
-
* </ul>
|
|
1500
|
+
* <p>For each column to be added to the specified table:</p> <ul> <li> <p> <code>name</code> - The name of the column.</p> </li> <li> <p> <code>type</code> - An Amazon Keyspaces data type. For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types">Data types</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> </li> </ul>
|
|
2015
1501
|
* @public
|
|
2016
1502
|
*/
|
|
2017
1503
|
addColumns?: ColumnDefinition[] | undefined;
|
|
2018
1504
|
/**
|
|
2019
|
-
* <p>Modifies the read/write throughput capacity mode for the table. The options are:</p>
|
|
2020
|
-
* <ul>
|
|
2021
|
-
* <li>
|
|
2022
|
-
* <p>
|
|
2023
|
-
* <code>throughputMode:PAY_PER_REQUEST</code> and </p>
|
|
2024
|
-
* </li>
|
|
2025
|
-
* <li>
|
|
2026
|
-
* <p>
|
|
2027
|
-
* <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires
|
|
2028
|
-
* <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p>
|
|
2029
|
-
* </li>
|
|
2030
|
-
* </ul>
|
|
2031
|
-
* <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p>
|
|
2032
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
2033
|
-
* Guide</i>.</p>
|
|
1505
|
+
* <p>Modifies the read/write throughput capacity mode for the table. The options are:</p> <ul> <li> <p> <code>throughputMode:PAY_PER_REQUEST</code> and </p> </li> <li> <p> <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p> </li> </ul> <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
2034
1506
|
* @public
|
|
2035
1507
|
*/
|
|
2036
1508
|
capacitySpecification?: CapacitySpecification | undefined;
|
|
2037
1509
|
/**
|
|
2038
|
-
* <p>Modifies the encryption settings of the table. You can choose one of the following KMS key (KMS key):</p>
|
|
2039
|
-
* <ul>
|
|
2040
|
-
* <li>
|
|
2041
|
-
* <p>
|
|
2042
|
-
* <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p>
|
|
2043
|
-
* </li>
|
|
2044
|
-
* <li>
|
|
2045
|
-
* <p>
|
|
2046
|
-
* <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you.
|
|
2047
|
-
* This option
|
|
2048
|
-
* requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p>
|
|
2049
|
-
* </li>
|
|
2050
|
-
* </ul>
|
|
2051
|
-
* <p>The default is <code>AWS_OWNED_KMS_KEY</code>.</p>
|
|
2052
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer
|
|
2053
|
-
* Guide</i>.</p>
|
|
1510
|
+
* <p>Modifies the encryption settings of the table. You can choose one of the following KMS key (KMS key):</p> <ul> <li> <p> <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p> </li> <li> <p> <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p> </li> </ul> <p>The default is <code>AWS_OWNED_KMS_KEY</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
2054
1511
|
* @public
|
|
2055
1512
|
*/
|
|
2056
1513
|
encryptionSpecification?: EncryptionSpecification | undefined;
|
|
2057
1514
|
/**
|
|
2058
|
-
* <p>Modifies the <code>pointInTimeRecovery</code> settings of the table. The options are:</p>
|
|
2059
|
-
* <ul>
|
|
2060
|
-
* <li>
|
|
2061
|
-
* <p>
|
|
2062
|
-
* <code>status=ENABLED</code>
|
|
2063
|
-
* </p>
|
|
2064
|
-
* </li>
|
|
2065
|
-
* <li>
|
|
2066
|
-
* <p>
|
|
2067
|
-
* <code>status=DISABLED</code>
|
|
2068
|
-
* </p>
|
|
2069
|
-
* </li>
|
|
2070
|
-
* </ul>
|
|
2071
|
-
* <p>If it's not specified, the default is <code>status=DISABLED</code>.</p>
|
|
2072
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer
|
|
2073
|
-
* Guide</i>.</p>
|
|
1515
|
+
* <p>Modifies the <code>pointInTimeRecovery</code> settings of the table. The options are:</p> <ul> <li> <p> <code>status=ENABLED</code> </p> </li> <li> <p> <code>status=DISABLED</code> </p> </li> </ul> <p>If it's not specified, the default is <code>status=DISABLED</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
2074
1516
|
* @public
|
|
2075
1517
|
*/
|
|
2076
1518
|
pointInTimeRecovery?: PointInTimeRecovery | undefined;
|
|
2077
1519
|
/**
|
|
2078
|
-
* <p>Modifies Time to Live custom settings for the table. The options are:</p>
|
|
2079
|
-
* <ul>
|
|
2080
|
-
* <li>
|
|
2081
|
-
* <p>
|
|
2082
|
-
* <code>status:enabled</code>
|
|
2083
|
-
* </p>
|
|
2084
|
-
* </li>
|
|
2085
|
-
* <li>
|
|
2086
|
-
* <p>
|
|
2087
|
-
* <code>status:disabled</code>
|
|
2088
|
-
* </p>
|
|
2089
|
-
* </li>
|
|
2090
|
-
* </ul>
|
|
2091
|
-
* <p>The default is <code>status:disabled</code>. After
|
|
2092
|
-
* <code>ttl</code> is enabled, you can't disable it
|
|
2093
|
-
* for the table.</p>
|
|
2094
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html">Expiring data by using Amazon Keyspaces Time to Live (TTL)</a> in the <i>Amazon Keyspaces Developer
|
|
2095
|
-
* Guide</i>.</p>
|
|
1520
|
+
* <p>Modifies Time to Live custom settings for the table. The options are:</p> <ul> <li> <p> <code>status:enabled</code> </p> </li> <li> <p> <code>status:disabled</code> </p> </li> </ul> <p>The default is <code>status:disabled</code>. After <code>ttl</code> is enabled, you can't disable it for the table.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html">Expiring data by using Amazon Keyspaces Time to Live (TTL)</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
2096
1521
|
* @public
|
|
2097
1522
|
*/
|
|
2098
1523
|
ttl?: TimeToLive | undefined;
|
|
2099
1524
|
/**
|
|
2100
|
-
* <p>The default Time to Live setting in seconds for the table.</p>
|
|
2101
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl">Setting the default TTL value for a table</a> in the <i>Amazon Keyspaces Developer
|
|
2102
|
-
* Guide</i>.</p>
|
|
1525
|
+
* <p>The default Time to Live setting in seconds for the table.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl">Setting the default TTL value for a table</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
2103
1526
|
* @public
|
|
2104
1527
|
*/
|
|
2105
1528
|
defaultTimeToLive?: number | undefined;
|
|
2106
1529
|
/**
|
|
2107
|
-
* <p>Enables client-side timestamps for the table. By default, the setting is disabled. You can enable
|
|
2108
|
-
* client-side timestamps with the following option:</p>
|
|
2109
|
-
* <ul>
|
|
2110
|
-
* <li>
|
|
2111
|
-
* <p>
|
|
2112
|
-
* <code>status: "enabled"</code>
|
|
2113
|
-
* </p>
|
|
2114
|
-
* </li>
|
|
2115
|
-
* </ul>
|
|
2116
|
-
* <p>Once client-side timestamps are enabled for a table, this setting cannot be disabled.</p>
|
|
1530
|
+
* <p>Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option:</p> <ul> <li> <p> <code>status: "enabled"</code> </p> </li> </ul> <p>Once client-side timestamps are enabled for a table, this setting cannot be disabled.</p>
|
|
2117
1531
|
* @public
|
|
2118
1532
|
*/
|
|
2119
1533
|
clientSideTimestamps?: ClientSideTimestamps | undefined;
|
|
2120
1534
|
/**
|
|
2121
|
-
* <p>The optional auto scaling settings to update for a table in provisioned capacity mode.
|
|
2122
|
-
* Specifies if the service can manage throughput capacity of a provisioned table
|
|
2123
|
-
* automatically on your behalf.
|
|
2124
|
-
* Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing
|
|
2125
|
-
* your table's read and write capacity automatically in response to application traffic.</p>
|
|
2126
|
-
* <p>If auto scaling is already enabled for the table, you can use <code>UpdateTable</code> to update the minimum and maximum values or the
|
|
2127
|
-
* auto scaling policy settings independently.</p>
|
|
2128
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer
|
|
2129
|
-
* Guide</i>.</p>
|
|
1535
|
+
* <p>The optional auto scaling settings to update for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic.</p> <p>If auto scaling is already enabled for the table, you can use <code>UpdateTable</code> to update the minimum and maximum values or the auto scaling policy settings independently.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
|
|
2130
1536
|
* @public
|
|
2131
1537
|
*/
|
|
2132
1538
|
autoScalingSpecification?: AutoScalingSpecification | undefined;
|
|
@@ -2135,6 +1541,11 @@ export interface UpdateTableRequest {
|
|
|
2135
1541
|
* @public
|
|
2136
1542
|
*/
|
|
2137
1543
|
replicaSpecifications?: ReplicaSpecification[] | undefined;
|
|
1544
|
+
/**
|
|
1545
|
+
* <p>The CDC stream settings of the table.</p>
|
|
1546
|
+
* @public
|
|
1547
|
+
*/
|
|
1548
|
+
cdcSpecification?: CdcSpecification | undefined;
|
|
2138
1549
|
}
|
|
2139
1550
|
/**
|
|
2140
1551
|
* @public
|