<?php
// This file was auto-generated from sdk-root/src/data/cloudhsmv2/2017-04-28/docs-2.json
return [ 'version' => '2.0', 'service' => '<p>For more information about CloudHSM, see <a href="http://aws.amazon.com/cloudhsm/">CloudHSM</a> and the <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/"> CloudHSM User Guide</a>.</p>', 'operations' => [ 'CopyBackupToRegion' => '<p>Copy an CloudHSM cluster backup to a different region.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.</p>', 'CreateCluster' => '<p>Creates a new CloudHSM cluster.</p> <p> <b>Cross-account use:</b> Yes. To perform this operation with an CloudHSM backup in a different AWS account, specify the full backup ARN in the value of the SourceBackupId parameter.</p>', 'CreateHsm' => '<p>Creates a new hardware security module (HSM) in the specified CloudHSM cluster.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Service account.</p>', 'DeleteBackup' => '<p>Deletes a specified 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 <a>RestoreBackup</a>.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.</p>', 'DeleteCluster' => '<p>Deletes the specified 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 <a>DescribeClusters</a>. To delete an HSM, use <a>DeleteHsm</a>.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.</p>', 'DeleteHsm' => '<p>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 <a>DescribeClusters</a>.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM hsm in a different Amazon Web Services account.</p>', 'DeleteResourcePolicy' => '<p> Deletes an CloudHSM resource policy. Deleting a resource policy will result in the resource being unshared and removed from any RAM resource shares. Deleting the resource policy attached to a backup will not impact any clusters created from that backup.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.</p>', 'DescribeBackups' => '<p>Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true.</p> <p>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 <code>NextToken</code> value. Use this value in a subsequent <code>DescribeBackups</code> request to get more backups. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more backups to get.</p> <p> <b>Cross-account use:</b> Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.</p>', 'DescribeClusters' => '<p>Gets information about CloudHSM clusters.</p> <p>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 <code>NextToken</code> value. Use this value in a subsequent <code>DescribeClusters</code> request to get more clusters. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more clusters to get.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on CloudHSM clusters in a different Amazon Web Services account.</p>', 'GetResourcePolicy' => '<p> Retrieves the resource policy document attached to a given resource. </p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.</p>', 'InitializeCluster' => '<p>Claims an 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 <a>DescribeClusters</a>.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.</p>', 'ListTags' => '<p>Gets a list of tags for the specified CloudHSM cluster.</p> <p>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 <code>NextToken</code> value. Use this value in a subsequent <code>ListTags</code> request to get more tags. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more tags to get.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.</p>', 'ModifyBackupAttributes' => '<p>Modifies attributes for CloudHSM backup.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.</p>', 'ModifyCluster' => '<p>Modifies CloudHSM cluster.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.</p>', 'PutResourcePolicy' => '<p>Creates or updates an CloudHSM resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your CloudHSM resources. The following resources support CloudHSM resource policies: </p> <ul> <li> <p> Backup - The resource policy allows you to describe the backup and restore a cluster from the backup in another Amazon Web Services account.</p> </li> </ul> <p>In order to share a backup, it must be in a \'READY\' state and you must own it.</p> <important> <p>While you can share a backup using the CloudHSM PutResourcePolicy operation, we recommend using Resource Access Manager (RAM) instead. Using RAM provides multiple benefits as it creates the policy for you, allows multiple resources to be shared at one time, and increases the discoverability of shared resources. If you use PutResourcePolicy and want consumers to be able to describe the backups you share with them, you must promote the backup to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/sharing.html"> Working with shared backups</a> in the CloudHSM User Guide</p> </important> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.</p>', 'RestoreBackup' => '<p>Restores a specified CloudHSM backup that is in the <code>PENDING_DELETION</code> state. For more information on deleting a backup, see <a>DeleteBackup</a>.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.</p>', 'TagResource' => '<p>Adds or overwrites one or more tags for the specified CloudHSM cluster.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.</p>', 'UntagResource' => '<p>Removes the specified tag or tags from the specified CloudHSM cluster.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.</p>', ], 'shapes' => [ 'Backup' => [ 'base' => '<p>Contains information about a backup of an 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>', 'refs' => [ 'Backups$member' => NULL, 'DeleteBackupResponse$Backup' => '<p>Information on the <code>Backup</code> object deleted.</p>', 'ModifyBackupAttributesResponse$Backup' => NULL, 'RestoreBackupResponse$Backup' => '<p>Information on the <code>Backup</code> object created.</p>', ], ], 'BackupArn' => [ 'base' => NULL, 'refs' => [ 'Backup$BackupArn' => '<p>The Amazon Resource Name (ARN) of the backup.</p>', 'CreateClusterRequest$SourceBackupId' => '<p>The identifier (ID) or the Amazon Resource Name (ARN) 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 or ARN, use <a>DescribeBackups</a>. <i>If using a backup in another account, the full ARN must be supplied.</i> </p>', ], ], 'BackupId' => [ 'base' => NULL, 'refs' => [ 'Backup$BackupId' => '<p>The identifier (ID) of the backup.</p>', 'Backup$SourceBackup' => '<p>The identifier (ID) of the source backup from which the new backup was copied.</p>', 'Cluster$SourceBackupId' => '<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>', 'CopyBackupToRegionRequest$BackupId' => '<p>The ID of the backup that will be copied to the destination region. </p>', 'DeleteBackupRequest$BackupId' => '<p>The ID of the backup to be deleted. To find the ID of a backup, use the <a>DescribeBackups</a> operation.</p>', 'DestinationBackup$SourceBackup' => '<p>The identifier (ID) of the source backup from which the new backup was copied.</p>', 'ModifyBackupAttributesRequest$BackupId' => '<p>The identifier (ID) of the backup to modify. To find the ID of a backup, use the <a>DescribeBackups</a> operation.</p>', 'RestoreBackupRequest$BackupId' => '<p>The ID of the backup to be restored. To find the ID of a backup, use the <a>DescribeBackups</a> operation.</p>', ], ], 'BackupPolicy' => [ 'base' => NULL, 'refs' => [ 'Cluster$BackupPolicy' => '<p>The cluster\'s backup policy.</p>', ], ], 'BackupRetentionPolicy' => [ 'base' => '<p>A policy that defines the number of days to retain backups.</p>', 'refs' => [ 'Cluster$BackupRetentionPolicy' => '<p>A policy that defines how the service retains backups.</p>', 'CreateClusterRequest$BackupRetentionPolicy' => '<p>A policy that defines how the service retains backups.</p>', 'ModifyClusterRequest$BackupRetentionPolicy' => '<p>A policy that defines how the service retains backups.</p>', ], ], 'BackupRetentionType' => [ 'base' => NULL, 'refs' => [ 'BackupRetentionPolicy$Type' => '<p>The type of backup retention policy. For the <code>DAYS</code> type, the value is the number of days to retain backups.</p>', ], ], 'BackupRetentionValue' => [ 'base' => NULL, 'refs' => [ 'BackupRetentionPolicy$Value' => '<p>Use a value between 7 - 379.</p>', ], ], 'BackupState' => [ 'base' => NULL, 'refs' => [ 'Backup$BackupState' => '<p>The state of the backup.</p>', ], ], 'Backups' => [ 'base' => NULL, 'refs' => [ 'DescribeBackupsResponse$Backups' => '<p>A list of backups.</p>', ], ], 'BackupsMaxSize' => [ 'base' => NULL, 'refs' => [ 'DescribeBackupsRequest$MaxResults' => '<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>', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'Backup$NeverExpires' => '<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>', 'DescribeBackupsRequest$Shared' => '<p>Describe backups that are shared with you.</p> <note> <p>By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM <a href="https://docs.aws.amazon.com/cli/latest/reference/ram/promote-resource-share-created-from-policy.html">PromoteResourceShareCreatedFromPolicy</a> API operation. For more information about sharing backups, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/sharing.html"> Working with shared backups</a> in the CloudHSM User Guide.</p> </note>', 'DescribeBackupsRequest$SortAscending' => '<p>Designates whether or not to sort the return backups by ascending chronological order of generation.</p>', 'ModifyBackupAttributesRequest$NeverExpires' => '<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>', ], ], 'Cert' => [ 'base' => NULL, 'refs' => [ 'Certificates$ClusterCsr' => '<p>The cluster\'s certificate signing request (CSR). The CSR exists only when the cluster\'s state is <code>UNINITIALIZED</code>.</p>', 'Certificates$HsmCertificate' => '<p>The HSM certificate issued (signed) by the HSM hardware.</p>', 'Certificates$AwsHardwareCertificate' => '<p>The HSM hardware certificate issued (signed) by CloudHSM.</p>', 'Certificates$ManufacturerHardwareCertificate' => '<p>The HSM hardware certificate issued (signed) by the hardware manufacturer.</p>', 'Certificates$ClusterCertificate' => '<p>The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster\'s owner.</p>', 'InitializeClusterRequest$SignedCert' => '<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>', 'InitializeClusterRequest$TrustAnchor' => '<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>', ], ], 'Certificates' => [ 'base' => '<p>Contains one or more certificates or a certificate signing request (CSR).</p>', 'refs' => [ 'Cluster$Certificates' => '<p>Contains one or more certificates or a certificate signing request (CSR).</p>', ], ], 'CloudHsmAccessDeniedException' => [ 'base' => '<p>The request was rejected because the requester does not have permission to perform the requested operation.</p>', 'refs' => [], ], 'CloudHsmArn' => [ 'base' => NULL, 'refs' => [ 'DeleteResourcePolicyRequest$ResourceArn' => '<p>Amazon Resource Name (ARN) of the resource from which the policy will be removed. </p>', 'DeleteResourcePolicyResponse$ResourceArn' => '<p>Amazon Resource Name (ARN) of the resource from which the policy was deleted. </p>', 'GetResourcePolicyRequest$ResourceArn' => '<p>Amazon Resource Name (ARN) of the resource to which a policy is attached.</p>', 'PutResourcePolicyRequest$ResourceArn' => '<p>Amazon Resource Name (ARN) of the resource to which you want to attach a policy. </p>', 'PutResourcePolicyResponse$ResourceArn' => '<p>Amazon Resource Name (ARN) of the resource to which a policy is attached.</p>', ], ], 'CloudHsmInternalFailureException' => [ 'base' => '<p>The request was rejected because of an CloudHSM internal failure. The request can be retried.</p>', 'refs' => [], ], 'CloudHsmInvalidRequestException' => [ 'base' => '<p>The request was rejected because it is not a valid request.</p>', 'refs' => [], ], 'CloudHsmResourceLimitExceededException' => [ 'base' => '<p>The request was rejected because it exceeds an CloudHSM limit.</p>', 'refs' => [], ], 'CloudHsmResourceNotFoundException' => [ 'base' => '<p>The request was rejected because it refers to a resource that cannot be found.</p>', 'refs' => [], ], 'CloudHsmServiceException' => [ 'base' => '<p>The request was rejected because an error occurred.</p>', 'refs' => [], ], 'CloudHsmTagException' => [ 'base' => '<p>The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.</p>', 'refs' => [], ], 'Cluster' => [ 'base' => '<p>Contains information about an CloudHSM cluster.</p>', 'refs' => [ 'Clusters$member' => NULL, 'CreateClusterResponse$Cluster' => '<p>Information about the cluster that was created.</p>', 'DeleteClusterResponse$Cluster' => '<p>Information about the cluster that was deleted.</p>', 'ModifyClusterResponse$Cluster' => NULL, ], ], 'ClusterId' => [ 'base' => NULL, 'refs' => [ 'Backup$ClusterId' => '<p>The identifier (ID) of the cluster that was backed up.</p>', 'Backup$SourceCluster' => '<p>The identifier (ID) of the cluster containing the source backup from which the new backup was copied.</p>', 'Cluster$ClusterId' => '<p>The cluster\'s identifier (ID).</p>', 'CreateHsmRequest$ClusterId' => '<p>The identifier (ID) of the HSM\'s cluster. To find the cluster ID, use <a>DescribeClusters</a>.</p>', 'DeleteClusterRequest$ClusterId' => '<p>The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use <a>DescribeClusters</a>.</p>', 'DeleteHsmRequest$ClusterId' => '<p>The identifier (ID) of the cluster that contains the HSM that you are deleting.</p>', 'DestinationBackup$SourceCluster' => '<p>The identifier (ID) of the cluster containing the source backup from which the new backup was copied.</p>', 'Hsm$ClusterId' => '<p>The identifier (ID) of the cluster that contains the HSM.</p>', 'InitializeClusterRequest$ClusterId' => '<p>The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use <a>DescribeClusters</a>.</p>', 'ModifyClusterRequest$ClusterId' => '<p>The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use <a>DescribeClusters</a>.</p>', ], ], 'ClusterMode' => [ 'base' => NULL, 'refs' => [ 'Backup$Mode' => '<p>The mode of the cluster that was backed up.</p>', 'Cluster$Mode' => '<p>The mode of the cluster.</p>', 'CreateClusterRequest$Mode' => '<p>The mode to use in the cluster. The allowed values are <code>FIPS</code> and <code>NON_FIPS</code>.</p>', ], ], 'ClusterState' => [ 'base' => NULL, 'refs' => [ 'Cluster$State' => '<p>The cluster\'s state.</p>', 'InitializeClusterResponse$State' => '<p>The cluster\'s state.</p>', ], ], 'Clusters' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$Clusters' => '<p>A list of clusters.</p>', ], ], 'ClustersMaxSize' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersRequest$MaxResults' => '<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>', ], ], 'CopyBackupToRegionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CopyBackupToRegionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateHsmRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateHsmResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBackupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBackupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHsmRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteHsmResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBackupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeBackupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'DestinationBackup' => [ 'base' => '<p>Contains information about the backup that will be copied and created by the <a>CopyBackupToRegion</a> operation.</p>', 'refs' => [ 'CopyBackupToRegionResponse$DestinationBackup' => '<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>', ], ], 'EniId' => [ 'base' => NULL, 'refs' => [ 'DeleteHsmRequest$EniId' => '<p>The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.</p>', 'Hsm$EniId' => '<p>The identifier (ID) of the HSM\'s elastic network interface (ENI).</p>', ], ], 'ExternalAz' => [ 'base' => NULL, 'refs' => [ 'CreateHsmRequest$AvailabilityZone' => '<p>The Availability Zone where you are creating the HSM. To find the cluster\'s Availability Zones, use <a>DescribeClusters</a>.</p>', 'ExternalSubnetMapping$key' => NULL, 'Hsm$AvailabilityZone' => '<p>The Availability Zone that contains the HSM.</p>', ], ], 'ExternalSubnetMapping' => [ 'base' => NULL, 'refs' => [ 'Cluster$SubnetMapping' => '<p>A map from availability zone to the cluster’s subnet in that availability zone.</p>', ], ], 'Field' => [ 'base' => NULL, 'refs' => [ 'Filters$key' => NULL, ], ], 'Filters' => [ 'base' => NULL, 'refs' => [ 'DescribeBackupsRequest$Filters' => '<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>', 'DescribeClustersRequest$Filters' => '<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>', ], ], 'GetResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'Hsm' => [ 'base' => '<p>Contains information about a hardware security module (HSM) in an CloudHSM cluster.</p>', 'refs' => [ 'CreateHsmResponse$Hsm' => '<p>Information about the HSM that was created.</p>', 'Hsms$member' => NULL, ], ], 'HsmId' => [ 'base' => NULL, 'refs' => [ 'DeleteHsmRequest$HsmId' => '<p>The identifier (ID) of the HSM that you are deleting.</p>', 'DeleteHsmResponse$HsmId' => '<p>The identifier (ID) of the HSM that was deleted.</p>', 'Hsm$HsmId' => '<p>The HSM\'s identifier (ID).</p>', ], ], 'HsmState' => [ 'base' => NULL, 'refs' => [ 'Hsm$State' => '<p>The HSM\'s state.</p>', ], ], 'HsmType' => [ 'base' => NULL, 'refs' => [ 'Backup$HsmType' => '<p>The HSM type used to create the backup.</p>', 'Cluster$HsmType' => '<p>The type of HSM that the cluster contains.</p>', 'CreateClusterRequest$HsmType' => '<p>The type of HSM to use in the cluster. The allowed values are <code>hsm1.medium</code> and <code>hsm2m.medium</code>.</p>', 'Hsm$HsmType' => '<p>The type of HSM.</p>', 'ModifyClusterRequest$HsmType' => '<p>The desired HSM type of the cluster.</p>', ], ], 'Hsms' => [ 'base' => NULL, 'refs' => [ 'Cluster$Hsms' => '<p>Contains information about the HSMs in the cluster.</p>', ], ], 'InitializeClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'InitializeClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'IpAddress' => [ 'base' => NULL, 'refs' => [ 'CreateHsmRequest$IpAddress' => '<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>', 'DeleteHsmRequest$EniIp' => '<p>The IP address of the elastic network interface (ENI) of the HSM that you are deleting.</p>', 'Hsm$EniIp' => '<p>The IP address of the HSM\'s elastic network interface (ENI).</p>', ], ], 'IpV6Address' => [ 'base' => NULL, 'refs' => [ 'Hsm$EniIpV6' => '<p>The IPv6 address (if any) of the HSM\'s elastic network interface (ENI).</p>', ], ], 'ListTagsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxSize' => [ 'base' => NULL, 'refs' => [ 'ListTagsRequest$MaxResults' => '<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>', ], ], 'ModifyBackupAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyBackupAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ModifyClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'ModifyClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'NetworkType' => [ 'base' => NULL, 'refs' => [ 'Cluster$NetworkType' => '<p>The cluster\'s NetworkType can be IPv4 (the default) or DUALSTACK. The IPv4 NetworkType restricts communication between your application and the hardware security modules (HSMs) to the IPv4 protocol only. The DUALSTACK NetworkType enables communication over both IPv4 and IPv6 protocols. To use DUALSTACK, configure your virtual private cloud (VPC) and subnets to support both IPv4 and IPv6. This configuration involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The NetworkType you choose affects the network addressing options for your cluster. DUALSTACK provides more flexibility by supporting both IPv4 and IPv6 communication.</p>', 'CreateClusterRequest$NetworkType' => '<p>The NetworkType to create a cluster with. The allowed values are <code>IPV4</code> and <code>DUALSTACK</code>. </p>', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeBackupsRequest$NextToken' => '<p>The <code>NextToken</code> value that you received in the previous response. Use this value to get more backups.</p>', 'DescribeBackupsResponse$NextToken' => '<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>', 'DescribeClustersRequest$NextToken' => '<p>The <code>NextToken</code> value that you received in the previous response. Use this value to get more clusters.</p>', 'DescribeClustersResponse$NextToken' => '<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>', 'ListTagsRequest$NextToken' => '<p>The <code>NextToken</code> value that you received in the previous response. Use this value to get more tags.</p>', 'ListTagsResponse$NextToken' => '<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>', ], ], 'PreCoPassword' => [ 'base' => NULL, 'refs' => [ 'Cluster$PreCoPassword' => '<p>The default password for the cluster\'s Pre-Crypto Officer (PRECO) user.</p>', ], ], 'PutResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'Backup$SourceRegion' => '<p>The AWS Region that contains the source backup from which the new backup was copied.</p>', 'CopyBackupToRegionRequest$DestinationRegion' => '<p>The AWS region that will contain your copied CloudHSM cluster backup.</p>', 'DestinationBackup$SourceRegion' => '<p>The AWS region that contains the source backup from which the new backup was copied.</p>', ], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'ListTagsRequest$ResourceId' => '<p>The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use <a>DescribeClusters</a>.</p>', 'TagResourceRequest$ResourceId' => '<p>The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use <a>DescribeClusters</a>.</p>', 'UntagResourceRequest$ResourceId' => '<p>The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use <a>DescribeClusters</a>.</p>', ], ], 'ResourcePolicy' => [ 'base' => NULL, 'refs' => [ 'DeleteResourcePolicyResponse$Policy' => '<p>The policy previously attached to the resource.</p>', 'GetResourcePolicyResponse$Policy' => '<p>The policy attached to a resource.</p>', 'PutResourcePolicyRequest$Policy' => '<p>The policy you want to associate with a resource. </p> <p>For an example policy, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/sharing.html"> Working with shared backups</a> in the CloudHSM User Guide</p>', 'PutResourcePolicyResponse$Policy' => '<p>The policy attached to a resource.</p>', ], ], 'RestoreBackupRequest' => [ 'base' => NULL, 'refs' => [], ], 'RestoreBackupResponse' => [ 'base' => NULL, 'refs' => [], ], 'SecurityGroup' => [ 'base' => NULL, 'refs' => [ 'Cluster$SecurityGroup' => '<p>The identifier (ID) of the cluster\'s security group.</p>', ], ], 'StateMessage' => [ 'base' => NULL, 'refs' => [ 'Cluster$StateMessage' => '<p>A description of the cluster\'s state.</p>', 'InitializeClusterResponse$StateMessage' => '<p>A description of the cluster\'s state.</p>', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'Hsm$StateMessage' => '<p>A description of the HSM\'s state.</p>', 'Strings$member' => NULL, ], ], 'Strings' => [ 'base' => NULL, 'refs' => [ 'Filters$value' => NULL, ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'ExternalSubnetMapping$value' => NULL, 'Hsm$SubnetId' => '<p>The subnet that contains the HSM\'s elastic network interface (ENI).</p>', 'SubnetIds$member' => NULL, ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'CreateClusterRequest$SubnetIds' => '<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>', ], ], 'Tag' => [ 'base' => '<p>Contains a tag. A tag is a key-value pair.</p>', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '<p>The key of the tag.</p>', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeyList' => '<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>', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'Backup$TagList' => '<p>The list of tags for the backup.</p>', 'Cluster$TagList' => '<p>The list of tags for the cluster.</p>', 'CopyBackupToRegionRequest$TagList' => '<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>', 'CreateClusterRequest$TagList' => '<p>Tags to apply to the CloudHSM cluster during creation.</p>', 'ListTagsResponse$TagList' => '<p>A list of tags.</p>', 'TagResourceRequest$TagList' => '<p>A list of one or more tags.</p>', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '<p>The value of the tag.</p>', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Backup$CreateTimestamp' => '<p>The date and time when the backup was created.</p>', 'Backup$CopyTimestamp' => '<p>The date and time when the backup was copied from a source backup.</p>', 'Backup$DeleteTimestamp' => '<p>The date and time when the backup will be permanently deleted.</p>', 'Cluster$CreateTimestamp' => '<p>The date and time when the cluster was created.</p>', 'Cluster$HsmTypeRollbackExpiration' => '<p>The timestamp until when the cluster can be rolled back to its original HSM type.</p>', 'DestinationBackup$CreateTimestamp' => '<p>The date and time when both the source backup was created.</p>', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'Cluster$VpcId' => '<p>The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.</p>', ], ], 'errorMessage' => [ 'base' => NULL, 'refs' => [ 'CloudHsmAccessDeniedException$Message' => NULL, 'CloudHsmInternalFailureException$Message' => NULL, 'CloudHsmInvalidRequestException$Message' => NULL, 'CloudHsmResourceLimitExceededException$Message' => NULL, 'CloudHsmResourceNotFoundException$Message' => NULL, 'CloudHsmServiceException$Message' => NULL, 'CloudHsmTagException$Message' => NULL, ], ], ],];
