cloudhsmv2.d.ts 27.6 KB
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
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class CloudHSMV2 extends Service {
  /**
   * Constructs a service object. This object has one method for each API operation.
   */
  constructor(options?: CloudHSMV2.Types.ClientConfiguration)
  config: Config & CloudHSMV2.Types.ClientConfiguration;
  /**
   * Copy an AWS CloudHSM cluster backup to a different region.
   */
  copyBackupToRegion(params: CloudHSMV2.Types.CopyBackupToRegionRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.CopyBackupToRegionResponse) => void): Request<CloudHSMV2.Types.CopyBackupToRegionResponse, AWSError>;
  /**
   * Copy an AWS CloudHSM cluster backup to a different region.
   */
  copyBackupToRegion(callback?: (err: AWSError, data: CloudHSMV2.Types.CopyBackupToRegionResponse) => void): Request<CloudHSMV2.Types.CopyBackupToRegionResponse, AWSError>;
  /**
   * Creates a new AWS CloudHSM cluster.
   */
  createCluster(params: CloudHSMV2.Types.CreateClusterRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.CreateClusterResponse) => void): Request<CloudHSMV2.Types.CreateClusterResponse, AWSError>;
  /**
   * Creates a new AWS CloudHSM cluster.
   */
  createCluster(callback?: (err: AWSError, data: CloudHSMV2.Types.CreateClusterResponse) => void): Request<CloudHSMV2.Types.CreateClusterResponse, AWSError>;
  /**
   * Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
   */
  createHsm(params: CloudHSMV2.Types.CreateHsmRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.CreateHsmResponse) => void): Request<CloudHSMV2.Types.CreateHsmResponse, AWSError>;
  /**
   * Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
   */
  createHsm(callback?: (err: AWSError, data: CloudHSMV2.Types.CreateHsmResponse) => void): Request<CloudHSMV2.Types.CreateHsmResponse, AWSError>;
  /**
   * Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
   */
  deleteBackup(params: CloudHSMV2.Types.DeleteBackupRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteBackupResponse) => void): Request<CloudHSMV2.Types.DeleteBackupResponse, AWSError>;
  /**
   * Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
   */
  deleteBackup(callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteBackupResponse) => void): Request<CloudHSMV2.Types.DeleteBackupResponse, AWSError>;
  /**
   * 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.
   */
  deleteCluster(params: CloudHSMV2.Types.DeleteClusterRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteClusterResponse) => void): Request<CloudHSMV2.Types.DeleteClusterResponse, AWSError>;
  /**
   * 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.
   */
  deleteCluster(callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteClusterResponse) => void): Request<CloudHSMV2.Types.DeleteClusterResponse, AWSError>;
  /**
   * 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.
   */
  deleteHsm(params: CloudHSMV2.Types.DeleteHsmRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteHsmResponse) => void): Request<CloudHSMV2.Types.DeleteHsmResponse, AWSError>;
  /**
   * 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.
   */
  deleteHsm(callback?: (err: AWSError, data: CloudHSMV2.Types.DeleteHsmResponse) => void): Request<CloudHSMV2.Types.DeleteHsmResponse, AWSError>;
  /**
   * 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.
   */
  describeBackups(params: CloudHSMV2.Types.DescribeBackupsRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.DescribeBackupsResponse) => void): Request<CloudHSMV2.Types.DescribeBackupsResponse, AWSError>;
  /**
   * 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.
   */
  describeBackups(callback?: (err: AWSError, data: CloudHSMV2.Types.DescribeBackupsResponse) => void): Request<CloudHSMV2.Types.DescribeBackupsResponse, AWSError>;
  /**
   * 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.
   */
  describeClusters(params: CloudHSMV2.Types.DescribeClustersRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.DescribeClustersResponse) => void): Request<CloudHSMV2.Types.DescribeClustersResponse, AWSError>;
  /**
   * 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.
   */
  describeClusters(callback?: (err: AWSError, data: CloudHSMV2.Types.DescribeClustersResponse) => void): Request<CloudHSMV2.Types.DescribeClustersResponse, AWSError>;
  /**
   * 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.
   */
  initializeCluster(params: CloudHSMV2.Types.InitializeClusterRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.InitializeClusterResponse) => void): Request<CloudHSMV2.Types.InitializeClusterResponse, AWSError>;
  /**
   * 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.
   */
  initializeCluster(callback?: (err: AWSError, data: CloudHSMV2.Types.InitializeClusterResponse) => void): Request<CloudHSMV2.Types.InitializeClusterResponse, AWSError>;
  /**
   * 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.
   */
  listTags(params: CloudHSMV2.Types.ListTagsRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.ListTagsResponse) => void): Request<CloudHSMV2.Types.ListTagsResponse, AWSError>;
  /**
   * 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.
   */
  listTags(callback?: (err: AWSError, data: CloudHSMV2.Types.ListTagsResponse) => void): Request<CloudHSMV2.Types.ListTagsResponse, AWSError>;
  /**
   * Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup.
   */
  restoreBackup(params: CloudHSMV2.Types.RestoreBackupRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.RestoreBackupResponse) => void): Request<CloudHSMV2.Types.RestoreBackupResponse, AWSError>;
  /**
   * Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup.
   */
  restoreBackup(callback?: (err: AWSError, data: CloudHSMV2.Types.RestoreBackupResponse) => void): Request<CloudHSMV2.Types.RestoreBackupResponse, AWSError>;
  /**
   * Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
   */
  tagResource(params: CloudHSMV2.Types.TagResourceRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.TagResourceResponse) => void): Request<CloudHSMV2.Types.TagResourceResponse, AWSError>;
  /**
   * Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
   */
  tagResource(callback?: (err: AWSError, data: CloudHSMV2.Types.TagResourceResponse) => void): Request<CloudHSMV2.Types.TagResourceResponse, AWSError>;
  /**
   * Removes the specified tag or tags from the specified AWS CloudHSM cluster.
   */
  untagResource(params: CloudHSMV2.Types.UntagResourceRequest, callback?: (err: AWSError, data: CloudHSMV2.Types.UntagResourceResponse) => void): Request<CloudHSMV2.Types.UntagResourceResponse, AWSError>;
  /**
   * Removes the specified tag or tags from the specified AWS CloudHSM cluster.
   */
  untagResource(callback?: (err: AWSError, data: CloudHSMV2.Types.UntagResourceResponse) => void): Request<CloudHSMV2.Types.UntagResourceResponse, AWSError>;
}
declare namespace CloudHSMV2 {
  export interface Backup {
    /**
     * The identifier (ID) of the backup.
     */
    BackupId: BackupId;
    /**
     * The state of the backup.
     */
    BackupState?: BackupState;
    /**
     * The identifier (ID) of the cluster that was backed up.
     */
    ClusterId?: ClusterId;
    /**
     * The date and time when the backup was created.
     */
    CreateTimestamp?: Timestamp;
    /**
     * The date and time when the backup was copied from a source backup.
     */
    CopyTimestamp?: Timestamp;
    /**
     * The AWS Region that contains the source backup from which the new backup was copied.
     */
    SourceRegion?: Region;
    /**
     * The identifier (ID) of the source backup from which the new backup was copied.
     */
    SourceBackup?: BackupId;
    /**
     * The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
     */
    SourceCluster?: ClusterId;
    /**
     * The date and time when the backup will be permanently deleted.
     */
    DeleteTimestamp?: Timestamp;
    /**
     * The list of tags for the backup.
     */
    TagList?: TagList;
  }
  export type BackupId = string;
  export type BackupPolicy = "DEFAULT"|string;
  export type BackupState = "CREATE_IN_PROGRESS"|"READY"|"DELETED"|"PENDING_DELETION"|string;
  export type Backups = Backup[];
  export type Boolean = boolean;
  export type Cert = string;
  export interface Certificates {
    /**
     * The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is UNINITIALIZED.
     */
    ClusterCsr?: Cert;
    /**
     * The HSM certificate issued (signed) by the HSM hardware.
     */
    HsmCertificate?: Cert;
    /**
     * The HSM hardware certificate issued (signed) by AWS CloudHSM.
     */
    AwsHardwareCertificate?: Cert;
    /**
     * The HSM hardware certificate issued (signed) by the hardware manufacturer.
     */
    ManufacturerHardwareCertificate?: Cert;
    /**
     * The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
     */
    ClusterCertificate?: Cert;
  }
  export interface Cluster {
    /**
     * The cluster's backup policy.
     */
    BackupPolicy?: BackupPolicy;
    /**
     * The cluster's identifier (ID).
     */
    ClusterId?: ClusterId;
    /**
     * The date and time when the cluster was created.
     */
    CreateTimestamp?: Timestamp;
    /**
     * Contains information about the HSMs in the cluster.
     */
    Hsms?: Hsms;
    /**
     * The type of HSM that the cluster contains.
     */
    HsmType?: HsmType;
    /**
     * The default password for the cluster's Pre-Crypto Officer (PRECO) user.
     */
    PreCoPassword?: PreCoPassword;
    /**
     * The identifier (ID) of the cluster's security group.
     */
    SecurityGroup?: SecurityGroup;
    /**
     * The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
     */
    SourceBackupId?: BackupId;
    /**
     * The cluster's state.
     */
    State?: ClusterState;
    /**
     * A description of the cluster's state.
     */
    StateMessage?: StateMessage;
    /**
     * A map from availability zone to the cluster’s subnet in that availability zone.
     */
    SubnetMapping?: ExternalSubnetMapping;
    /**
     * The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
     */
    VpcId?: VpcId;
    /**
     * Contains one or more certificates or a certificate signing request (CSR).
     */
    Certificates?: Certificates;
    /**
     * The list of tags for the cluster.
     */
    TagList?: TagList;
  }
  export type ClusterId = string;
  export type ClusterState = "CREATE_IN_PROGRESS"|"UNINITIALIZED"|"INITIALIZE_IN_PROGRESS"|"INITIALIZED"|"ACTIVE"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"DELETED"|"DEGRADED"|string;
  export type Clusters = Cluster[];
  export interface CopyBackupToRegionRequest {
    /**
     * The AWS region that will contain your copied CloudHSM cluster backup.
     */
    DestinationRegion: Region;
    /**
     * The ID of the backup that will be copied to the destination region. 
     */
    BackupId: BackupId;
    /**
     * 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.
     */
    TagList?: TagList;
  }
  export interface CopyBackupToRegionResponse {
    /**
     * 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.
     */
    DestinationBackup?: DestinationBackup;
  }
  export interface CreateClusterRequest {
    /**
     * 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.  
     */
    SubnetIds: SubnetIds;
    /**
     * The type of HSM to use in the cluster. Currently the only allowed value is hsm1.medium.
     */
    HsmType: HsmType;
    /**
     * 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.
     */
    SourceBackupId?: BackupId;
    /**
     * Tags to apply to the CloudHSM cluster during creation.
     */
    TagList?: TagList;
  }
  export interface CreateClusterResponse {
    /**
     * Information about the cluster that was created.
     */
    Cluster?: Cluster;
  }
  export interface CreateHsmRequest {
    /**
     * The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.
     */
    ClusterId: ClusterId;
    /**
     * The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use DescribeClusters.
     */
    AvailabilityZone: ExternalAz;
    /**
     * 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.
     */
    IpAddress?: IpAddress;
  }
  export interface CreateHsmResponse {
    /**
     * Information about the HSM that was created.
     */
    Hsm?: Hsm;
  }
  export interface DeleteBackupRequest {
    /**
     * The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.
     */
    BackupId: BackupId;
  }
  export interface DeleteBackupResponse {
    /**
     * Information on the Backup object deleted.
     */
    Backup?: Backup;
  }
  export interface DeleteClusterRequest {
    /**
     * The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters.
     */
    ClusterId: ClusterId;
  }
  export interface DeleteClusterResponse {
    /**
     * Information about the cluster that was deleted.
     */
    Cluster?: Cluster;
  }
  export interface DeleteHsmRequest {
    /**
     * The identifier (ID) of the cluster that contains the HSM that you are deleting.
     */
    ClusterId: ClusterId;
    /**
     * The identifier (ID) of the HSM that you are deleting.
     */
    HsmId?: HsmId;
    /**
     * The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.
     */
    EniId?: EniId;
    /**
     * The IP address of the elastic network interface (ENI) of the HSM that you are deleting.
     */
    EniIp?: IpAddress;
  }
  export interface DeleteHsmResponse {
    /**
     * The identifier (ID) of the HSM that was deleted.
     */
    HsmId?: HsmId;
  }
  export interface DescribeBackupsRequest {
    /**
     * The NextToken value that you received in the previous response. Use this value to get more backups.
     */
    NextToken?: NextToken;
    /**
     * 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.
     */
    MaxResults?: MaxSize;
    /**
     * 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.
     */
    Filters?: Filters;
    /**
     * Designates whether or not to sort the return backups by ascending chronological order of generation.
     */
    SortAscending?: Boolean;
  }
  export interface DescribeBackupsResponse {
    /**
     * A list of backups.
     */
    Backups?: Backups;
    /**
     * 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.
     */
    NextToken?: NextToken;
  }
  export interface DescribeClustersRequest {
    /**
     * 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.
     */
    Filters?: Filters;
    /**
     * The NextToken value that you received in the previous response. Use this value to get more clusters.
     */
    NextToken?: NextToken;
    /**
     * 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.
     */
    MaxResults?: MaxSize;
  }
  export interface DescribeClustersResponse {
    /**
     * A list of clusters.
     */
    Clusters?: Clusters;
    /**
     * 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.
     */
    NextToken?: NextToken;
  }
  export interface DestinationBackup {
    /**
     * The date and time when both the source backup was created.
     */
    CreateTimestamp?: Timestamp;
    /**
     * The AWS region that contains the source backup from which the new backup was copied.
     */
    SourceRegion?: Region;
    /**
     * The identifier (ID) of the source backup from which the new backup was copied.
     */
    SourceBackup?: BackupId;
    /**
     * The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
     */
    SourceCluster?: ClusterId;
  }
  export type EniId = string;
  export type ExternalAz = string;
  export type ExternalSubnetMapping = {[key: string]: SubnetId};
  export type Field = string;
  export type Filters = {[key: string]: Strings};
  export interface Hsm {
    /**
     * The Availability Zone that contains the HSM.
     */
    AvailabilityZone?: ExternalAz;
    /**
     * The identifier (ID) of the cluster that contains the HSM.
     */
    ClusterId?: ClusterId;
    /**
     * The subnet that contains the HSM's elastic network interface (ENI).
     */
    SubnetId?: SubnetId;
    /**
     * The identifier (ID) of the HSM's elastic network interface (ENI).
     */
    EniId?: EniId;
    /**
     * The IP address of the HSM's elastic network interface (ENI).
     */
    EniIp?: IpAddress;
    /**
     * The HSM's identifier (ID).
     */
    HsmId: HsmId;
    /**
     * The HSM's state.
     */
    State?: HsmState;
    /**
     * A description of the HSM's state.
     */
    StateMessage?: String;
  }
  export type HsmId = string;
  export type HsmState = "CREATE_IN_PROGRESS"|"ACTIVE"|"DEGRADED"|"DELETE_IN_PROGRESS"|"DELETED"|string;
  export type HsmType = string;
  export type Hsms = Hsm[];
  export interface InitializeClusterRequest {
    /**
     * The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.
     */
    ClusterId: ClusterId;
    /**
     * 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.
     */
    SignedCert: Cert;
    /**
     * 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.
     */
    TrustAnchor: Cert;
  }
  export interface InitializeClusterResponse {
    /**
     * The cluster's state.
     */
    State?: ClusterState;
    /**
     * A description of the cluster's state.
     */
    StateMessage?: StateMessage;
  }
  export type IpAddress = string;
  export interface ListTagsRequest {
    /**
     * The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.
     */
    ResourceId: ResourceId;
    /**
     * The NextToken value that you received in the previous response. Use this value to get more tags.
     */
    NextToken?: NextToken;
    /**
     * 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.
     */
    MaxResults?: MaxSize;
  }
  export interface ListTagsResponse {
    /**
     * A list of tags.
     */
    TagList: TagList;
    /**
     * 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.
     */
    NextToken?: NextToken;
  }
  export type MaxSize = number;
  export type NextToken = string;
  export type PreCoPassword = string;
  export type Region = string;
  export type ResourceId = string;
  export interface RestoreBackupRequest {
    /**
     * The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.
     */
    BackupId: BackupId;
  }
  export interface RestoreBackupResponse {
    /**
     * Information on the Backup object created.
     */
    Backup?: Backup;
  }
  export type SecurityGroup = string;
  export type StateMessage = string;
  export type String = string;
  export type Strings = String[];
  export type SubnetId = string;
  export type SubnetIds = SubnetId[];
  export interface Tag {
    /**
     * The key of the tag.
     */
    Key: TagKey;
    /**
     * The value of the tag.
     */
    Value: TagValue;
  }
  export type TagKey = string;
  export type TagKeyList = TagKey[];
  export type TagList = Tag[];
  export interface TagResourceRequest {
    /**
     * The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use DescribeClusters.
     */
    ResourceId: ResourceId;
    /**
     * A list of one or more tags.
     */
    TagList: TagList;
  }
  export interface TagResourceResponse {
  }
  export type TagValue = string;
  export type Timestamp = Date;
  export interface UntagResourceRequest {
    /**
     * The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use DescribeClusters.
     */
    ResourceId: ResourceId;
    /**
     * A list of one or more tag keys for the tags that you are removing. Specify only the tag keys, not the tag values.
     */
    TagKeyList: TagKeyList;
  }
  export interface UntagResourceResponse {
  }
  export type VpcId = string;
  /**
   * 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.
   */
  export type apiVersion = "2017-04-28"|"latest"|string;
  export interface ClientApiVersions {
    /**
     * 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.
     */
    apiVersion?: apiVersion;
  }
  export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  /**
   * Contains interfaces for use with the CloudHSMV2 client.
   */
  export import Types = CloudHSMV2;
}
export = CloudHSMV2;