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