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 CloudHSM cluster. <para><b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account. </para> </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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 CloudHSM cluster backup to a different region. <para><b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account. </para> </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.TagList"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.CopyHSM2BackupToRegionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DestinationBackup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.CopyBackupToRegionResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.CopyBackupToRegionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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.EditHSM2BackupAttributeCmdlet"> <summary> Modifies attributes for CloudHSM backup. <para><b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.EditHSM2BackupAttributeCmdlet.BackupId"> <summary> <para> <para>The identifier (ID) of the backup to modify. To find the ID of a backup, use the <a>DescribeBackups</a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.EditHSM2BackupAttributeCmdlet.NeverExpire"> <summary> <para> <para>Specifies whether the service should exempt a backup from the retention policy for the cluster. <c>True</c> exempts a backup from the retention policy. <c>False</c> means the service applies the backup retention policy defined at the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.EditHSM2BackupAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Backup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.ModifyBackupAttributesResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.ModifyBackupAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.EditHSM2BackupAttributeCmdlet.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.EditHSM2ClusterCmdlet"> <summary> Modifies CloudHSM cluster. <para><b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.EditHSM2ClusterCmdlet.ClusterId"> <summary> <para> <para>The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use <a>DescribeClusters</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.EditHSM2ClusterCmdlet.BackupRetentionPolicy_Type"> <summary> <para> <para>The type of backup retention policy. For the <c>DAYS</c> type, the value is the number of days to retain backups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.EditHSM2ClusterCmdlet.BackupRetentionPolicy_Value"> <summary> <para> <para>Use a value between 7 - 379.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.EditHSM2ClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.ModifyClusterResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.ModifyClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.EditHSM2ClusterCmdlet.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 CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true. <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 <c>NextToken</c> value. Use this value in a subsequent <c>DescribeBackups</c> request to get more backups. When you receive a response with no <c>NextToken</c> (or an empty or null value), that means there are no more backups to get. </para><para><b>Cross-account use:</b> Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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 <c>backupIds</c> filter to return only the specified backups. Specify backups by their backup identifier (ID).</para><para>Use the <c>sourceBackupIds</c> filter to return only the backups created from a source backup. The <c>sourceBackupID</c> of a source backup is returned by the <a>CopyBackupToRegion</a> operation.</para><para>Use the <c>clusterIds</c> filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).</para><para>Use the <c>states</c> filter to return only backups that match the specified state.</para><para>Use the <c>neverExpires</c> filter to return backups filtered by the value in the <c>neverExpires</c> parameter. <c>True</c> returns all backups exempt from the backup retention policy. <c>False</c> returns all backups with a backup retention policy defined at the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2BackupCmdlet.Shared"> <summary> <para> <para>Describe backups that are shared with you.</para><note><para>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.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2BackupCmdlet.SortAscending"> <summary> <para> <para>Designates whether or not to sort the return backups by ascending chronological order of generation.</para> </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 <c>NextToken</c> value.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2BackupCmdlet.NextToken"> <summary> <para> <para>The <c>NextToken</c> 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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2BackupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Backups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.DescribeBackupsResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.DescribeBackupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2BackupCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ClusterCmdlet"> <summary> Gets information about 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 <c>NextToken</c> value. Use this value in a subsequent <c>DescribeClusters</c> request to get more clusters. When you receive a response with no <c>NextToken</c> (or an empty or null value), that means there are no more clusters to get. </para><para><b>Cross-account use:</b> No. You cannot perform this operation on CloudHSM clusters in a different Amazon Web Services account. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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 <c>clusterIds</c> filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).</para><para>Use the <c>vpcIds</c> filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).</para><para>Use the <c>states</c> 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 <c>NextToken</c> value.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ClusterCmdlet.NextToken"> <summary> <para> <para>The <c>NextToken</c> 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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Clusters'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.DescribeClustersResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.DescribeClustersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ClusterCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ResourcePolicyCmdlet"> <summary> Retrieves the resource policy document attached to a given resource. <para><b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para>Amazon Resource Name (ARN) of the resource to which a policy is attached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.GetResourcePolicyResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.GetResourcePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ResourceTagCmdlet"> <summary> Gets a list of tags for the specified 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 <c>NextToken</c> value. Use this value in a subsequent <c>ListTags</c> request to get more tags. When you receive a response with no <c>NextToken</c> (or an empty or null value), that means there are no more tags to get. </para><para><b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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 <c>NextToken</c> value.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ResourceTagCmdlet.NextToken"> <summary> <para> <para>The <c>NextToken</c> 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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TagList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.ListTagsResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.ListTagsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.GetHSM2ResourceTagCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.InitializeHSM2ClusterCmdlet"> <summary> 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>. <para><b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account. </para> </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. 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.InitializeHSM2ClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.InitializeClusterResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.InitializeClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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 CloudHSM cluster. <para><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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2ClusterCmdlet.HsmType"> <summary> <para> <para>The type of HSM to use in the cluster. The allowed values are <c>hsm1.medium</c> and <c>hsm2m.medium</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2ClusterCmdlet.Mode"> <summary> <para> <para>The mode to use in the cluster. The allowed values are <c>FIPS</c> and <c>NON_FIPS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2ClusterCmdlet.SourceBackupId"> <summary> <para> <para>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></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.TagList"> <summary> <para> <para>Tags to apply to the CloudHSM cluster during creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2ClusterCmdlet.BackupRetentionPolicy_Type"> <summary> <para> <para>The type of backup retention policy. For the <c>DAYS</c> type, the value is the number of days to retain backups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2ClusterCmdlet.BackupRetentionPolicy_Value"> <summary> <para> <para>Use a value between 7 - 379.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.NewHSM2ClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.CreateClusterResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.CreateClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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 CloudHSM cluster. <para><b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Service account. </para> </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Hsm'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.CreateHsmResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.CreateHsmResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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 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>. <para><b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account. </para> </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Backup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.DeleteBackupResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.DeleteBackupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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 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>. <para><b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account. </para> </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.DeleteClusterResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.DeleteClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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>. <para><b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM hsm in a different Amazon Web Services account. </para> </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HsmId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.DeleteHsmResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.DeleteHsmResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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.RemoveHSM2ResourcePolicyCmdlet"> <summary> 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. <para><b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2ResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para>Amazon Resource Name (ARN) of the resource from which the policy will be removed. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2ResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.DeleteResourcePolicyResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.DeleteResourcePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.RemoveHSM2ResourcePolicyCmdlet.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 CloudHSM cluster. <para><b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account. </para> </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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 CloudHSM backup that is in the <c>PENDING_DELETION</c> state. For more information on deleting a backup, see <a>DeleteBackup</a>. <para><b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account. </para> </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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Backup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.RestoreBackupResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.RestoreBackupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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> <member name="T:Amazon.PowerShell.Cmdlets.HSM2.WriteHSM2ResourcePolicyCmdlet"> <summary> 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: <ul><li><para> Backup - The resource policy allows you to describe the backup and restore a cluster from the backup in another Amazon Web Services account. </para></li></ul><para> In order to share a backup, it must be in a 'READY' state and you must own it. </para><important><para> 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 </para></important><para><b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.WriteHSM2ResourcePolicyCmdlet.Policy"> <summary> <para> <para>The policy you want to associate with a resource. </para><para>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</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.WriteHSM2ResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para>Amazon Resource Name (ARN) of the resource to which you want to attach a policy. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.WriteHSM2ResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudHSMV2.Model.PutResourcePolicyResponse). Specifying the name of a property of type Amazon.CloudHSMV2.Model.PutResourcePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.HSM2.WriteHSM2ResourcePolicyCmdlet.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> |