UNPKG

26.7 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class CloudHSMV2 extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: CloudHSMV2.Types.ClientConfiguration)
13 config: Config & CloudHSMV2.Types.ClientConfiguration;
14 /**
15 * Copy an AWS CloudHSM cluster backup to a different region.
16 */
17 copyBackupToRegion(params: CloudHSMV2.Types.CopyBackupToRegionRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.CopyBackupToRegionResponse) => void): Request<CloudHSMV2.Types.CopyBackupToRegionResponse, AWSError>;
18 /**
19 * Copy an AWS CloudHSM cluster backup to a different region.
20 */
21 copyBackupToRegion(callback?: (err: AWSError, data: CloudHSMV2.Types.CopyBackupToRegionResponse) => void): Request<CloudHSMV2.Types.CopyBackupToRegionResponse, AWSError>;
22 /**
23 * Creates a new AWS CloudHSM cluster.
24 */
25 createCluster(params: CloudHSMV2.Types.CreateClusterRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.CreateClusterResponse) => void): Request<CloudHSMV2.Types.CreateClusterResponse, AWSError>;
26 /**
27 * Creates a new AWS CloudHSM cluster.
28 */
29 createCluster(callback?: (err: AWSError, data: CloudHSMV2.Types.CreateClusterResponse) => void): Request<CloudHSMV2.Types.CreateClusterResponse, AWSError>;
30 /**
31 * Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
32 */
33 createHsm(params: CloudHSMV2.Types.CreateHsmRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.CreateHsmResponse) => void): Request<CloudHSMV2.Types.CreateHsmResponse, AWSError>;
34 /**
35 * Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
36 */
37 createHsm(callback?: (err: AWSError, data: CloudHSMV2.Types.CreateHsmResponse) => void): Request<CloudHSMV2.Types.CreateHsmResponse, AWSError>;
38 /**
39 * Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request. For more information on restoring a backup, see RestoreBackup
40 */
41 deleteBackup(params: CloudHSMV2.Types.DeleteBackupRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteBackupResponse) => void): Request<CloudHSMV2.Types.DeleteBackupResponse, AWSError>;
42 /**
43 * Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request. For more information on restoring a backup, see RestoreBackup
44 */
45 deleteBackup(callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteBackupResponse) => void): Request<CloudHSMV2.Types.DeleteBackupResponse, AWSError>;
46 /**
47 * Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
48 */
49 deleteCluster(params: CloudHSMV2.Types.DeleteClusterRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteClusterResponse) => void): Request<CloudHSMV2.Types.DeleteClusterResponse, AWSError>;
50 /**
51 * Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
52 */
53 deleteCluster(callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteClusterResponse) => void): Request<CloudHSMV2.Types.DeleteClusterResponse, AWSError>;
54 /**
55 * Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.
56 */
57 deleteHsm(params: CloudHSMV2.Types.DeleteHsmRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteHsmResponse) => void): Request<CloudHSMV2.Types.DeleteHsmResponse, AWSError>;
58 /**
59 * Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.
60 */
61 deleteHsm(callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteHsmResponse) => void): Request<CloudHSMV2.Types.DeleteHsmResponse, AWSError>;
62 /**
63 * Gets information about backups of AWS CloudHSM clusters. This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.
64 */
65 describeBackups(params: CloudHSMV2.Types.DescribeBackupsRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.DescribeBackupsResponse) => void): Request<CloudHSMV2.Types.DescribeBackupsResponse, AWSError>;
66 /**
67 * Gets information about backups of AWS CloudHSM clusters. This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.
68 */
69 describeBackups(callback?: (err: AWSError, data: CloudHSMV2.Types.DescribeBackupsResponse) => void): Request<CloudHSMV2.Types.DescribeBackupsResponse, AWSError>;
70 /**
71 * Gets information about AWS CloudHSM clusters. This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.
72 */
73 describeClusters(params: CloudHSMV2.Types.DescribeClustersRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.DescribeClustersResponse) => void): Request<CloudHSMV2.Types.DescribeClustersResponse, AWSError>;
74 /**
75 * Gets information about AWS CloudHSM clusters. This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.
76 */
77 describeClusters(callback?: (err: AWSError, data: CloudHSMV2.Types.DescribeClustersResponse) => void): Request<CloudHSMV2.Types.DescribeClustersResponse, AWSError>;
78 /**
79 * Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.
80 */
81 initializeCluster(params: CloudHSMV2.Types.InitializeClusterRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.InitializeClusterResponse) => void): Request<CloudHSMV2.Types.InitializeClusterResponse, AWSError>;
82 /**
83 * Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.
84 */
85 initializeCluster(callback?: (err: AWSError, data: CloudHSMV2.Types.InitializeClusterResponse) => void): Request<CloudHSMV2.Types.InitializeClusterResponse, AWSError>;
86 /**
87 * Gets a list of tags for the specified AWS CloudHSM cluster. This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
88 */
89 listTags(params: CloudHSMV2.Types.ListTagsRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.ListTagsResponse) => void): Request<CloudHSMV2.Types.ListTagsResponse, AWSError>;
90 /**
91 * Gets a list of tags for the specified AWS CloudHSM cluster. This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
92 */
93 listTags(callback?: (err: AWSError, data: CloudHSMV2.Types.ListTagsResponse) => void): Request<CloudHSMV2.Types.ListTagsResponse, AWSError>;
94 /**
95 * Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For more information on deleting a backup, see DeleteBackup.
96 */
97 restoreBackup(params: CloudHSMV2.Types.RestoreBackupRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.RestoreBackupResponse) => void): Request<CloudHSMV2.Types.RestoreBackupResponse, AWSError>;
98 /**
99 * Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For more information on deleting a backup, see DeleteBackup.
100 */
101 restoreBackup(callback?: (err: AWSError, data: CloudHSMV2.Types.RestoreBackupResponse) => void): Request<CloudHSMV2.Types.RestoreBackupResponse, AWSError>;
102 /**
103 * Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
104 */
105 tagResource(params: CloudHSMV2.Types.TagResourceRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.TagResourceResponse) => void): Request<CloudHSMV2.Types.TagResourceResponse, AWSError>;
106 /**
107 * Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
108 */
109 tagResource(callback?: (err: AWSError, data: CloudHSMV2.Types.TagResourceResponse) => void): Request<CloudHSMV2.Types.TagResourceResponse, AWSError>;
110 /**
111 * Removes the specified tag or tags from the specified AWS CloudHSM cluster.
112 */
113 untagResource(params: CloudHSMV2.Types.UntagResourceRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.UntagResourceResponse) => void): Request<CloudHSMV2.Types.UntagResourceResponse, AWSError>;
114 /**
115 * Removes the specified tag or tags from the specified AWS CloudHSM cluster.
116 */
117 untagResource(callback?: (err: AWSError, data: CloudHSMV2.Types.UntagResourceResponse) => void): Request<CloudHSMV2.Types.UntagResourceResponse, AWSError>;
118}
119declare namespace CloudHSMV2 {
120 export interface Backup {
121 /**
122 * The identifier (ID) of the backup.
123 */
124 BackupId: BackupId;
125 /**
126 * The state of the backup.
127 */
128 BackupState?: BackupState;
129 /**
130 * The identifier (ID) of the cluster that was backed up.
131 */
132 ClusterId?: ClusterId;
133 /**
134 * The date and time when the backup was created.
135 */
136 CreateTimestamp?: Timestamp;
137 CopyTimestamp?: Timestamp;
138 SourceRegion?: Region;
139 SourceBackup?: BackupId;
140 SourceCluster?: ClusterId;
141 /**
142 * The date and time when the backup will be permanently deleted.
143 */
144 DeleteTimestamp?: Timestamp;
145 }
146 export type BackupId = string;
147 export type BackupPolicy = "DEFAULT"|string;
148 export type BackupState = "CREATE_IN_PROGRESS"|"READY"|"DELETED"|"PENDING_DELETION"|string;
149 export type Backups = Backup[];
150 export type Boolean = boolean;
151 export type Cert = string;
152 export interface Certificates {
153 /**
154 * The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is UNINITIALIZED.
155 */
156 ClusterCsr?: Cert;
157 /**
158 * The HSM certificate issued (signed) by the HSM hardware.
159 */
160 HsmCertificate?: Cert;
161 /**
162 * The HSM hardware certificate issued (signed) by AWS CloudHSM.
163 */
164 AwsHardwareCertificate?: Cert;
165 /**
166 * The HSM hardware certificate issued (signed) by the hardware manufacturer.
167 */
168 ManufacturerHardwareCertificate?: Cert;
169 /**
170 * The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
171 */
172 ClusterCertificate?: Cert;
173 }
174 export interface Cluster {
175 /**
176 * The cluster's backup policy.
177 */
178 BackupPolicy?: BackupPolicy;
179 /**
180 * The cluster's identifier (ID).
181 */
182 ClusterId?: ClusterId;
183 /**
184 * The date and time when the cluster was created.
185 */
186 CreateTimestamp?: Timestamp;
187 /**
188 * Contains information about the HSMs in the cluster.
189 */
190 Hsms?: Hsms;
191 /**
192 * The type of HSM that the cluster contains.
193 */
194 HsmType?: HsmType;
195 /**
196 * The default password for the cluster's Pre-Crypto Officer (PRECO) user.
197 */
198 PreCoPassword?: PreCoPassword;
199 /**
200 * The identifier (ID) of the cluster's security group.
201 */
202 SecurityGroup?: SecurityGroup;
203 /**
204 * The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
205 */
206 SourceBackupId?: BackupId;
207 /**
208 * The cluster's state.
209 */
210 State?: ClusterState;
211 /**
212 * A description of the cluster's state.
213 */
214 StateMessage?: StateMessage;
215 /**
216 * A map of the cluster's subnets and their corresponding Availability Zones.
217 */
218 SubnetMapping?: ExternalSubnetMapping;
219 /**
220 * The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
221 */
222 VpcId?: VpcId;
223 /**
224 * Contains one or more certificates or a certificate signing request (CSR).
225 */
226 Certificates?: Certificates;
227 }
228 export type ClusterId = string;
229 export type ClusterState = "CREATE_IN_PROGRESS"|"UNINITIALIZED"|"INITIALIZE_IN_PROGRESS"|"INITIALIZED"|"ACTIVE"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"DELETED"|"DEGRADED"|string;
230 export type Clusters = Cluster[];
231 export interface CopyBackupToRegionRequest {
232 /**
233 * The AWS region that will contain your copied CloudHSM cluster backup.
234 */
235 DestinationRegion: Region;
236 /**
237 * The ID of the backup that will be copied to the destination region.
238 */
239 BackupId: BackupId;
240 }
241 export interface CopyBackupToRegionResponse {
242 /**
243 * 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. You will need to use the sourceBackupID returned in this operation to use the DescribeBackups operation on the backup that will be copied to the destination region.
244 */
245 DestinationBackup?: DestinationBackup;
246 }
247 export interface CreateClusterRequest {
248 /**
249 * 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: All subnets must be in the same virtual private cloud (VPC). You can specify only one subnet per Availability Zone.
250 */
251 SubnetIds: SubnetIds;
252 /**
253 * The type of HSM to use in the cluster. Currently the only allowed value is hsm1.medium.
254 */
255 HsmType: HsmType;
256 /**
257 * 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 DescribeBackups.
258 */
259 SourceBackupId?: BackupId;
260 }
261 export interface CreateClusterResponse {
262 /**
263 * Information about the cluster that was created.
264 */
265 Cluster?: Cluster;
266 }
267 export interface CreateHsmRequest {
268 /**
269 * The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.
270 */
271 ClusterId: ClusterId;
272 /**
273 * The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use DescribeClusters.
274 */
275 AvailabilityZone: ExternalAz;
276 /**
277 * 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.
278 */
279 IpAddress?: IpAddress;
280 }
281 export interface CreateHsmResponse {
282 /**
283 * Information about the HSM that was created.
284 */
285 Hsm?: Hsm;
286 }
287 export interface DeleteBackupRequest {
288 /**
289 * The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.
290 */
291 BackupId: BackupId;
292 }
293 export interface DeleteBackupResponse {
294 /**
295 * Information on the Backup object deleted.
296 */
297 Backup?: Backup;
298 }
299 export interface DeleteClusterRequest {
300 /**
301 * The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters.
302 */
303 ClusterId: ClusterId;
304 }
305 export interface DeleteClusterResponse {
306 /**
307 * Information about the cluster that was deleted.
308 */
309 Cluster?: Cluster;
310 }
311 export interface DeleteHsmRequest {
312 /**
313 * The identifier (ID) of the cluster that contains the HSM that you are deleting.
314 */
315 ClusterId: ClusterId;
316 /**
317 * The identifier (ID) of the HSM that you are deleting.
318 */
319 HsmId?: HsmId;
320 /**
321 * The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.
322 */
323 EniId?: EniId;
324 /**
325 * The IP address of the elastic network interface (ENI) of the HSM that you are deleting.
326 */
327 EniIp?: IpAddress;
328 }
329 export interface DeleteHsmResponse {
330 /**
331 * The identifier (ID) of the HSM that was deleted.
332 */
333 HsmId?: HsmId;
334 }
335 export interface DescribeBackupsRequest {
336 /**
337 * The NextToken value that you received in the previous response. Use this value to get more backups.
338 */
339 NextToken?: NextToken;
340 /**
341 * The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.
342 */
343 MaxResults?: MaxSize;
344 /**
345 * One or more filters to limit the items returned in the response. Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID). Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation. Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID). Use the states filter to return only backups that match the specified state.
346 */
347 Filters?: Filters;
348 SortAscending?: Boolean;
349 }
350 export interface DescribeBackupsResponse {
351 /**
352 * A list of backups.
353 */
354 Backups?: Backups;
355 /**
356 * An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent DescribeBackups request to get more backups.
357 */
358 NextToken?: NextToken;
359 }
360 export interface DescribeClustersRequest {
361 /**
362 * One or more filters to limit the items returned in the response. Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID). Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID). Use the states filter to return only clusters that match the specified state.
363 */
364 Filters?: Filters;
365 /**
366 * The NextToken value that you received in the previous response. Use this value to get more clusters.
367 */
368 NextToken?: NextToken;
369 /**
370 * The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.
371 */
372 MaxResults?: MaxSize;
373 }
374 export interface DescribeClustersResponse {
375 /**
376 * A list of clusters.
377 */
378 Clusters?: Clusters;
379 /**
380 * An opaque string that indicates that the response contains only a subset of clusters. Use this value in a subsequent DescribeClusters request to get more clusters.
381 */
382 NextToken?: NextToken;
383 }
384 export interface DestinationBackup {
385 CreateTimestamp?: Timestamp;
386 SourceRegion?: Region;
387 SourceBackup?: BackupId;
388 SourceCluster?: ClusterId;
389 }
390 export type EniId = string;
391 export type ExternalAz = string;
392 export type ExternalSubnetMapping = {[key: string]: SubnetId};
393 export type Field = string;
394 export type Filters = {[key: string]: Strings};
395 export interface Hsm {
396 /**
397 * The Availability Zone that contains the HSM.
398 */
399 AvailabilityZone?: ExternalAz;
400 /**
401 * The identifier (ID) of the cluster that contains the HSM.
402 */
403 ClusterId?: ClusterId;
404 /**
405 * The subnet that contains the HSM's elastic network interface (ENI).
406 */
407 SubnetId?: SubnetId;
408 /**
409 * The identifier (ID) of the HSM's elastic network interface (ENI).
410 */
411 EniId?: EniId;
412 /**
413 * The IP address of the HSM's elastic network interface (ENI).
414 */
415 EniIp?: IpAddress;
416 /**
417 * The HSM's identifier (ID).
418 */
419 HsmId: HsmId;
420 /**
421 * The HSM's state.
422 */
423 State?: HsmState;
424 /**
425 * A description of the HSM's state.
426 */
427 StateMessage?: String;
428 }
429 export type HsmId = string;
430 export type HsmState = "CREATE_IN_PROGRESS"|"ACTIVE"|"DEGRADED"|"DELETE_IN_PROGRESS"|"DELETED"|string;
431 export type HsmType = string;
432 export type Hsms = Hsm[];
433 export interface InitializeClusterRequest {
434 /**
435 * The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.
436 */
437 ClusterId: ClusterId;
438 /**
439 * 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.
440 */
441 SignedCert: Cert;
442 /**
443 * The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. This can be a root (self-signed) certificate or a certificate chain that begins with the certificate that issued the cluster certificate and ends with a root certificate. The certificate or certificate chain must be in PEM format and can contain a maximum of 5000 characters.
444 */
445 TrustAnchor: Cert;
446 }
447 export interface InitializeClusterResponse {
448 /**
449 * The cluster's state.
450 */
451 State?: ClusterState;
452 /**
453 * A description of the cluster's state.
454 */
455 StateMessage?: StateMessage;
456 }
457 export type IpAddress = string;
458 export interface ListTagsRequest {
459 /**
460 * The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.
461 */
462 ResourceId: ClusterId;
463 /**
464 * The NextToken value that you received in the previous response. Use this value to get more tags.
465 */
466 NextToken?: NextToken;
467 /**
468 * The maximum number of tags to return in the response. When there are more tags than the number you specify, the response contains a NextToken value.
469 */
470 MaxResults?: MaxSize;
471 }
472 export interface ListTagsResponse {
473 /**
474 * A list of tags.
475 */
476 TagList: TagList;
477 /**
478 * An opaque string that indicates that the response contains only a subset of tags. Use this value in a subsequent ListTags request to get more tags.
479 */
480 NextToken?: NextToken;
481 }
482 export type MaxSize = number;
483 export type NextToken = string;
484 export type PreCoPassword = string;
485 export type Region = string;
486 export interface RestoreBackupRequest {
487 /**
488 * The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.
489 */
490 BackupId: BackupId;
491 }
492 export interface RestoreBackupResponse {
493 /**
494 * Information on the Backup object created.
495 */
496 Backup?: Backup;
497 }
498 export type SecurityGroup = string;
499 export type StateMessage = string;
500 export type String = string;
501 export type Strings = String[];
502 export type SubnetId = string;
503 export type SubnetIds = SubnetId[];
504 export interface Tag {
505 /**
506 * The key of the tag.
507 */
508 Key: TagKey;
509 /**
510 * The value of the tag.
511 */
512 Value: TagValue;
513 }
514 export type TagKey = string;
515 export type TagKeyList = TagKey[];
516 export type TagList = Tag[];
517 export interface TagResourceRequest {
518 /**
519 * The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use DescribeClusters.
520 */
521 ResourceId: ClusterId;
522 /**
523 * A list of one or more tags.
524 */
525 TagList: TagList;
526 }
527 export interface TagResourceResponse {
528 }
529 export type TagValue = string;
530 export type Timestamp = Date;
531 export interface UntagResourceRequest {
532 /**
533 * The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use DescribeClusters.
534 */
535 ResourceId: ClusterId;
536 /**
537 * A list of one or more tag keys for the tags that you are removing. Specify only the tag keys, not the tag values.
538 */
539 TagKeyList: TagKeyList;
540 }
541 export interface UntagResourceResponse {
542 }
543 export type VpcId = string;
544 /**
545 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
546 */
547 export type apiVersion = "2017-04-28"|"latest"|string;
548 export interface ClientApiVersions {
549 /**
550 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
551 */
552 apiVersion?: apiVersion;
553 }
554 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
555 /**
556 * Contains interfaces for use with the CloudHSMV2 client.
557 */
558 export import Types = CloudHSMV2;
559}
560export = CloudHSMV2;