AWS.Tools.CloudHSMV2.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CloudHSMV2</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.AddHSM2ResourceTagCmdlet"> <summary> Adds or overwrites one or more tags for the specified AWS CloudHSM cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.AddHSM2ResourceTagCmdlet.ResourceId"> <summary> <para> <para>The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use <a>DescribeClusters</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.AddHSM2ResourceTagCmdlet.TagList"> <summary> <para> <para>A list of one or more tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.AddHSM2ResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.AddHSM2ResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.CopyHSM2BackupToRegionCmdlet"> <summary> Copy an AWS CloudHSM cluster backup to a different region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.CopyHSM2BackupToRegionCmdlet.BackupId"> <summary> <para> <para>The ID of the backup that will be copied to the destination region. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.CopyHSM2BackupToRegionCmdlet.DestinationRegion"> <summary> <para> <para>The AWS region that will contain your copied CloudHSM cluster backup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.CopyHSM2BackupToRegionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2BackupCmdlet"> <summary> Gets information about backups of AWS CloudHSM clusters. <para> 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. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2BackupCmdlet.Filter"> <summary> <para> <para>One or more filters to limit the items returned in the response.</para><para>Use the <code>backupIds</code> filter to return only the specified backups. Specify backups by their backup identifier (ID).</para><para>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.</para><para>Use the <code>clusterIds</code> filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).</para><para>Use the <code>states</code> filter to return only backups that match the specified state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2BackupCmdlet.SortAscending"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2BackupCmdlet.MaxResult"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2BackupCmdlet.NextToken"> <summary> <para> <para>The <code>NextToken</code> value that you received in the previous response. Use this value to get more backups.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ClusterCmdlet"> <summary> Gets information about AWS CloudHSM clusters. <para> 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. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ClusterCmdlet.Filter"> <summary> <para> <para>One or more filters to limit the items returned in the response.</para><para>Use the <code>clusterIds</code> filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).</para><para>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).</para><para>Use the <code>states</code> filter to return only clusters that match the specified state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ClusterCmdlet.MaxResult"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ClusterCmdlet.NextToken"> <summary> <para> <para>The <code>NextToken</code> value that you received in the previous response. Use this value to get more clusters.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ResourceTagCmdlet"> <summary> Gets a list of tags for the specified AWS CloudHSM cluster. <para> 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. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ResourceTagCmdlet.ResourceId"> <summary> <para> <para>The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use <a>DescribeClusters</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ResourceTagCmdlet.MaxResult"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ResourceTagCmdlet.NextToken"> <summary> <para> <para>The <code>NextToken</code> value that you received in the previous response. Use this value to get more tags.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.InitializeHSM2ClusterCmdlet"> <summary> 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 <a>DescribeClusters</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.InitializeHSM2ClusterCmdlet.ClusterId"> <summary> <para> <para>The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use <a>DescribeClusters</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.InitializeHSM2ClusterCmdlet.SignedCert"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.InitializeHSM2ClusterCmdlet.TrustAnchor"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.InitializeHSM2ClusterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2ClusterCmdlet"> <summary> Creates a new AWS CloudHSM cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2ClusterCmdlet.HsmType"> <summary> <para> <para>The type of HSM to use in the cluster. Currently the only allowed value is <code>hsm1.medium</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2ClusterCmdlet.SourceBackupId"> <summary> <para> <para>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>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2ClusterCmdlet.SubnetId"> <summary> <para> <para>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:</para><ul><li><para>All subnets must be in the same virtual private cloud (VPC).</para></li><li><para>You can specify only one subnet per Availability Zone.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2ClusterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2HsmCmdlet"> <summary> Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2HsmCmdlet.AvailabilityZone"> <summary> <para> <para>The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use <a>DescribeClusters</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2HsmCmdlet.ClusterId"> <summary> <para> <para>The identifier (ID) of the HSM's cluster. To find the cluster ID, use <a>DescribeClusters</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2HsmCmdlet.IpAddress"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2HsmCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2BackupCmdlet"> <summary> 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 <a>RestoreBackup</a> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2BackupCmdlet.BackupId"> <summary> <para> <para>The ID of the backup to be deleted. To find the ID of a backup, use the <a>DescribeBackups</a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2BackupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2ClusterCmdlet"> <summary> 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 <a>DescribeClusters</a>. To delete an HSM, use <a>DeleteHsm</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2ClusterCmdlet.ClusterId"> <summary> <para> <para>The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use <a>DescribeClusters</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2ClusterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2HsmCmdlet"> <summary> 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>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2HsmCmdlet.ClusterId"> <summary> <para> <para>The identifier (ID) of the cluster that contains the HSM that you are deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2HsmCmdlet.EniId"> <summary> <para> <para>The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2HsmCmdlet.EniIp"> <summary> <para> <para>The IP address of the elastic network interface (ENI) of the HSM that you are deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2HsmCmdlet.HsmId"> <summary> <para> <para>The identifier (ID) of the HSM that you are deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2HsmCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2ResourceTagCmdlet"> <summary> Removes the specified tag or tags from the specified AWS CloudHSM cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2ResourceTagCmdlet.ResourceId"> <summary> <para> <para>The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use <a>DescribeClusters</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2ResourceTagCmdlet.TagKeyList"> <summary> <para> <para>A list of one or more tag keys for the tags that you are removing. Specify only the tag keys, not the tag values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2ResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2ResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.RestoreHSM2BackupCmdlet"> <summary> Restores a specified AWS CloudHSM backup that is in the <code>PENDING_DELETION</code> state. For more information on deleting a backup, see <a>DeleteBackup</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RestoreHSM2BackupCmdlet.BackupId"> <summary> <para> <para>The ID of the backup to be restored. To find the ID of a backup, use the <a>DescribeBackups</a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RestoreHSM2BackupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |