@aws-sdk/client-cloudhsm-v2 3.529.1 → 3.535.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.
Files changed (43) hide show
  1. package/dist-types/CloudHSMV2.d.ts +3 -1
  2. package/dist-types/CloudHSMV2Client.d.ts +1 -1
  3. package/dist-types/commands/CopyBackupToRegionCommand.d.ts +2 -1
  4. package/dist-types/commands/CreateClusterCommand.d.ts +2 -1
  5. package/dist-types/commands/CreateHsmCommand.d.ts +2 -1
  6. package/dist-types/commands/DeleteBackupCommand.d.ts +2 -1
  7. package/dist-types/commands/DeleteClusterCommand.d.ts +2 -1
  8. package/dist-types/commands/DeleteHsmCommand.d.ts +2 -1
  9. package/dist-types/commands/DescribeBackupsCommand.d.ts +2 -1
  10. package/dist-types/commands/DescribeClustersCommand.d.ts +2 -1
  11. package/dist-types/commands/InitializeClusterCommand.d.ts +2 -1
  12. package/dist-types/commands/ListTagsCommand.d.ts +2 -1
  13. package/dist-types/commands/ModifyBackupAttributesCommand.d.ts +2 -1
  14. package/dist-types/commands/ModifyClusterCommand.d.ts +2 -1
  15. package/dist-types/commands/RestoreBackupCommand.d.ts +2 -1
  16. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  17. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  18. package/dist-types/models/models_0.d.ts +116 -116
  19. package/dist-types/runtimeConfig.browser.d.ts +2 -2
  20. package/dist-types/runtimeConfig.d.ts +2 -2
  21. package/dist-types/runtimeConfig.native.d.ts +2 -2
  22. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  23. package/dist-types/ts3.4/CloudHSMV2.d.ts +2 -0
  24. package/dist-types/ts3.4/commands/CopyBackupToRegionCommand.d.ts +9 -0
  25. package/dist-types/ts3.4/commands/CreateClusterCommand.d.ts +9 -0
  26. package/dist-types/ts3.4/commands/CreateHsmCommand.d.ts +9 -0
  27. package/dist-types/ts3.4/commands/DeleteBackupCommand.d.ts +9 -0
  28. package/dist-types/ts3.4/commands/DeleteClusterCommand.d.ts +9 -0
  29. package/dist-types/ts3.4/commands/DeleteHsmCommand.d.ts +9 -0
  30. package/dist-types/ts3.4/commands/DescribeBackupsCommand.d.ts +9 -0
  31. package/dist-types/ts3.4/commands/DescribeClustersCommand.d.ts +9 -0
  32. package/dist-types/ts3.4/commands/InitializeClusterCommand.d.ts +9 -0
  33. package/dist-types/ts3.4/commands/ListTagsCommand.d.ts +9 -0
  34. package/dist-types/ts3.4/commands/ModifyBackupAttributesCommand.d.ts +9 -0
  35. package/dist-types/ts3.4/commands/ModifyClusterCommand.d.ts +9 -0
  36. package/dist-types/ts3.4/commands/RestoreBackupCommand.d.ts +9 -0
  37. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  38. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  39. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
  40. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
  41. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
  42. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
  43. package/package.json +40 -40
