@aws-sdk/client-cloudhsm-v2 3.379.1 → 3.385.0

package/dist-types/models/models_0.d.ts

@@ -20,10 +20,12 @@ export type BackupState = (typeof BackupState)[keyof typeof BackupState];
  */
 export interface Tag {
     /**
+     * @public
      * <p>The key of the tag.</p>
      */
     Key: string | undefined;
     /**
+     * @public
      * <p>The value of the tag.</p>
      */
     Value: string | undefined;
@@ -39,50 +41,61 @@ export interface Tag {
  */
 export interface Backup {
     /**
+     * @public
      * <p>The identifier (ID) of the backup.</p>
      */
     BackupId: string | undefined;
     /**
+     * @public
      * <p>The state of the backup.</p>
      */
     BackupState?: BackupState | string;
     /**
+     * @public
      * <p>The identifier (ID) of the cluster that was backed up.</p>
      */
     ClusterId?: string;
     /**
+     * @public
      * <p>The date and time when the backup was created.</p>
      */
     CreateTimestamp?: Date;
     /**
+     * @public
      * <p>The date and time when the backup was copied from a source backup.</p>
      */
     CopyTimestamp?: Date;
     /**
+     * @public
      * <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;
     /**
+     * @public
      * <p>The AWS Region that contains the source backup from which the new backup was
      *       copied.</p>
      */
     SourceRegion?: string;
     /**
+     * @public
      * <p>The identifier (ID) of the source backup from which the new backup was
      *       copied.</p>
      */
     SourceBackup?: string;
     /**
+     * @public
      * <p>The identifier (ID) of the cluster containing the source backup from which the new
      *       backup was copied.</p>
      */
     SourceCluster?: string;
     /**
+     * @public
      * <p>The date and time when the backup will be permanently deleted.</p>
      */
     DeleteTimestamp?: Date;
     /**
+     * @public
      * <p>The list of tags for the backup.</p>
      */
     TagList?: Tag[];
@@ -115,11 +128,13 @@ export type BackupRetentionType = (typeof BackupRetentionType)[keyof typeof Back
  */
 export interface BackupRetentionPolicy {
     /**
+     * @public
      * <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;
     /**
+     * @public
      * <p>Use a value between 7 - 379.</p>
      */
     Value?: string;
@@ -210,14 +225,17 @@ export declare class CloudHsmTagException extends __BaseException {
  */
 export interface CopyBackupToRegionRequest {
     /**
+     * @public
      * <p>The AWS region that will contain your copied CloudHSM cluster backup.</p>
      */
     DestinationRegion: string | undefined;
     /**
+     * @public
      * <p>The ID of the backup that will be copied to the destination region. </p>
      */
     BackupId: string | undefined;
     /**
+     * @public
      * <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[];
@@ -228,18 +246,22 @@ export interface CopyBackupToRegionRequest {
  */
 export interface DestinationBackup {
     /**
+     * @public
      * <p>The date and time when both the source backup was created.</p>
      */
     CreateTimestamp?: Date;
     /**
+     * @public
      * <p>The AWS region that contains the source backup from which the new backup was copied.</p>
      */
     SourceRegion?: string;
     /**
+     * @public
      * <p>The identifier (ID) of the source backup from which the new backup was copied.</p>
      */
     SourceBackup?: string;
     /**
+     * @public
      * <p>The identifier (ID) of the cluster containing the source backup from which the new backup was copied.</p>
      */
     SourceCluster?: string;
@@ -249,6 +271,7 @@ export interface DestinationBackup {
  */
 export interface CopyBackupToRegionResponse {
     /**
+     * @public
      * <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>
@@ -263,20 +286,24 @@ export interface CopyBackupToRegionResponse {
  */
 export interface CreateClusterRequest {
     /**
+     * @public
      * <p>A policy that defines how the service retains backups.</p>
      */
     BackupRetentionPolicy?: BackupRetentionPolicy;
     /**
+     * @public
      * <p>The type of HSM to use in the cluster. Currently the only allowed value is
      *       <code>hsm1.medium</code>.</p>
      */
     HsmType: string | undefined;
     /**
+     * @public
      * <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;
     /**
+     * @public
      * <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>
@@ -291,6 +318,7 @@ export interface CreateClusterRequest {
      */
     SubnetIds: string[] | undefined;
     /**
+     * @public
      * <p>Tags to apply to the CloudHSM cluster during creation.</p>
      */
     TagList?: Tag[];
@@ -301,23 +329,28 @@ export interface CreateClusterRequest {
  */
 export interface Certificates {
     /**
+     * @public
      * <p>The cluster's certificate signing request (CSR). The CSR exists only when the cluster's
      *       state is <code>UNINITIALIZED</code>.</p>
      */
     ClusterCsr?: string;
     /**
+     * @public
      * <p>The HSM certificate issued (signed) by the HSM hardware.</p>
      */
     HsmCertificate?: string;
     /**
+     * @public
      * <p>The HSM hardware certificate issued (signed) by AWS CloudHSM.</p>
      */
     AwsHardwareCertificate?: string;
     /**
+     * @public
      * <p>The HSM hardware certificate issued (signed) by the hardware manufacturer.</p>
      */
     ManufacturerHardwareCertificate?: string;
     /**
+     * @public
      * <p>The cluster certificate issued (signed) by the issuing certificate authority (CA) of
      *       the cluster's owner.</p>
      */
@@ -345,34 +378,42 @@ export type HsmState = (typeof HsmState)[keyof typeof HsmState];
  */
 export interface Hsm {
     /**
+     * @public
      * <p>The Availability Zone that contains the HSM.</p>
      */
     AvailabilityZone?: string;
     /**
+     * @public
      * <p>The identifier (ID) of the cluster that contains the HSM.</p>
      */
     ClusterId?: string;
     /**
+     * @public
      * <p>The subnet that contains the HSM's elastic network interface (ENI).</p>
      */
     SubnetId?: string;
     /**
+     * @public
      * <p>The identifier (ID) of the HSM's elastic network interface (ENI).</p>
      */
     EniId?: string;
     /**
+     * @public
      * <p>The IP address of the HSM's elastic network interface (ENI).</p>
      */
     EniIp?: string;
     /**
+     * @public
      * <p>The HSM's identifier (ID).</p>
      */
     HsmId: string | undefined;
     /**
+     * @public
      * <p>The HSM's state.</p>
      */
     State?: HsmState | string;
     /**
+     * @public
      * <p>A description of the HSM's state.</p>
      */
     StateMessage?: string;
@@ -402,64 +443,79 @@ export type ClusterState = (typeof ClusterState)[keyof typeof ClusterState];
  */
 export interface Cluster {
     /**
+     * @public
      * <p>The cluster's backup policy.</p>
      */
     BackupPolicy?: BackupPolicy | string;
     /**
+     * @public
      * <p>A policy that defines how the service retains backups.</p>
      */
     BackupRetentionPolicy?: BackupRetentionPolicy;
     /**
+     * @public
      * <p>The cluster's identifier (ID).</p>
      */
     ClusterId?: string;
     /**
+     * @public
      * <p>The date and time when the cluster was created.</p>
      */
     CreateTimestamp?: Date;
     /**
+     * @public
      * <p>Contains information about the HSMs in the cluster.</p>
      */
     Hsms?: Hsm[];
     /**
+     * @public
      * <p>The type of HSM that the cluster contains.</p>
      */
     HsmType?: string;
     /**
+     * @public
      * <p>The default password for the cluster's Pre-Crypto Officer (PRECO) user.</p>
      */
     PreCoPassword?: string;
     /**
+     * @public
      * <p>The identifier (ID) of the cluster's security group.</p>
      */
     SecurityGroup?: string;
     /**
+     * @public
      * <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;
     /**
+     * @public
      * <p>The cluster's state.</p>
      */
     State?: ClusterState | string;
     /**
+     * @public
      * <p>A description of the cluster's state.</p>
      */
     StateMessage?: string;
     /**
+     * @public
      * <p>A map from availability zone to the cluster’s subnet in that availability zone.</p>
      */
     SubnetMapping?: Record<string, string>;
     /**
+     * @public
      * <p>The identifier (ID) of the virtual private cloud (VPC) that contains the
      *       cluster.</p>
      */
     VpcId?: string;
     /**
+     * @public
      * <p>Contains one or more certificates or a certificate signing request (CSR).</p>
      */
     Certificates?: Certificates;
     /**
+     * @public
      * <p>The list of tags for the cluster.</p>
      */
     TagList?: Tag[];
@@ -469,6 +525,7 @@ export interface Cluster {
  */
 export interface CreateClusterResponse {
     /**
+     * @public
      * <p>Information about the cluster that was created.</p>
      */
     Cluster?: Cluster;
@@ -478,15 +535,18 @@ export interface CreateClusterResponse {
  */
 export interface CreateHsmRequest {
     /**
+     * @public
      * <p>The identifier (ID) of the HSM's cluster. To find the cluster ID, use <a>DescribeClusters</a>.</p>
      */
     ClusterId: string | undefined;
     /**
+     * @public
      * <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;
     /**
+     * @public
      * <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>
@@ -498,6 +558,7 @@ export interface CreateHsmRequest {
  */
 export interface CreateHsmResponse {
     /**
+     * @public
      * <p>Information about the HSM that was created.</p>
      */
     Hsm?: Hsm;
@@ -507,6 +568,7 @@ export interface CreateHsmResponse {
  */
 export interface DeleteBackupRequest {
     /**
+     * @public
      * <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;
@@ -516,6 +578,7 @@ export interface DeleteBackupRequest {
  */
 export interface DeleteBackupResponse {
     /**
+     * @public
      * <p>Information on the <code>Backup</code> object deleted.</p>
      */
     Backup?: Backup;
@@ -525,6 +588,7 @@ export interface DeleteBackupResponse {
  */
 export interface DeleteClusterRequest {
     /**
+     * @public
      * <p>The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use
      *       <a>DescribeClusters</a>.</p>
      */
@@ -535,6 +599,7 @@ export interface DeleteClusterRequest {
  */
 export interface DeleteClusterResponse {
     /**
+     * @public
      * <p>Information about the cluster that was deleted.</p>
      */
     Cluster?: Cluster;
@@ -544,20 +609,24 @@ export interface DeleteClusterResponse {
  */
 export interface DeleteHsmRequest {
     /**
+     * @public
      * <p>The identifier (ID) of the cluster that contains the HSM that you are
      *       deleting.</p>
      */
     ClusterId: string | undefined;
     /**
+     * @public
      * <p>The identifier (ID) of the HSM that you are deleting.</p>
      */
     HsmId?: string;
     /**
+     * @public
      * <p>The identifier (ID) of the elastic network interface (ENI) of the HSM that you are
      *       deleting.</p>
      */
     EniId?: string;
     /**
+     * @public
      * <p>The IP address of the elastic network interface (ENI) of the HSM that you are
      *       deleting.</p>
      */
@@ -568,6 +637,7 @@ export interface DeleteHsmRequest {
  */
 export interface DeleteHsmResponse {
     /**
+     * @public
      * <p>The identifier (ID) of the HSM that was deleted.</p>
      */
     HsmId?: string;
@@ -577,16 +647,19 @@ export interface DeleteHsmResponse {
  */
 export interface DescribeBackupsRequest {
     /**
+     * @public
      * <p>The <code>NextToken</code> value that you received in the previous response. Use this
      *       value to get more backups.</p>
      */
     NextToken?: string;
     /**
+     * @public
      * <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;
     /**
+     * @public
      * <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>
@@ -603,6 +676,7 @@ export interface DescribeBackupsRequest {
      */
     Filters?: Record<string, string[]>;
     /**
+     * @public
      * <p>Designates whether or not to sort the return backups by ascending chronological order
      *       of generation.</p>
      */
@@ -613,10 +687,12 @@ export interface DescribeBackupsRequest {
  */
 export interface DescribeBackupsResponse {
     /**
+     * @public
      * <p>A list of backups.</p>
      */
     Backups?: Backup[];
     /**
+     * @public
      * <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>
@@ -628,6 +704,7 @@ export interface DescribeBackupsResponse {
  */
 export interface DescribeClustersRequest {
     /**
+     * @public
      * <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>
@@ -638,11 +715,13 @@ export interface DescribeClustersRequest {
      */
     Filters?: Record<string, string[]>;
     /**
+     * @public
      * <p>The <code>NextToken</code> value that you received in the previous response. Use this
      *       value to get more clusters.</p>
      */
     NextToken?: string;
     /**
+     * @public
      * <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>
      */
@@ -653,10 +732,12 @@ export interface DescribeClustersRequest {
  */
 export interface DescribeClustersResponse {
     /**
+     * @public
      * <p>A list of clusters.</p>
      */
     Clusters?: Cluster[];
     /**
+     * @public
      * <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>
@@ -668,16 +749,19 @@ export interface DescribeClustersResponse {
  */
 export interface InitializeClusterRequest {
     /**
+     * @public
      * <p>The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use
      *         <a>DescribeClusters</a>.</p>
      */
     ClusterId: string | undefined;
     /**
+     * @public
      * <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;
     /**
+     * @public
      * <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
@@ -690,10 +774,12 @@ export interface InitializeClusterRequest {
  */
 export interface InitializeClusterResponse {
     /**
+     * @public
      * <p>The cluster's state.</p>
      */
     State?: ClusterState | string;
     /**
+     * @public
      * <p>A description of the cluster's state.</p>
      */
     StateMessage?: string;
@@ -703,16 +789,19 @@ export interface InitializeClusterResponse {
  */
 export interface ListTagsRequest {
     /**
+     * @public
      * <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;
     /**
+     * @public
      * <p>The <code>NextToken</code> value that you received in the previous response. Use this
      *       value to get more tags.</p>
      */
     NextToken?: string;
     /**
+     * @public
      * <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>
      */
@@ -723,10 +812,12 @@ export interface ListTagsRequest {
  */
 export interface ListTagsResponse {
     /**
+     * @public
      * <p>A list of tags.</p>
      */
     TagList: Tag[] | undefined;
     /**
+     * @public
      * <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>
      */
@@ -737,10 +828,12 @@ export interface ListTagsResponse {
  */
 export interface ModifyBackupAttributesRequest {
     /**
+     * @public
      * <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;
     /**
+     * @public
      * <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>
      */
@@ -751,6 +844,7 @@ export interface ModifyBackupAttributesRequest {
  */
 export interface ModifyBackupAttributesResponse {
     /**
+     * @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
@@ -765,10 +859,12 @@ export interface ModifyBackupAttributesResponse {
  */
 export interface ModifyClusterRequest {
     /**
+     * @public
      * <p>A policy that defines how the service retains backups.</p>
      */
     BackupRetentionPolicy: BackupRetentionPolicy | undefined;
     /**
+     * @public
      * <p>The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use
      *         <a>DescribeClusters</a>.</p>
      */
@@ -779,6 +875,7 @@ export interface ModifyClusterRequest {
  */
 export interface ModifyClusterResponse {
     /**
+     * @public
      * <p>Contains information about an AWS CloudHSM cluster.</p>
      */
     Cluster?: Cluster;
@@ -788,6 +885,7 @@ export interface ModifyClusterResponse {
  */
 export interface RestoreBackupRequest {
     /**
+     * @public
      * <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;
@@ -797,6 +895,7 @@ export interface RestoreBackupRequest {
  */
 export interface RestoreBackupResponse {
     /**
+     * @public
      * <p>Information on the <code>Backup</code> object created.</p>
      */
     Backup?: Backup;
@@ -806,11 +905,13 @@ export interface RestoreBackupResponse {
  */
 export interface TagResourceRequest {
     /**
+     * @public
      * <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;
     /**
+     * @public
      * <p>A list of one or more tags.</p>
      */
     TagList: Tag[] | undefined;
@@ -825,11 +926,13 @@ export interface TagResourceResponse {
  */
 export interface UntagResourceRequest {
     /**
+     * @public
      * <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;
     /**
+     * @public
      * <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>
      */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-cloudhsm-v2",
   "description": "AWS SDK for JavaScript Cloudhsm V2 Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.385.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.385.0",
+    "@aws-sdk/credential-provider-node": "3.385.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",