@@ -15,88 +15,88 @@ export declare const BackupState: {
15
15
  */
16
16
  export type BackupState = (typeof BackupState)[keyof typeof BackupState];
17
17
  /**
18
- * @public
19
18
  * <p>Contains a tag. A tag is a key-value pair.</p>
19
+ * @public
20
20
  */
21
21
  export interface Tag {
22
22
  /**
23
- * @public
24
23
  * <p>The key of the tag.</p>
24
+ * @public
25
25
  */
26
26
  Key: string | undefined;
27
27
  /**
28
- * @public
29
28
  * <p>The value of the tag.</p>
29
+ * @public
30
30
  */
31
31
  Value: string | undefined;
32
32
  }
33
33
  /**
34
- * @public
35
34
  * <p>Contains information about a backup of an AWS CloudHSM cluster. All backup objects
36
35
  * contain the <code>BackupId</code>, <code>BackupState</code>, <code>ClusterId</code>, and
37
36
  * <code>CreateTimestamp</code> parameters. Backups that were copied into a destination region
38
37
  * additionally contain the <code>CopyTimestamp</code>, <code>SourceBackup</code>,
39
38
  * <code>SourceCluster</code>, and <code>SourceRegion</code> parameters. A backup that is
40
39
  * pending deletion will include the <code>DeleteTimestamp</code> parameter.</p>
40
+ * @public
41
41
  */
42
42
  export interface Backup {
43
43
  /**
44
- * @public
45
44
  * <p>The identifier (ID) of the backup.</p>
45
+ * @public
46
46
  */
47
47
  BackupId: string | undefined;
48
48
  /**
49
- * @public
50
49
  * <p>The state of the backup.</p>
50
+ * @public
51
51
  */
52
52
  BackupState?: BackupState;
53
53
  /**
54
- * @public
55
54
  * <p>The identifier (ID) of the cluster that was backed up.</p>
55
+ * @public
56
56
  */
57
57
  ClusterId?: string;
58
58
  /**
59
- * @public
60
59
  * <p>The date and time when the backup was created.</p>
60
+ * @public
61
61
  */
62
62
  CreateTimestamp?: Date;
63
63
  /**
64
- * @public
65
64
  * <p>The date and time when the backup was copied from a source backup.</p>
65
+ * @public
66
66
  */
67
67
  CopyTimestamp?: Date;
68
68
  /**
69
- * @public
70
69
  * <p>Specifies whether the service should exempt a backup from the retention policy for the cluster. <code>True</code> exempts
71
70
  * a backup from the retention policy. <code>False</code> means the service applies the backup retention policy defined at the cluster.</p>
71
+ * @public
72
72
  */
73
73
  NeverExpires?: boolean;
74
74
  /**
75
- * @public
76
75
  * <p>The AWS Region that contains the source backup from which the new backup was
77
76
  * copied.</p>
77
+ * @public
78
78
  */
79
79
  SourceRegion?: string;
80
80
  /**
81
- * @public
82
81
  * <p>The identifier (ID) of the source backup from which the new backup was
83
82
  * copied.</p>
83
+ * @public
84
84
  */
85
85
  SourceBackup?: string;
86
86
  /**
87
- * @public
88
87
  * <p>The identifier (ID) of the cluster containing the source backup from which the new
89
88
  * backup was copied.</p>
89
+ * @public
90
90
  */
91
91
  SourceCluster?: string;
92
92
  /**
93
- * @public
94
93
  * <p>The date and time when the backup will be permanently deleted.</p>
94
+ * @public
95
95
  */
96
96
  DeleteTimestamp?: Date;
97
97
  /**
98
- * @public
99
98
  * <p>The list of tags for the backup.</p>
99
+ * @public
100
100
  */
101
101
  TagList?: Tag[];
102
102
  }
@@ -123,26 +123,26 @@ export declare const BackupRetentionType: {
123
123
  */
124
124
  export type BackupRetentionType = (typeof BackupRetentionType)[keyof typeof BackupRetentionType];
125
125
  /**
126
- * @public
127
126
  * <p>A policy that defines the number of days to retain backups.</p>
127
+ * @public
128
128
  */
129
129
  export interface BackupRetentionPolicy {
130
130
  /**
131
- * @public
132
131
  * <p>The type of backup retention policy. For the <code>DAYS</code> type, the value is
133
132
  * the number of days to retain backups.</p>
133
+ * @public
134
134
  */
135
135
  Type?: BackupRetentionType;
136
136
  /**
137
- * @public
138
137
  * <p>Use a value between 7 - 379.</p>
138
+ * @public
139
139
  */
140
140
  Value?: string;
141
141
  }
142
142
  /**
143
- * @public
144
143
  * <p>The request was rejected because the requester does not have permission to perform the
145
144
  * requested operation.</p>
145
+ * @public
146
146
  */
147
147
  export declare class CloudHsmAccessDeniedException extends __BaseException {
148
148
  readonly name: "CloudHsmAccessDeniedException";
@@ -154,9 +154,9 @@ export declare class CloudHsmAccessDeniedException extends __BaseException {
154
154
  constructor(opts: __ExceptionOptionType<CloudHsmAccessDeniedException, __BaseException>);
155
155
  }
156
156
  /**
157
- * @public
158
157
  * <p>The request was rejected because of an AWS CloudHSM internal failure. The request can
159
158
  * be retried.</p>
159
+ * @public
160
160
  */
161
161
  export declare class CloudHsmInternalFailureException extends __BaseException {
162
162
  readonly name: "CloudHsmInternalFailureException";
@@ -168,8 +168,8 @@ export declare class CloudHsmInternalFailureException extends __BaseException {
168
168
  constructor(opts: __ExceptionOptionType<CloudHsmInternalFailureException, __BaseException>);
169
169
  }
170
170
  /**
171
- * @public
172
171
  * <p>The request was rejected because it is not a valid request.</p>
172
+ * @public
173
173
  */
174
174
  export declare class CloudHsmInvalidRequestException extends __BaseException {
175
175
  readonly name: "CloudHsmInvalidRequestException";
@@ -181,9 +181,9 @@ export declare class CloudHsmInvalidRequestException extends __BaseException {
181
181
  constructor(opts: __ExceptionOptionType<CloudHsmInvalidRequestException, __BaseException>);
182
182
  }
183
183
  /**
184
- * @public
185
184
  * <p>The request was rejected because it refers to a resource that cannot be
186
185
  * found.</p>
186
+ * @public
187
187
  */
188
188
  export declare class CloudHsmResourceNotFoundException extends __BaseException {
189
189
  readonly name: "CloudHsmResourceNotFoundException";
@@ -195,8 +195,8 @@ export declare class CloudHsmResourceNotFoundException extends __BaseException {
195
195
  constructor(opts: __ExceptionOptionType<CloudHsmResourceNotFoundException, __BaseException>);
196
196
  }
197
197
  /**
198
- * @public
199
198
  * <p>The request was rejected because an error occurred.</p>
199
+ * @public
200
200
  */
201
201
  export declare class CloudHsmServiceException extends __BaseException {
202
202
  readonly name: "CloudHsmServiceException";
@@ -208,8 +208,8 @@ export declare class CloudHsmServiceException extends __BaseException {
208
208
  constructor(opts: __ExceptionOptionType<CloudHsmServiceException, __BaseException>);
209
209
  }
210
210
  /**
211
- * @public
212
211
  * <p>The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.</p>
212
+ * @public
213
213
  */
214
214
  export declare class CloudHsmTagException extends __BaseException {
215
215
  readonly name: "CloudHsmTagException";
@@ -225,44 +225,44 @@ export declare class CloudHsmTagException extends __BaseException {
225
225
  */
226
226
  export interface CopyBackupToRegionRequest {
227
227
  /**
228
- * @public
229
228
  * <p>The AWS region that will contain your copied CloudHSM cluster backup.</p>
229
+ * @public
230
230
  */
231
231
  DestinationRegion: string | undefined;
232
232
  /**
233
- * @public
234
233
  * <p>The ID of the backup that will be copied to the destination region. </p>
234
+ * @public
235
235
  */
236
236
  BackupId: string | undefined;
237
237
  /**
238
- * @public
239
238
  * <p>Tags to apply to the destination backup during creation. If you specify tags, only these tags will be applied to the destination backup. If you do not specify tags, the service copies tags from the source backup to the destination backup.</p>
239
+ * @public
240
240
  */
241
241
  TagList?: Tag[];
242
242
  }
243
243
  /**
244
- * @public
245
244
  * <p>Contains information about the backup that will be copied and created by the <a>CopyBackupToRegion</a> operation.</p>
245
+ * @public
246
246
  */
247
247
  export interface DestinationBackup {
248
248
  /**
249
- * @public
250
249
  * <p>The date and time when both the source backup was created.</p>
250
+ * @public
251
251
  */
252
252
  CreateTimestamp?: Date;
253
253
  /**
254
- * @public
255
254
  * <p>The AWS region that contains the source backup from which the new backup was copied.</p>
255
+ * @public
256
256
  */
257
257
  SourceRegion?: string;
258
258
  /**
259
- * @public
260
259
  * <p>The identifier (ID) of the source backup from which the new backup was copied.</p>
260
+ * @public
261
261
  */
262
262
  SourceBackup?: string;
263
263
  /**
264
- * @public
265
264
  * <p>The identifier (ID) of the cluster containing the source backup from which the new backup was copied.</p>
265
+ * @public
266
266
  */
267
267
  SourceCluster?: string;
268
268
  }
@@ -271,13 +271,13 @@ export interface DestinationBackup {
271
271
  */
272
272
  export interface CopyBackupToRegionResponse {
273
273
  /**
274
- * @public
275
274
  * <p>Information on the backup that will be copied to the destination region, including
276
275
  * CreateTimestamp, SourceBackup, SourceCluster, and Source Region. CreateTimestamp of the
277
276
  * destination backup will be the same as that of the source backup.</p>
278
277
  * <p>You will need to use the <code>sourceBackupID</code> returned in this operation to use
279
278
  * the <a>DescribeBackups</a> operation on the backup that will be copied to the
280
279
  * destination region.</p>
280
+ * @public
281
281
  */
282
282
  DestinationBackup?: DestinationBackup;
283
283
  }
@@ -286,24 +286,23 @@ export interface CopyBackupToRegionResponse {
286
286
  */
287
287
  export interface CreateClusterRequest {
288
288
  /**
289
- * @public
290
289
  * <p>A policy that defines how the service retains backups.</p>
290
+ * @public
291
291
  */
292
292
  BackupRetentionPolicy?: BackupRetentionPolicy;
293
293
  /**
294
- * @public
295
294
  * <p>The type of HSM to use in the cluster. Currently the only allowed value is
296
295
  * <code>hsm1.medium</code>.</p>
296
+ * @public
297
297
  */
298
298
  HsmType: string | undefined;
299
299
  /**
300
- * @public
301
300
  * <p>The identifier (ID) of the cluster backup to restore. Use this value to restore the
302
301
  * cluster from a backup instead of creating a new cluster. To find the backup ID, use <a>DescribeBackups</a>.</p>
302
+ * @public
303
303
  */
304
304
  SourceBackupId?: string;
305
305
  /**
306
- * @public
307
306
  * <p>The identifiers (IDs) of the subnets where you are creating the cluster. You must
308
307
  * specify at least one subnet. If you specify multiple subnets, they must meet the following
309
308
  * criteria:</p>
@@ -315,44 +314,45 @@ export interface CreateClusterRequest {
315
314
  * <p>You can specify only one subnet per Availability Zone.</p>
316
315
  * </li>
317
316
  * </ul>
317
+ * @public
318
318
  */
319
319
  SubnetIds: string[] | undefined;
320
320
  /**
321
- * @public
322
321
  * <p>Tags to apply to the CloudHSM cluster during creation.</p>
322
+ * @public
323
323
  */
324
324
  TagList?: Tag[];
325
325
  }
326
326
  /**
327
- * @public
328
327
  * <p>Contains one or more certificates or a certificate signing request (CSR).</p>
328
+ * @public
329
329
  */
330
330
  export interface Certificates {
331
331
  /**
332
- * @public
333
332
  * <p>The cluster's certificate signing request (CSR). The CSR exists only when the cluster's
334
333
  * state is <code>UNINITIALIZED</code>.</p>
334
+ * @public
335
335
  */
336
336
  ClusterCsr?: string;
337
337
  /**
338
- * @public
339
338
  * <p>The HSM certificate issued (signed) by the HSM hardware.</p>
339
+ * @public
340
340
  */
341
341
  HsmCertificate?: string;
342
342
  /**
343
- * @public
344
343
  * <p>The HSM hardware certificate issued (signed) by AWS CloudHSM.</p>
344
+ * @public
345
345
  */
346
346
  AwsHardwareCertificate?: string;
347
347
  /**
348
- * @public
349
348
  * <p>The HSM hardware certificate issued (signed) by the hardware manufacturer.</p>
349
+ * @public
350
350
  */
351
351
  ManufacturerHardwareCertificate?: string;
352
352
  /**
353
- * @public
354
353
  * <p>The cluster certificate issued (signed) by the issuing certificate authority (CA) of
355
354
  * the cluster's owner.</p>
355
+ * @public
356
356
  */
357
357
  ClusterCertificate?: string;
358
358
  }
@@ -372,49 +372,49 @@ export declare const HsmState: {
372
372
  */
373
373
  export type HsmState = (typeof HsmState)[keyof typeof HsmState];
374
374
  /**
375
- * @public
376
375
  * <p>Contains information about a hardware security module (HSM) in an AWS CloudHSM
377
376
  * cluster.</p>
377
+ * @public
378
378
  */
379
379
  export interface Hsm {
380
380
  /**
381
- * @public
382
381
  * <p>The Availability Zone that contains the HSM.</p>
382
+ * @public
383
383
  */
384
384
  AvailabilityZone?: string;
385
385
  /**
386
- * @public
387
386
  * <p>The identifier (ID) of the cluster that contains the HSM.</p>
387
+ * @public
388
388
  */
389
389
  ClusterId?: string;
390
390
  /**
391
- * @public
392
391
  * <p>The subnet that contains the HSM's elastic network interface (ENI).</p>
392
+ * @public
393
393
  */
394
394
  SubnetId?: string;
395
395
  /**
396
- * @public
397
396
  * <p>The identifier (ID) of the HSM's elastic network interface (ENI).</p>
397
+ * @public
398
398
  */
399
399
  EniId?: string;
400
400
  /**
401
- * @public
402
401
  * <p>The IP address of the HSM's elastic network interface (ENI).</p>
402
+ * @public
403
403
  */
404
404
  EniIp?: string;
405
405
  /**
406
- * @public
407
406
  * <p>The HSM's identifier (ID).</p>
407
+ * @public
408
408
  */
409
409
  HsmId: string | undefined;
410
410
  /**
411
- * @public
412
411
  * <p>The HSM's state.</p>
412
+ * @public
413
413
  */
414
414
  State?: HsmState;
415
415
  /**
416
- * @public
417
416
  * <p>A description of the HSM's state.</p>
417
+ * @public
418
418
  */
419
419
  StateMessage?: string;
420
420
  }
@@ -438,85 +438,85 @@ export declare const ClusterState: {
438
438
  */
439
439
  export type ClusterState = (typeof ClusterState)[keyof typeof ClusterState];
440
440
  /**
441
- * @public
442
441
  * <p>Contains information about an AWS CloudHSM cluster.</p>
442
+ * @public
443
443
  */
444
444
  export interface Cluster {
445
445
  /**
446
- * @public
447
446
  * <p>The cluster's backup policy.</p>
447
+ * @public
448
448
  */
449
449
  BackupPolicy?: BackupPolicy;
450
450
  /**
451
- * @public
452
451
  * <p>A policy that defines how the service retains backups.</p>
452
+ * @public
453
453
  */
454
454
  BackupRetentionPolicy?: BackupRetentionPolicy;
455
455
  /**
456
- * @public
457
456
  * <p>The cluster's identifier (ID).</p>
457
+ * @public
458
458
  */
459
459
  ClusterId?: string;
460
460
  /**
461
- * @public
462
461
  * <p>The date and time when the cluster was created.</p>
462
+ * @public
463
463
  */
464
464
  CreateTimestamp?: Date;
465
465
  /**
466
- * @public
467
466
  * <p>Contains information about the HSMs in the cluster.</p>
467
+ * @public
468
468
  */
469
469
  Hsms?: Hsm[];
470
470
  /**
471
- * @public
472
471
  * <p>The type of HSM that the cluster contains.</p>
472
+ * @public
473
473
  */
474
474
  HsmType?: string;
475
475
  /**
476
- * @public
477
476
  * <p>The default password for the cluster's Pre-Crypto Officer (PRECO) user.</p>
477
+ * @public
478
478
  */
479
479
  PreCoPassword?: string;
480
480
  /**
481
- * @public
482
481
  * <p>The identifier (ID) of the cluster's security group.</p>
482
+ * @public
483
483
  */
484
484
  SecurityGroup?: string;
485
485
  /**
486
- * @public
487
486
  * <p>The identifier (ID) of the backup used to create the cluster. This value exists only
488
487
  * when the cluster was created from a backup.</p>
488
+ * @public
489
489
  */
490
490
  SourceBackupId?: string;
491
491
  /**
492
- * @public
493
492
  * <p>The cluster's state.</p>
493
+ * @public
494
494
  */
495
495
  State?: ClusterState;
496
496
  /**
497
- * @public
498
497
  * <p>A description of the cluster's state.</p>
498
+ * @public
499
499
  */
500
500
  StateMessage?: string;
501
501
  /**
502
- * @public
503
502
  * <p>A map from availability zone to the cluster’s subnet in that availability zone.</p>
503
+ * @public
504
504
  */
505
505
  SubnetMapping?: Record<string, string>;
506
506
  /**
507
- * @public
508
507
  * <p>The identifier (ID) of the virtual private cloud (VPC) that contains the
509
508
  * cluster.</p>
509
+ * @public
510
510
  */
511
511
  VpcId?: string;
512
512
  /**
513
- * @public
514
513
  * <p>Contains one or more certificates or a certificate signing request (CSR).</p>
514
+ * @public
515
515
  */
516
516
  Certificates?: Certificates;
517
517
  /**
518
- * @public
519
518
  * <p>The list of tags for the cluster.</p>
519
+ * @public
520
520
  */
521
521
  TagList?: Tag[];
522
522
  }
@@ -525,8 +525,8 @@ export interface Cluster {
525
525
  */
526
526
  export interface CreateClusterResponse {
527
527
  /**
528
- * @public
529
528
  * <p>Information about the cluster that was created.</p>
529
+ * @public
530
530
  */
531
531
  Cluster?: Cluster;
532
532
  }
@@ -535,21 +535,21 @@ export interface CreateClusterResponse {
535
535
  */
536
536
  export interface CreateHsmRequest {
537
537
  /**
538
- * @public
539
538
  * <p>The identifier (ID) of the HSM's cluster. To find the cluster ID, use <a>DescribeClusters</a>.</p>
539
+ * @public
540
540
  */
541
541
  ClusterId: string | undefined;
542
542
  /**
543
- * @public
544
543
  * <p>The Availability Zone where you are creating the HSM. To find the cluster's
545
544
  * Availability Zones, use <a>DescribeClusters</a>.</p>
545
+ * @public
546
546
  */
547
547
  AvailabilityZone: string | undefined;
548
548
  /**
549
- * @public
550
549
  * <p>The HSM's IP address. If you specify an IP address, use an available address from the
551
550
  * subnet that maps to the Availability Zone where you are creating the HSM. If you don't specify
552
551
  * an IP address, one is chosen for you from that subnet.</p>
552
+ * @public
553
553
  */
554
554
  IpAddress?: string;
555
555
  }
@@ -558,8 +558,8 @@ export interface CreateHsmRequest {
558
558
  */
559
559
  export interface CreateHsmResponse {
560
560
  /**
561
- * @public
562
561
  * <p>Information about the HSM that was created.</p>
562
+ * @public
563
563
  */
564
564
  Hsm?: Hsm;
565
565
  }
@@ -568,8 +568,8 @@ export interface CreateHsmResponse {
568
568
  */
569
569
  export interface DeleteBackupRequest {
570
570
  /**
571
- * @public
572
571
  * <p>The ID of the backup to be deleted. To find the ID of a backup, use the <a>DescribeBackups</a> operation.</p>
572
+ * @public
573
573
  */
574
574
  BackupId: string | undefined;
575
575
  }
@@ -578,8 +578,8 @@ export interface DeleteBackupRequest {
578
578
  */
579
579
  export interface DeleteBackupResponse {
580
580
  /**
581
- * @public
582
581
  * <p>Information on the <code>Backup</code> object deleted.</p>
582
+ * @public
583
583
  */
584
584
  Backup?: Backup;
585
585
  }
@@ -588,9 +588,9 @@ export interface DeleteBackupResponse {
588
588
  */
589
589
  export interface DeleteClusterRequest {
590
590
  /**
591
- * @public
592
591
  * <p>The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use
593
592
  * <a>DescribeClusters</a>.</p>
593
+ * @public
594
594
  */
595
595
  ClusterId: string | undefined;
596
596
  }
@@ -599,8 +599,8 @@ export interface DeleteClusterRequest {
599
599
  */
600
600
  export interface DeleteClusterResponse {
601
601
  /**
602
- * @public
603
602
  * <p>Information about the cluster that was deleted.</p>
603
+ * @public
604
604
  */
605
605
  Cluster?: Cluster;
606
606
  }
@@ -609,26 +609,26 @@ export interface DeleteClusterResponse {
609
609
  */
610
610
  export interface DeleteHsmRequest {
611
611
  /**
612
- * @public
613
612
  * <p>The identifier (ID) of the cluster that contains the HSM that you are
614
613
  * deleting.</p>
614
+ * @public
615
615
  */
616
616
  ClusterId: string | undefined;
617
617
  /**
618
- * @public
619
618
  * <p>The identifier (ID) of the HSM that you are deleting.</p>
619
+ * @public
620
620
  */
621
621
  HsmId?: string;
622
622
  /**
623
- * @public
624
623
  * <p>The identifier (ID) of the elastic network interface (ENI) of the HSM that you are
625
624
  * deleting.</p>
625
+ * @public
626
626
  */
627
627
  EniId?: string;
628
628
  /**
629
- * @public
630
629
  * <p>The IP address of the elastic network interface (ENI) of the HSM that you are
631
630
  * deleting.</p>
631
+ * @public
632
632
  */
633
633
  EniIp?: string;
634
634
  }
@@ -637,8 +637,8 @@ export interface DeleteHsmRequest {
637
637
  */
638
638
  export interface DeleteHsmResponse {
639
639
  /**
640
- * @public
641
640
  * <p>The identifier (ID) of the HSM that was deleted.</p>
641
+ * @public
642
642
  */
643
643
  HsmId?: string;
644
644
  }
@@ -647,19 +647,18 @@ export interface DeleteHsmResponse {
647
647
  */
648
648
  export interface DescribeBackupsRequest {
649
649
  /**
650
- * @public
651
650
  * <p>The <code>NextToken</code> value that you received in the previous response. Use this
652
651
  * value to get more backups.</p>
652
+ * @public
653
653
  */
654
654
  NextToken?: string;
655
655
  /**
656
- * @public
657
656
  * <p>The maximum number of backups to return in the response. When there are more backups
658
657
  * than the number you specify, the response contains a <code>NextToken</code> value.</p>
658
+ * @public
659
659
  */
660
660
  MaxResults?: number;
661
661
  /**
662
- * @public
663
662
  * <p>One or more filters to limit the items returned in the response.</p>
664
663
  * <p>Use the <code>backupIds</code> filter to return only the specified backups. Specify
665
664
  * backups by their backup identifier (ID).</p>
@@ -673,12 +672,13 @@ export interface DescribeBackupsRequest {
673
672
  * <code>neverExpires</code> parameter. <code>True</code> returns all backups exempt from the
674
673
  * backup retention policy. <code>False</code> returns all backups with a backup retention policy
675
674
  * defined at the cluster.</p>
675
+ * @public
676
676
  */
677
677
  Filters?: Record<string, string[]>;
678
678
  /**
679
- * @public
680
679
  * <p>Designates whether or not to sort the return backups by ascending chronological order
681
680
  * of generation.</p>
681
+ * @public
682
682
  */
683
683
  SortAscending?: boolean;
684
684
  }
@@ -687,15 +687,15 @@ export interface DescribeBackupsRequest {
687
687
  */
688
688
  export interface DescribeBackupsResponse {
689
689
  /**
690
- * @public
691
690
  * <p>A list of backups.</p>
691
+ * @public
692
692
  */
693
693
  Backups?: Backup[];
694
694
  /**
695
- * @public
696
695
  * <p>An opaque string that indicates that the response contains only a subset of backups.
697
696
  * Use this value in a subsequent <code>DescribeBackups</code> request to get more
698
697
  * backups.</p>
698
+ * @public
699
699
  */
700
700
  NextToken?: string;
701
701
  }
@@ -704,7 +704,6 @@ export interface DescribeBackupsResponse {
704
704
  */
705
705
  export interface DescribeClustersRequest {
706
706
  /**
707
- * @public
708
707
  * <p>One or more filters to limit the items returned in the response.</p>
709
708
  * <p>Use the <code>clusterIds</code> filter to return only the specified clusters. Specify
710
709
  * clusters by their cluster identifier (ID).</p>
@@ -712,18 +711,19 @@ export interface DescribeClustersRequest {
712
711
  * private clouds (VPCs). Specify VPCs by their VPC identifier (ID).</p>
713
712
  * <p>Use the <code>states</code> filter to return only clusters that match the specified
714
713
  * state.</p>
714
+ * @public
715
715
  */
716
716
  Filters?: Record<string, string[]>;
717
717
  /**
718
- * @public
719
718
  * <p>The <code>NextToken</code> value that you received in the previous response. Use this
720
719
  * value to get more clusters.</p>
720
+ * @public
721
721
  */
722
722
  NextToken?: string;
723
723
  /**
724
- * @public
725
724
  * <p>The maximum number of clusters to return in the response. When there are more clusters
726
725
  * than the number you specify, the response contains a <code>NextToken</code> value.</p>
726
+ * @public
727
727
  */
728
728
  MaxResults?: number;
729
729
  }
@@ -732,15 +732,15 @@ export interface DescribeClustersRequest {
732
732
  */
733
733
  export interface DescribeClustersResponse {
734
734
  /**
735
- * @public
736
735
  * <p>A list of clusters.</p>
736
+ * @public
737
737
  */
738
738
  Clusters?: Cluster[];
739
739
  /**
740
- * @public
741
740
  * <p>An opaque string that indicates that the response contains only a subset of clusters.
742
741
  * Use this value in a subsequent <code>DescribeClusters</code> request to get more
743
742
  * clusters.</p>
743
+ * @public
744
744
  */
745
745
  NextToken?: string;
746
746
  }
@@ -749,23 +749,23 @@ export interface DescribeClustersResponse {
749
749
  */
750
750
  export interface InitializeClusterRequest {
751
751
  /**
752
- * @public
753
752
  * <p>The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use
754
753
  * <a>DescribeClusters</a>.</p>
754
+ * @public
755
755
  */
756
756
  ClusterId: string | undefined;
757
757
  /**
758
- * @public
759
758
  * <p>The cluster certificate issued (signed) by your issuing certificate authority (CA). The
760
759
  * certificate must be in PEM format and can contain a maximum of 5000 characters.</p>
760
+ * @public
761
761
  */
762
762
  SignedCert: string | undefined;
763
763
  /**
764
- * @public
765
764
  * <p>The issuing certificate of the issuing certificate authority (CA) that issued (signed)
766
765
  * the cluster certificate. You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and thus must be the
767
766
  * root certificate. The certificate must be in PEM format and can contain a
768
767
  * maximum of 5000 characters.</p>
768
+ * @public
769
769
  */
770
770
  TrustAnchor: string | undefined;
771
771
  }
@@ -774,13 +774,13 @@ export interface InitializeClusterRequest {
774
774
  */
775
775
  export interface InitializeClusterResponse {
776
776
  /**
777
- * @public
778
777
  * <p>The cluster's state.</p>
778
+ * @public
779
779
  */
780
780
  State?: ClusterState;
781
781
  /**
782
- * @public
783
782
  * <p>A description of the cluster's state.</p>
783
+ * @public
784
784
  */
785
785
  StateMessage?: string;
786
786
  }
@@ -789,21 +789,21 @@ export interface InitializeClusterResponse {
789
789
  */
790
790
  export interface ListTagsRequest {
791
791
  /**
792
- * @public
793
792
  * <p>The cluster identifier (ID) for the cluster whose tags you are getting. To find the
794
793
  * cluster ID, use <a>DescribeClusters</a>.</p>
794
+ * @public
795
795
  */
796
796
  ResourceId: string | undefined;
797
797
  /**
798
- * @public
799
798
  * <p>The <code>NextToken</code> value that you received in the previous response. Use this
800
799
  * value to get more tags.</p>
800
+ * @public
801
801
  */
802
802
  NextToken?: string;
803
803
  /**
804
- * @public
805
804
  * <p>The maximum number of tags to return in the response. When there are more tags than the
806
805
  * number you specify, the response contains a <code>NextToken</code> value.</p>
806
+ * @public
807
807
  */
808
808
  MaxResults?: number;
809
809
  }
@@ -812,14 +812,14 @@ export interface ListTagsRequest {
812
812
  */
813
813
  export interface ListTagsResponse {
814
814
  /**
815
- * @public
816
815
  * <p>A list of tags.</p>
816
+ * @public
817
817
  */
818
818
  TagList: Tag[] | undefined;
819
819
  /**
820
- * @public
821
820
  * <p>An opaque string that indicates that the response contains only a subset of tags. Use
822
821
  * this value in a subsequent <code>ListTags</code> request to get more tags.</p>
822
+ * @public
823
823
  */
824
824
  NextToken?: string;
825
825
  }
@@ -828,14 +828,14 @@ export interface ListTagsResponse {
828
828
  */
829
829
  export interface ModifyBackupAttributesRequest {
830
830
  /**
831
- * @public
832
831
  * <p>The identifier (ID) of the backup to modify. To find the ID of a backup, use the <a>DescribeBackups</a> operation.</p>
832
+ * @public
833
833
  */
834
834
  BackupId: string | undefined;
835
835
  /**
836
- * @public
837
836
  * <p>Specifies whether the service should exempt a backup from the retention policy for the cluster. <code>True</code> exempts
838
837
  * a backup from the retention policy. <code>False</code> means the service applies the backup retention policy defined at the cluster.</p>
838
+ * @public
839
839
  */
840
840
  NeverExpires: boolean | undefined;
841
841
  }
@@ -844,13 +844,13 @@ export interface ModifyBackupAttributesRequest {
844
844
  */
845
845
  export interface ModifyBackupAttributesResponse {
846
846
  /**
847
- * @public
848
847
  * <p>Contains information about a backup of an AWS CloudHSM cluster. All backup objects
849
848
  * contain the <code>BackupId</code>, <code>BackupState</code>, <code>ClusterId</code>, and
850
849
  * <code>CreateTimestamp</code> parameters. Backups that were copied into a destination region
851
850
  * additionally contain the <code>CopyTimestamp</code>, <code>SourceBackup</code>,
852
851
  * <code>SourceCluster</code>, and <code>SourceRegion</code> parameters. A backup that is
853
852
  * pending deletion will include the <code>DeleteTimestamp</code> parameter.</p>
853
+ * @public
854
854
  */
855
855
  Backup?: Backup;
856
856
  }
@@ -859,14 +859,14 @@ export interface ModifyBackupAttributesResponse {
859
859
  */
860
860
  export interface ModifyClusterRequest {
861
861
  /**
862
- * @public
863
862
  * <p>A policy that defines how the service retains backups.</p>
863
+ * @public
864
864
  */
865
865
  BackupRetentionPolicy: BackupRetentionPolicy | undefined;
866
866
  /**
867
- * @public
868
867
  * <p>The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use
869
868
  * <a>DescribeClusters</a>.</p>
869
+ * @public
870
870
  */
871
871
  ClusterId: string | undefined;
872
872
  }
@@ -875,8 +875,8 @@ export interface ModifyClusterRequest {
875
875
  */
876
876
  export interface ModifyClusterResponse {
877
877
  /**
878
- * @public
879
878
  * <p>Contains information about an AWS CloudHSM cluster.</p>
879
+ * @public
880
880
  */
881
881
  Cluster?: Cluster;
882
882
  }
@@ -885,8 +885,8 @@ export interface ModifyClusterResponse {
885
885
  */
886
886
  export interface RestoreBackupRequest {
887
887
  /**
888
- * @public
889
888
  * <p>The ID of the backup to be restored. To find the ID of a backup, use the <a>DescribeBackups</a> operation.</p>
889
+ * @public
890
890
  */
891
891
  BackupId: string | undefined;
892
892
  }
@@ -895,8 +895,8 @@ export interface RestoreBackupRequest {
895
895
  */
896
896
  export interface RestoreBackupResponse {
897
897
  /**
898
- * @public
899
898
  * <p>Information on the <code>Backup</code> object created.</p>
899
+ * @public
900
900
  */
901
901
  Backup?: Backup;
902
902
  }
@@ -905,14 +905,14 @@ export interface RestoreBackupResponse {
905
905
  */
906
906
  export interface TagResourceRequest {
907
907
  /**
908
- * @public
909
908
  * <p>The cluster identifier (ID) for the cluster that you are tagging. To find the cluster
910
909
  * ID, use <a>DescribeClusters</a>.</p>
910
+ * @public
911
911
  */
912
912
  ResourceId: string | undefined;
913
913
  /**
914
- * @public
915
914
  * <p>A list of one or more tags.</p>
915
+ * @public
916
916
  */
917
917
  TagList: Tag[] | undefined;
918
918
  }
@@ -926,15 +926,15 @@ export interface TagResourceResponse {
926
926
  */
927
927
  export interface UntagResourceRequest {
928
928
  /**
929
- * @public
930
929
  * <p>The cluster identifier (ID) for the cluster whose tags you are removing. To find the
931
930
  * cluster ID, use <a>DescribeClusters</a>.</p>
931
+ * @public
932
932
  */
933
933
  ResourceId: string | undefined;
934
934
  /**
935
- * @public
936
935
  * <p>A list of one or more tag keys for the tags that you are removing. Specify only the tag
937
936
  * keys, not the tag values.</p>
937
+ * @public
938
938
  */
939
939
  TagKeyList: string[] | undefined;
940
940
  }