AWS.Tools.Backup.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Backup</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.BAK.AddBAKResourceTagCmdlet"> <summary> Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.AddBAKResourceTagCmdlet.ResourceArn"> <summary> <para> <para>An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.AddBAKResourceTagCmdlet.Tag"> <summary> <para> <para>Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create. For clarity, this is the structure to assign tags: <c>[{"Key":"string","Value":"string"}]</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.AddBAKResourceTagCmdlet.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.Backup.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.AddBAKResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.AddBAKResourceTagCmdlet.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.BAK.ExportBAKBackupPlanTemplateCmdlet"> <summary> Returns the backup plan that is specified by the plan ID as a backup template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.ExportBAKBackupPlanTemplateCmdlet.BackupPlanId"> <summary> <para> <para>Uniquely identifies a backup plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.ExportBAKBackupPlanTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BackupPlanTemplateJson'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ExportBackupPlanTemplateResponse). Specifying the name of a property of type Amazon.Backup.Model.ExportBackupPlanTemplateResponse 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.BAK.ExportBAKBackupPlanTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupPlanId parameter. The -PassThru parameter is deprecated, use -Select '^BackupPlanId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.ExportBAKBackupPlanTemplateCmdlet.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.BAK.GetBAKBackupJobCmdlet"> <summary> Returns backup job details for the specified <c>BackupJobId</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobCmdlet.BackupJobId"> <summary> <para> <para>Uniquely identifies a request to Backup to back up a resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobCmdlet.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.Backup.Model.DescribeBackupJobResponse). Specifying the name of a property of type Amazon.Backup.Model.DescribeBackupJobResponse 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.BAK.GetBAKBackupJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupJobId parameter. The -PassThru parameter is deprecated, use -Select '^BackupJobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobListCmdlet"> <summary> Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">monitoring tools</a>.<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.BAK.GetBAKBackupJobListCmdlet.ByAccountId"> <summary> <para> <para>The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.</para><para>If used from an Organizations management account, passing <c>*</c> returns all jobs across the organization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobListCmdlet.ByBackupVaultName"> <summary> <para> <para>Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobListCmdlet.ByCompleteAfter"> <summary> <para> <para>Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobListCmdlet.ByCompleteBefore"> <summary> <para> <para>Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobListCmdlet.ByCreatedAfter"> <summary> <para> <para>Returns only backup jobs that were created after the specified date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobListCmdlet.ByCreatedBefore"> <summary> <para> <para>Returns only backup jobs that were created before the specified date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobListCmdlet.ByMessageCategory"> <summary> <para> <para>This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.</para><para>Example strings may include <c>AccessDenied</c>, <c>SUCCESS</c>, <c>AGGREGATE_ALL</c>, and <c>InvalidParameters</c>.</para><para>View <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a></para><para>The wildcard () returns count of all message categories.</para><para><c>AGGREGATE_ALL</c> aggregates job counts for all message categories and returns the sum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobListCmdlet.ByParentJobId"> <summary> <para> <para>This is a filter to list child (nested) jobs based on parent job ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobListCmdlet.ByResourceArn"> <summary> <para> <para>Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobListCmdlet.ByResourceType"> <summary> <para> <para>Returns only backup jobs for the specified resources:</para><ul><li><para><c>Aurora</c> for Amazon Aurora</para></li><li><para><c>CloudFormation</c> for CloudFormation</para></li><li><para><c>DocumentDB</c> for Amazon DocumentDB (with MongoDB compatibility)</para></li><li><para><c>DynamoDB</c> for Amazon DynamoDB</para></li><li><para><c>EBS</c> for Amazon Elastic Block Store</para></li><li><para><c>EC2</c> for Amazon Elastic Compute Cloud</para></li><li><para><c>EFS</c> for Amazon Elastic File System</para></li><li><para><c>FSx</c> for Amazon FSx</para></li><li><para><c>Neptune</c> for Amazon Neptune</para></li><li><para><c>Redshift</c> for Amazon Redshift</para></li><li><para><c>RDS</c> for Amazon Relational Database Service</para></li><li><para><c>SAP HANA on Amazon EC2</c> for SAP HANA databases</para></li><li><para><c>Storage Gateway</c> for Storage Gateway</para></li><li><para><c>S3</c> for Amazon S3</para></li><li><para><c>Timestream</c> for Amazon Timestream</para></li><li><para><c>VirtualMachine</c> for virtual machines</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobListCmdlet.ByState"> <summary> <para> <para>Returns only backup jobs that are in the specified state.</para><para><c>Completed with issues</c> is a status found only in the Backup console. For API, this status refers to jobs with a state of <c>COMPLETED</c> and a <c>MessageCategory</c> with a value other than <c>SUCCESS</c>; that is, the status is completed but comes with a status message.</para><para>To obtain the job count for <c>Completed with issues</c>, run two GET requests, and subtract the second, smaller number:</para><para>GET /backup-jobs/?state=COMPLETED</para><para>GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</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.BAK.GetBAKBackupJobListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request is made to return <c>MaxResults</c> number of items, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKBackupJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BackupJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListBackupJobsResponse). Specifying the name of a property of type Amazon.Backup.Model.ListBackupJobsResponse 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.BAK.GetBAKBackupJobListCmdlet.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.BAK.GetBAKBackupJobSummaryListCmdlet"> <summary> This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results. <para> This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. </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.BAK.GetBAKBackupJobSummaryListCmdlet.AccountId"> <summary> <para> <para>Returns the job count for the specified account.</para><para>If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.</para><para>Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.</para><para><c>AGGREGATE_ALL</c> aggregates job counts from all accounts within the authenticated organization, then returns the sum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobSummaryListCmdlet.AggregationPeriod"> <summary> <para> <para>This is the period that sets the boundaries for returned results.</para><para>Acceptable values include</para><ul><li><para><c>ONE_DAY</c> for daily job count for the prior 14 days.</para></li><li><para><c>SEVEN_DAYS</c> for the aggregated job count for the prior 7 days.</para></li><li><para><c>FOURTEEN_DAYS</c> for aggregated job count for prior 14 days.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobSummaryListCmdlet.MessageCategory"> <summary> <para> <para>This parameter returns the job count for the specified message category.</para><para>Example accepted strings include <c>AccessDenied</c>, <c>Success</c>, and <c>InvalidParameters</c>. See <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a> for a list of accepted MessageCategory strings.</para><para>The the value ANY returns count of all message categories.</para><para><c>AGGREGATE_ALL</c> aggregates job counts for all message categories and returns the sum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobSummaryListCmdlet.ResourceType"> <summary> <para> <para>Returns the job count for the specified resource type. Use request <c>GetSupportedResourceTypes</c> to obtain strings for supported resource types.</para><para>The the value ANY returns count of all resource types.</para><para><c>AGGREGATE_ALL</c> aggregates job counts for all resource types and returns the sum.</para><para>The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobSummaryListCmdlet.State"> <summary> <para> <para>This parameter returns the job count for jobs with the specified state.</para><para>The the value ANY returns count of all states.</para><para><c>AGGREGATE_ALL</c> aggregates job counts for all states and returns the sum.</para><para><c>Completed with issues</c> is a status found only in the Backup console. For API, this status refers to jobs with a state of <c>COMPLETED</c> and a <c>MessageCategory</c> with a value other than <c>SUCCESS</c>; that is, the status is completed but comes with a status message. To obtain the job count for <c>Completed with issues</c>, run two GET requests, and subtract the second, smaller number:</para><para>GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED</para><para>GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobSummaryListCmdlet.MaxResult"> <summary> <para> <para>This parameter sets the maximum number of items to be returned.</para><para>The value is an integer. Range of accepted values is from 1 to 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupJobSummaryListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned resources. For example, if a request is made to return <c>MaxResults</c> number of resources, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKBackupJobSummaryListCmdlet.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.Backup.Model.ListBackupJobSummariesResponse). Specifying the name of a property of type Amazon.Backup.Model.ListBackupJobSummariesResponse 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.BAK.GetBAKBackupJobSummaryListCmdlet.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.BAK.GetBAKBackupPlanCmdlet"> <summary> Returns <c>BackupPlan</c> details for the specified <c>BackupPlanId</c>. The details are the body of a backup plan in JSON format, in addition to plan metadata. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupPlanCmdlet.BackupPlanId"> <summary> <para> <para>Uniquely identifies a backup plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupPlanCmdlet.VersionId"> <summary> <para> <para>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupPlanCmdlet.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.Backup.Model.GetBackupPlanResponse). Specifying the name of a property of type Amazon.Backup.Model.GetBackupPlanResponse 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.BAK.GetBAKBackupPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupPlanId parameter. The -PassThru parameter is deprecated, use -Select '^BackupPlanId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupPlanFromJSONCmdlet"> <summary> Returns a valid JSON document specifying a backup plan or an error. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupPlanFromJSONCmdlet.BackupPlanTemplateJson"> <summary> <para> <para>A customer-supplied backup plan document in JSON format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupPlanFromJSONCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BackupPlan'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.GetBackupPlanFromJSONResponse). Specifying the name of a property of type Amazon.Backup.Model.GetBackupPlanFromJSONResponse 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.BAK.GetBAKBackupPlanFromJSONCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupPlanTemplateJson parameter. The -PassThru parameter is deprecated, use -Select '^BackupPlanTemplateJson' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupPlanFromTemplateCmdlet"> <summary> Returns the template specified by its <c>templateId</c> as a backup plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupPlanFromTemplateCmdlet.BackupPlanTemplateId"> <summary> <para> <para>Uniquely identifies a stored backup plan template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupPlanFromTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BackupPlanDocument'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.GetBackupPlanFromTemplateResponse). Specifying the name of a property of type Amazon.Backup.Model.GetBackupPlanFromTemplateResponse 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.BAK.GetBAKBackupPlanFromTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupPlanTemplateId parameter. The -PassThru parameter is deprecated, use -Select '^BackupPlanTemplateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupPlanListCmdlet"> <summary> Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.<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.BAK.GetBAKBackupPlanListCmdlet.IncludeDeleted"> <summary> <para> <para>A Boolean value with a default value of <c>FALSE</c> that returns deleted backup plans when set to <c>TRUE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupPlanListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</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.BAK.GetBAKBackupPlanListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request is made to return <c>MaxResults</c> number of items, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKBackupPlanListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BackupPlansList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListBackupPlansResponse). Specifying the name of a property of type Amazon.Backup.Model.ListBackupPlansResponse 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.BAK.GetBAKBackupPlanListCmdlet.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.BAK.GetBAKBackupPlanTemplateListCmdlet"> <summary> Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.<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.BAK.GetBAKBackupPlanTemplateListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</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.BAK.GetBAKBackupPlanTemplateListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request is made to return <c>MaxResults</c> number of items, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKBackupPlanTemplateListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BackupPlanTemplatesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListBackupPlanTemplatesResponse). Specifying the name of a property of type Amazon.Backup.Model.ListBackupPlanTemplatesResponse 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.BAK.GetBAKBackupPlanTemplateListCmdlet.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.BAK.GetBAKBackupPlanVersionListCmdlet"> <summary> Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.<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.BAK.GetBAKBackupPlanVersionListCmdlet.BackupPlanId"> <summary> <para> <para>Uniquely identifies a backup plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupPlanVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</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.BAK.GetBAKBackupPlanVersionListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request is made to return <c>MaxResults</c> number of items, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKBackupPlanVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BackupPlanVersionsList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListBackupPlanVersionsResponse). Specifying the name of a property of type Amazon.Backup.Model.ListBackupPlanVersionsResponse 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.BAK.GetBAKBackupPlanVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupPlanId parameter. The -PassThru parameter is deprecated, use -Select '^BackupPlanId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupPlanVersionListCmdlet.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.BAK.GetBAKBackupSelectionCmdlet"> <summary> Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupSelectionCmdlet.BackupPlanId"> <summary> <para> <para>Uniquely identifies a backup plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupSelectionCmdlet.SelectionId"> <summary> <para> <para>Uniquely identifies the body of a request to assign a set of resources to a backup plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupSelectionCmdlet.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.Backup.Model.GetBackupSelectionResponse). Specifying the name of a property of type Amazon.Backup.Model.GetBackupSelectionResponse 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.BAK.GetBAKBackupSelectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SelectionId parameter. The -PassThru parameter is deprecated, use -Select '^SelectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupSelectionListCmdlet"> <summary> Returns an array containing metadata of the resources associated with the target backup plan.<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.BAK.GetBAKBackupSelectionListCmdlet.BackupPlanId"> <summary> <para> <para>Uniquely identifies a backup plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupSelectionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</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.BAK.GetBAKBackupSelectionListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request is made to return <c>MaxResults</c> number of items, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKBackupSelectionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BackupSelectionsList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListBackupSelectionsResponse). Specifying the name of a property of type Amazon.Backup.Model.ListBackupSelectionsResponse 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.BAK.GetBAKBackupSelectionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupPlanId parameter. The -PassThru parameter is deprecated, use -Select '^BackupPlanId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupSelectionListCmdlet.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.BAK.GetBAKBackupVaultCmdlet"> <summary> Returns metadata about a backup vault specified by its name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupVaultCmdlet.BackupVaultAccountId"> <summary> <para> <para>This is the account ID of the specified backup vault.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupVaultCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupVaultCmdlet.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.Backup.Model.DescribeBackupVaultResponse). Specifying the name of a property of type Amazon.Backup.Model.DescribeBackupVaultResponse 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.BAK.GetBAKBackupVaultCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupVaultName parameter. The -PassThru parameter is deprecated, use -Select '^BackupVaultName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupVaultAccessPolicyCmdlet"> <summary> Returns the access policy document that is associated with the named backup vault. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupVaultAccessPolicyCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupVaultAccessPolicyCmdlet.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.Backup.Model.GetBackupVaultAccessPolicyResponse). Specifying the name of a property of type Amazon.Backup.Model.GetBackupVaultAccessPolicyResponse 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.BAK.GetBAKBackupVaultAccessPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupVaultName parameter. The -PassThru parameter is deprecated, use -Select '^BackupVaultName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupVaultListCmdlet"> <summary> Returns a list of recovery point storage containers along with information about them.<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.BAK.GetBAKBackupVaultListCmdlet.ByShared"> <summary> <para> <para>This parameter will sort the list of vaults by shared vaults.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupVaultListCmdlet.ByVaultType"> <summary> <para> <para>This parameter will sort the list of vaults by vault type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupVaultListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</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.BAK.GetBAKBackupVaultListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request is made to return <c>MaxResults</c> number of items, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKBackupVaultListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BackupVaultList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListBackupVaultsResponse). Specifying the name of a property of type Amazon.Backup.Model.ListBackupVaultsResponse 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.BAK.GetBAKBackupVaultListCmdlet.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.BAK.GetBAKBackupVaultNotificationCmdlet"> <summary> Returns event notifications for the specified backup vault. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupVaultNotificationCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKBackupVaultNotificationCmdlet.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.Backup.Model.GetBackupVaultNotificationsResponse). Specifying the name of a property of type Amazon.Backup.Model.GetBackupVaultNotificationsResponse 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.BAK.GetBAKBackupVaultNotificationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupVaultName parameter. The -PassThru parameter is deprecated, use -Select '^BackupVaultName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobCmdlet"> <summary> Returns metadata associated with creating a copy of a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobCmdlet.CopyJobId"> <summary> <para> <para>Uniquely identifies a copy job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CopyJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.DescribeCopyJobResponse). Specifying the name of a property of type Amazon.Backup.Model.DescribeCopyJobResponse 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.BAK.GetBAKCopyJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CopyJobId parameter. The -PassThru parameter is deprecated, use -Select '^CopyJobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobListCmdlet"> <summary> Returns metadata about your copy jobs.<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.BAK.GetBAKCopyJobListCmdlet.ByAccountId"> <summary> <para> <para>The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobListCmdlet.ByCompleteAfter"> <summary> <para> <para>Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobListCmdlet.ByCompleteBefore"> <summary> <para> <para>Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobListCmdlet.ByCreatedAfter"> <summary> <para> <para>Returns only copy jobs that were created after the specified date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobListCmdlet.ByCreatedBefore"> <summary> <para> <para>Returns only copy jobs that were created before the specified date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobListCmdlet.ByDestinationVaultArn"> <summary> <para> <para>An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, <c>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobListCmdlet.ByMessageCategory"> <summary> <para> <para>This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.</para><para>Example strings may include <c>AccessDenied</c>, <c>SUCCESS</c>, <c>AGGREGATE_ALL</c>, and <c>INVALIDPARAMETERS</c>.</para><para>View <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a> for a list of accepted strings.</para><para>The the value ANY returns count of all message categories.</para><para><c>AGGREGATE_ALL</c> aggregates job counts for all message categories and returns the sum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobListCmdlet.ByParentJobId"> <summary> <para> <para>This is a filter to list child (nested) jobs based on parent job ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobListCmdlet.ByResourceArn"> <summary> <para> <para>Returns only copy jobs that match the specified resource Amazon Resource Name (ARN). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobListCmdlet.ByResourceType"> <summary> <para> <para>Returns only backup jobs for the specified resources:</para><ul><li><para><c>Aurora</c> for Amazon Aurora</para></li><li><para><c>CloudFormation</c> for CloudFormation</para></li><li><para><c>DocumentDB</c> for Amazon DocumentDB (with MongoDB compatibility)</para></li><li><para><c>DynamoDB</c> for Amazon DynamoDB</para></li><li><para><c>EBS</c> for Amazon Elastic Block Store</para></li><li><para><c>EC2</c> for Amazon Elastic Compute Cloud</para></li><li><para><c>EFS</c> for Amazon Elastic File System</para></li><li><para><c>FSx</c> for Amazon FSx</para></li><li><para><c>Neptune</c> for Amazon Neptune</para></li><li><para><c>Redshift</c> for Amazon Redshift</para></li><li><para><c>RDS</c> for Amazon Relational Database Service</para></li><li><para><c>SAP HANA on Amazon EC2</c> for SAP HANA databases</para></li><li><para><c>Storage Gateway</c> for Storage Gateway</para></li><li><para><c>S3</c> for Amazon S3</para></li><li><para><c>Timestream</c> for Amazon Timestream</para></li><li><para><c>VirtualMachine</c> for virtual machines</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobListCmdlet.ByState"> <summary> <para> <para>Returns only copy jobs that are in the specified state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. </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.BAK.GetBAKCopyJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CopyJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListCopyJobsResponse). Specifying the name of a property of type Amazon.Backup.Model.ListCopyJobsResponse 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.BAK.GetBAKCopyJobListCmdlet.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.BAK.GetBAKCopyJobSummaryListCmdlet"> <summary> This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results. <para> This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. </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.BAK.GetBAKCopyJobSummaryListCmdlet.AccountId"> <summary> <para> <para>Returns the job count for the specified account.</para><para>If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.</para><para>Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.</para><para><c>AGGREGATE_ALL</c> aggregates job counts from all accounts within the authenticated organization, then returns the sum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobSummaryListCmdlet.AggregationPeriod"> <summary> <para> <para>This is the period that sets the boundaries for returned results.</para><ul><li><para><c>ONE_DAY</c> for daily job count for the prior 14 days.</para></li><li><para><c>SEVEN_DAYS</c> for the aggregated job count for the prior 7 days.</para></li><li><para><c>FOURTEEN_DAYS</c> for aggregated job count for prior 14 days.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobSummaryListCmdlet.MessageCategory"> <summary> <para> <para>This parameter returns the job count for the specified message category.</para><para>Example accepted strings include <c>AccessDenied</c>, <c>Success</c>, and <c>InvalidParameters</c>. See <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a> for a list of accepted MessageCategory strings.</para><para>The the value ANY returns count of all message categories.</para><para><c>AGGREGATE_ALL</c> aggregates job counts for all message categories and returns the sum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobSummaryListCmdlet.ResourceType"> <summary> <para> <para>Returns the job count for the specified resource type. Use request <c>GetSupportedResourceTypes</c> to obtain strings for supported resource types.</para><para>The the value ANY returns count of all resource types.</para><para><c>AGGREGATE_ALL</c> aggregates job counts for all resource types and returns the sum.</para><para>The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobSummaryListCmdlet.State"> <summary> <para> <para>This parameter returns the job count for jobs with the specified state.</para><para>The the value ANY returns count of all states.</para><para><c>AGGREGATE_ALL</c> aggregates job counts for all states and returns the sum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobSummaryListCmdlet.MaxResult"> <summary> <para> <para>This parameter sets the maximum number of items to be returned.</para><para>The value is an integer. Range of accepted values is from 1 to 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKCopyJobSummaryListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned resources. For example, if a request is made to return <c>MaxResults</c> number of resources, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKCopyJobSummaryListCmdlet.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.Backup.Model.ListCopyJobSummariesResponse). Specifying the name of a property of type Amazon.Backup.Model.ListCopyJobSummariesResponse 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.BAK.GetBAKCopyJobSummaryListCmdlet.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.BAK.GetBAKFrameworkCmdlet"> <summary> Returns the framework details for the specified <c>FrameworkName</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKFrameworkCmdlet.FrameworkName"> <summary> <para> <para>The unique name of a framework.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKFrameworkCmdlet.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.Backup.Model.DescribeFrameworkResponse). Specifying the name of a property of type Amazon.Backup.Model.DescribeFrameworkResponse 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.BAK.GetBAKFrameworkCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FrameworkName parameter. The -PassThru parameter is deprecated, use -Select '^FrameworkName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKFrameworkListCmdlet"> <summary> Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.<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.BAK.GetBAKFrameworkListCmdlet.MaxResult"> <summary> <para> <para>The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKFrameworkListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</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.BAK.GetBAKFrameworkListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Frameworks'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListFrameworksResponse). Specifying the name of a property of type Amazon.Backup.Model.ListFrameworksResponse 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.BAK.GetBAKFrameworkListCmdlet.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.BAK.GetBAKGlobalSettingCmdlet"> <summary> Describes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not a member of an Organizations organization. Example: <c>describe-global-settings --region us-west-2</c> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKGlobalSettingCmdlet.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.Backup.Model.DescribeGlobalSettingsResponse). Specifying the name of a property of type Amazon.Backup.Model.DescribeGlobalSettingsResponse 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.BAK.GetBAKLegalHoldCmdlet"> <summary> This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKLegalHoldCmdlet.LegalHoldId"> <summary> <para> <para>This is the ID required to use <c>GetLegalHold</c>. This unique ID is associated with a specific legal hold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKLegalHoldCmdlet.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.Backup.Model.GetLegalHoldResponse). Specifying the name of a property of type Amazon.Backup.Model.GetLegalHoldResponse 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.BAK.GetBAKLegalHoldCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LegalHoldId parameter. The -PassThru parameter is deprecated, use -Select '^LegalHoldId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKLegalHoldListCmdlet"> <summary> This action returns metadata about active and previous legal holds.<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.BAK.GetBAKLegalHoldListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of resource list items to be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKLegalHoldListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned resources. For example, if a request is made to return <c>MaxResults</c> number of resources, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKLegalHoldListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LegalHolds'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListLegalHoldsResponse). Specifying the name of a property of type Amazon.Backup.Model.ListLegalHoldsResponse 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.BAK.GetBAKLegalHoldListCmdlet.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.BAK.GetBAKProtectedResourceCmdlet"> <summary> Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKProtectedResourceCmdlet.ResourceArn"> <summary> <para> <para>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKProtectedResourceCmdlet.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.Backup.Model.DescribeProtectedResourceResponse). Specifying the name of a property of type Amazon.Backup.Model.DescribeProtectedResourceResponse 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.BAK.GetBAKProtectedResourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKProtectedResourceListCmdlet"> <summary> Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.<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.BAK.GetBAKProtectedResourceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</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.BAK.GetBAKProtectedResourceListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request is made to return <c>MaxResults</c> number of items, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKProtectedResourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Results'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListProtectedResourcesResponse). Specifying the name of a property of type Amazon.Backup.Model.ListProtectedResourcesResponse 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.BAK.GetBAKProtectedResourceListCmdlet.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.BAK.GetBAKProtectedResourcesByBackupVaultListCmdlet"> <summary> This request lists the protected resources corresponding to each backup vault.<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.BAK.GetBAKProtectedResourcesByBackupVaultListCmdlet.BackupVaultAccountId"> <summary> <para> <para>This is the list of protected resources by backup vault within the vault(s) you specify by account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKProtectedResourcesByBackupVaultListCmdlet.BackupVaultName"> <summary> <para> <para>This is the list of protected resources by backup vault within the vault(s) you specify by name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKProtectedResourcesByBackupVaultListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKProtectedResourcesByBackupVaultListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request is made to return <c>MaxResults</c> number of items, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKProtectedResourcesByBackupVaultListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Results'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListProtectedResourcesByBackupVaultResponse). Specifying the name of a property of type Amazon.Backup.Model.ListProtectedResourcesByBackupVaultResponse 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.BAK.GetBAKProtectedResourcesByBackupVaultListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupVaultName parameter. The -PassThru parameter is deprecated, use -Select '^BackupVaultName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKProtectedResourcesByBackupVaultListCmdlet.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.BAK.GetBAKRecoveryPointCmdlet"> <summary> Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointCmdlet.BackupVaultAccountId"> <summary> <para> <para>This is the account ID of the specified backup vault.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointCmdlet.RecoveryPointArn"> <summary> <para> <para>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <c>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointCmdlet.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.Backup.Model.DescribeRecoveryPointResponse). Specifying the name of a property of type Amazon.Backup.Model.DescribeRecoveryPointResponse 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.BAK.GetBAKRecoveryPointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RecoveryPointArn parameter. The -PassThru parameter is deprecated, use -Select '^RecoveryPointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointRestoreMetadataCmdlet"> <summary> Returns a set of metadata key-value pairs that were used to create the backup. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointRestoreMetadataCmdlet.BackupVaultAccountId"> <summary> <para> <para>This is the account ID of the specified backup vault.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointRestoreMetadataCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointRestoreMetadataCmdlet.RecoveryPointArn"> <summary> <para> <para>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <c>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointRestoreMetadataCmdlet.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.Backup.Model.GetRecoveryPointRestoreMetadataResponse). Specifying the name of a property of type Amazon.Backup.Model.GetRecoveryPointRestoreMetadataResponse 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.BAK.GetBAKRecoveryPointRestoreMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RecoveryPointArn parameter. The -PassThru parameter is deprecated, use -Select '^RecoveryPointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByBackupVaultListCmdlet"> <summary> Returns detailed information about the recovery points stored in a backup vault.<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.BAK.GetBAKRecoveryPointsByBackupVaultListCmdlet.BackupVaultAccountId"> <summary> <para> <para>This parameter will sort the list of recovery points by account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByBackupVaultListCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para><note><para>Backup vault name might not be available when a supported service creates the backup.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByBackupVaultListCmdlet.ByBackupPlanId"> <summary> <para> <para>Returns only recovery points that match the specified backup plan ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByBackupVaultListCmdlet.ByCreatedAfter"> <summary> <para> <para>Returns only recovery points that were created after the specified timestamp.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByBackupVaultListCmdlet.ByCreatedBefore"> <summary> <para> <para>Returns only recovery points that were created before the specified timestamp.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByBackupVaultListCmdlet.ByParentRecoveryPointArn"> <summary> <para> <para>This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByBackupVaultListCmdlet.ByResourceArn"> <summary> <para> <para>Returns only recovery points that match the specified resource Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByBackupVaultListCmdlet.ByResourceType"> <summary> <para> <para>Returns only recovery points that match the specified resource type(s):</para><ul><li><para><c>Aurora</c> for Amazon Aurora</para></li><li><para><c>CloudFormation</c> for CloudFormation</para></li><li><para><c>DocumentDB</c> for Amazon DocumentDB (with MongoDB compatibility)</para></li><li><para><c>DynamoDB</c> for Amazon DynamoDB</para></li><li><para><c>EBS</c> for Amazon Elastic Block Store</para></li><li><para><c>EC2</c> for Amazon Elastic Compute Cloud</para></li><li><para><c>EFS</c> for Amazon Elastic File System</para></li><li><para><c>FSx</c> for Amazon FSx</para></li><li><para><c>Neptune</c> for Amazon Neptune</para></li><li><para><c>Redshift</c> for Amazon Redshift</para></li><li><para><c>RDS</c> for Amazon Relational Database Service</para></li><li><para><c>SAP HANA on Amazon EC2</c> for SAP HANA databases</para></li><li><para><c>Storage Gateway</c> for Storage Gateway</para></li><li><para><c>S3</c> for Amazon S3</para></li><li><para><c>Timestream</c> for Amazon Timestream</para></li><li><para><c>VirtualMachine</c> for virtual machines</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByBackupVaultListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</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.BAK.GetBAKRecoveryPointsByBackupVaultListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request is made to return <c>MaxResults</c> number of items, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKRecoveryPointsByBackupVaultListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RecoveryPoints'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListRecoveryPointsByBackupVaultResponse). Specifying the name of a property of type Amazon.Backup.Model.ListRecoveryPointsByBackupVaultResponse 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.BAK.GetBAKRecoveryPointsByBackupVaultListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupVaultName parameter. The -PassThru parameter is deprecated, use -Select '^BackupVaultName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByBackupVaultListCmdlet.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.BAK.GetBAKRecoveryPointsByLegalHoldListCmdlet"> <summary> This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.<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.BAK.GetBAKRecoveryPointsByLegalHoldListCmdlet.LegalHoldId"> <summary> <para> <para>This is the ID of the legal hold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByLegalHoldListCmdlet.MaxResult"> <summary> <para> <para>This is the maximum number of resource list items to be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByLegalHoldListCmdlet.NextToken"> <summary> <para> <para>This is the next item following a partial list of returned resources. For example, if a request is made to return <c>MaxResults</c> number of resources, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKRecoveryPointsByLegalHoldListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RecoveryPoints'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListRecoveryPointsByLegalHoldResponse). Specifying the name of a property of type Amazon.Backup.Model.ListRecoveryPointsByLegalHoldResponse 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.BAK.GetBAKRecoveryPointsByLegalHoldListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LegalHoldId parameter. The -PassThru parameter is deprecated, use -Select '^LegalHoldId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByLegalHoldListCmdlet.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.BAK.GetBAKRecoveryPointsByResourceListCmdlet"> <summary> Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN). <note><para> For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup. </para></note><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.BAK.GetBAKRecoveryPointsByResourceListCmdlet.ManagedByAWSBackupOnly"> <summary> <para> <para>This attribute filters recovery points based on ownership.</para><para>If this is set to <c>TRUE</c>, the response will contain recovery points associated with the selected resources that are managed by Backup.</para><para>If this is set to <c>FALSE</c>, the response will contain all recovery points associated with the selected resource.</para><para>Type: Boolean</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByResourceListCmdlet.ResourceArn"> <summary> <para> <para>An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByResourceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</para><note><para>Amazon RDS requires a value of at least 20.</para></note> </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.BAK.GetBAKRecoveryPointsByResourceListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request is made to return <c>MaxResults</c> number of items, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKRecoveryPointsByResourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RecoveryPoints'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListRecoveryPointsByResourceResponse). Specifying the name of a property of type Amazon.Backup.Model.ListRecoveryPointsByResourceResponse 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.BAK.GetBAKRecoveryPointsByResourceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRecoveryPointsByResourceListCmdlet.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.BAK.GetBAKRegionSettingCmdlet"> <summary> Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRegionSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceTypeOptInPreference'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.DescribeRegionSettingsResponse). Specifying the name of a property of type Amazon.Backup.Model.DescribeRegionSettingsResponse 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.BAK.GetBAKReportJobCmdlet"> <summary> Returns the details associated with creating a report as specified by its <c>ReportJobId</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKReportJobCmdlet.ReportJobId"> <summary> <para> <para>The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKReportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.DescribeReportJobResponse). Specifying the name of a property of type Amazon.Backup.Model.DescribeReportJobResponse 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.BAK.GetBAKReportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReportJobId parameter. The -PassThru parameter is deprecated, use -Select '^ReportJobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKReportJobListCmdlet"> <summary> Returns details about your report jobs.<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.BAK.GetBAKReportJobListCmdlet.ByCreationAfter"> <summary> <para> <para>Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKReportJobListCmdlet.ByCreationBefore"> <summary> <para> <para>Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKReportJobListCmdlet.ByReportPlanName"> <summary> <para> <para>Returns only report jobs with the specified report plan name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKReportJobListCmdlet.ByStatus"> <summary> <para> <para>Returns only report jobs that are in the specified status. The statuses are:</para><para><c>CREATED | RUNNING | COMPLETED | FAILED</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKReportJobListCmdlet.MaxResult"> <summary> <para> <para>The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKReportJobListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</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.BAK.GetBAKReportJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListReportJobsResponse). Specifying the name of a property of type Amazon.Backup.Model.ListReportJobsResponse 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.BAK.GetBAKReportJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ByReportPlanName parameter. The -PassThru parameter is deprecated, use -Select '^ByReportPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKReportJobListCmdlet.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.BAK.GetBAKReportPlanCmdlet"> <summary> Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKReportPlanCmdlet.ReportPlanName"> <summary> <para> <para>The unique name of a report plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKReportPlanCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportPlan'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.DescribeReportPlanResponse). Specifying the name of a property of type Amazon.Backup.Model.DescribeReportPlanResponse 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.BAK.GetBAKReportPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReportPlanName parameter. The -PassThru parameter is deprecated, use -Select '^ReportPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKReportPlanListCmdlet"> <summary> Returns a list of your report plans. For detailed information about a single report plan, use <c>DescribeReportPlan</c>.<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.BAK.GetBAKReportPlanListCmdlet.MaxResult"> <summary> <para> <para>The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKReportPlanListCmdlet.NextToken"> <summary> <para> <para>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</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.BAK.GetBAKReportPlanListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportPlans'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListReportPlansResponse). Specifying the name of a property of type Amazon.Backup.Model.ListReportPlansResponse 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.BAK.GetBAKReportPlanListCmdlet.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.BAK.GetBAKResourceTagCmdlet"> <summary> Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault. <para><c>ListTags</c> only works for resource types that support full Backup management of their backups. Those resource types are listed in the "Full Backup management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature availability by resource</a> table. </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.BAK.GetBAKResourceTagCmdlet.ResourceArn"> <summary> <para> <para>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for <c>ListTags</c> are recovery points, backup plans, and backup vaults.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKResourceTagCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</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.BAK.GetBAKResourceTagCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request is made to return <c>MaxResults</c> number of items, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListTagsResponse). Specifying the name of a property of type Amazon.Backup.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.BAK.GetBAKResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKResourceTagCmdlet.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.BAK.GetBAKRestoreJobCmdlet"> <summary> Returns metadata associated with a restore job that is specified by a job ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobCmdlet.RestoreJobId"> <summary> <para> <para>Uniquely identifies the job that restores a recovery point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobCmdlet.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.Backup.Model.DescribeRestoreJobResponse). Specifying the name of a property of type Amazon.Backup.Model.DescribeRestoreJobResponse 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.BAK.GetBAKRestoreJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RestoreJobId parameter. The -PassThru parameter is deprecated, use -Select '^RestoreJobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobListCmdlet"> <summary> Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.<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.BAK.GetBAKRestoreJobListCmdlet.ByAccountId"> <summary> <para> <para>The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobListCmdlet.ByCompleteAfter"> <summary> <para> <para>Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobListCmdlet.ByCompleteBefore"> <summary> <para> <para>Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobListCmdlet.ByCreatedAfter"> <summary> <para> <para>Returns only restore jobs that were created after the specified date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobListCmdlet.ByCreatedBefore"> <summary> <para> <para>Returns only restore jobs that were created before the specified date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobListCmdlet.ByResourceType"> <summary> <para> <para>Include this parameter to return only restore jobs for the specified resources:</para><ul><li><para><c>Aurora</c> for Amazon Aurora</para></li><li><para><c>CloudFormation</c> for CloudFormation</para></li><li><para><c>DocumentDB</c> for Amazon DocumentDB (with MongoDB compatibility)</para></li><li><para><c>DynamoDB</c> for Amazon DynamoDB</para></li><li><para><c>EBS</c> for Amazon Elastic Block Store</para></li><li><para><c>EC2</c> for Amazon Elastic Compute Cloud</para></li><li><para><c>EFS</c> for Amazon Elastic File System</para></li><li><para><c>FSx</c> for Amazon FSx</para></li><li><para><c>Neptune</c> for Amazon Neptune</para></li><li><para><c>Redshift</c> for Amazon Redshift</para></li><li><para><c>RDS</c> for Amazon Relational Database Service</para></li><li><para><c>SAP HANA on Amazon EC2</c> for SAP HANA databases</para></li><li><para><c>Storage Gateway</c> for Storage Gateway</para></li><li><para><c>S3</c> for Amazon S3</para></li><li><para><c>Timestream</c> for Amazon Timestream</para></li><li><para><c>VirtualMachine</c> for virtual machines</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobListCmdlet.ByRestoreTestingPlanArn"> <summary> <para> <para>This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobListCmdlet.ByStatus"> <summary> <para> <para>Returns only restore jobs associated with the specified job status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</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.BAK.GetBAKRestoreJobListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request is made to return <c>MaxResults</c> number of items, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKRestoreJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RestoreJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListRestoreJobsResponse). Specifying the name of a property of type Amazon.Backup.Model.ListRestoreJobsResponse 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.BAK.GetBAKRestoreJobListCmdlet.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.BAK.GetBAKRestoreJobMetadataCmdlet"> <summary> This request returns the metadata for the specified restore job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobMetadataCmdlet.RestoreJobId"> <summary> <para> <para>This is a unique identifier of a restore job within Backup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobMetadataCmdlet.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.Backup.Model.GetRestoreJobMetadataResponse). Specifying the name of a property of type Amazon.Backup.Model.GetRestoreJobMetadataResponse 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.BAK.GetBAKRestoreJobMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RestoreJobId parameter. The -PassThru parameter is deprecated, use -Select '^RestoreJobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobsByProtectedResourceListCmdlet"> <summary> This returns restore jobs that contain the specified protected resource. <para> You must include <c>ResourceArn</c>. You can optionally include <c>NextToken</c>, <c>ByStatus</c>, <c>MaxResults</c>, <c>ByRecoveryPointCreationDateAfter</c> , and <c>ByRecoveryPointCreationDateBefore</c>. </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.BAK.GetBAKRestoreJobsByProtectedResourceListCmdlet.ByRecoveryPointCreationDateAfter"> <summary> <para> <para>Returns only restore jobs of recovery points that were created after the specified date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobsByProtectedResourceListCmdlet.ByRecoveryPointCreationDateBefore"> <summary> <para> <para>Returns only restore jobs of recovery points that were created before the specified date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobsByProtectedResourceListCmdlet.ByStatus"> <summary> <para> <para>Returns only restore jobs associated with the specified job status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobsByProtectedResourceListCmdlet.ResourceArn"> <summary> <para> <para>Returns only restore jobs that match the specified resource Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobsByProtectedResourceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobsByProtectedResourceListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request ismade to return <c>MaxResults</c> number of items, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKRestoreJobsByProtectedResourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RestoreJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListRestoreJobsByProtectedResourceResponse). Specifying the name of a property of type Amazon.Backup.Model.ListRestoreJobsByProtectedResourceResponse 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.BAK.GetBAKRestoreJobsByProtectedResourceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobsByProtectedResourceListCmdlet.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.BAK.GetBAKRestoreJobSummaryListCmdlet"> <summary> This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results. <para> This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. </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.BAK.GetBAKRestoreJobSummaryListCmdlet.AccountId"> <summary> <para> <para>Returns the job count for the specified account.</para><para>If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.</para><para>Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.</para><para><c>AGGREGATE_ALL</c> aggregates job counts from all accounts within the authenticated organization, then returns the sum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobSummaryListCmdlet.AggregationPeriod"> <summary> <para> <para>This is the period that sets the boundaries for returned results.</para><para>Acceptable values include</para><ul><li><para><c>ONE_DAY</c> for daily job count for the prior 14 days.</para></li><li><para><c>SEVEN_DAYS</c> for the aggregated job count for the prior 7 days.</para></li><li><para><c>FOURTEEN_DAYS</c> for aggregated job count for prior 14 days.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobSummaryListCmdlet.ResourceType"> <summary> <para> <para>Returns the job count for the specified resource type. Use request <c>GetSupportedResourceTypes</c> to obtain strings for supported resource types.</para><para>The the value ANY returns count of all resource types.</para><para><c>AGGREGATE_ALL</c> aggregates job counts for all resource types and returns the sum.</para><para>The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobSummaryListCmdlet.State"> <summary> <para> <para>This parameter returns the job count for jobs with the specified state.</para><para>The the value ANY returns count of all states.</para><para><c>AGGREGATE_ALL</c> aggregates job counts for all states and returns the sum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobSummaryListCmdlet.MaxResult"> <summary> <para> <para>This parameter sets the maximum number of items to be returned.</para><para>The value is an integer. Range of accepted values is from 1 to 500.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreJobSummaryListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned resources. For example, if a request is made to return <c>MaxResults</c> number of resources, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the next token.</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.BAK.GetBAKRestoreJobSummaryListCmdlet.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.Backup.Model.ListRestoreJobSummariesResponse). Specifying the name of a property of type Amazon.Backup.Model.ListRestoreJobSummariesResponse 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.BAK.GetBAKRestoreJobSummaryListCmdlet.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.BAK.GetBAKRestoreTestingInferredMetadataCmdlet"> <summary> This request returns the minimal required set of metadata needed to start a restore job with secure default settings. <c>BackupVaultName</c> and <c>RecoveryPointArn</c> are required parameters. <c>BackupVaultAccountId</c> is an optional parameter. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingInferredMetadataCmdlet.BackupVaultAccountId"> <summary> <para> <para>This is the account ID of the specified backup vault.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingInferredMetadataCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web ServicesRegion where they are created. They consist of letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingInferredMetadataCmdlet.RecoveryPointArn"> <summary> <para> <para>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <c>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingInferredMetadataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InferredMetadata'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.GetRestoreTestingInferredMetadataResponse). Specifying the name of a property of type Amazon.Backup.Model.GetRestoreTestingInferredMetadataResponse 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.BAK.GetBAKRestoreTestingInferredMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RecoveryPointArn parameter. The -PassThru parameter is deprecated, use -Select '^RecoveryPointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingPlanCmdlet"> <summary> Returns <c>RestoreTestingPlan</c> details for the specified <c>RestoreTestingPlanName</c>. The details are the body of a restore testing plan in JSON format, in addition to plan metadata. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingPlanCmdlet.RestoreTestingPlanName"> <summary> <para> <para>Required unique name of the restore testing plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingPlanCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RestoreTestingPlan'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.GetRestoreTestingPlanResponse). Specifying the name of a property of type Amazon.Backup.Model.GetRestoreTestingPlanResponse 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.BAK.GetBAKRestoreTestingPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RestoreTestingPlanName parameter. The -PassThru parameter is deprecated, use -Select '^RestoreTestingPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingPlanListCmdlet"> <summary> Returns a list of restore testing plans.<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.BAK.GetBAKRestoreTestingPlanListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingPlanListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request is made to return <c>MaxResults</c> number of items, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the nexttoken.</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.BAK.GetBAKRestoreTestingPlanListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RestoreTestingPlans'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListRestoreTestingPlansResponse). Specifying the name of a property of type Amazon.Backup.Model.ListRestoreTestingPlansResponse 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.BAK.GetBAKRestoreTestingPlanListCmdlet.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.BAK.GetBAKRestoreTestingSelectionCmdlet"> <summary> Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingSelectionCmdlet.RestoreTestingPlanName"> <summary> <para> <para>Required unique name of the restore testing plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingSelectionCmdlet.RestoreTestingSelectionName"> <summary> <para> <para>Required unique name of the restore testing selection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingSelectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RestoreTestingSelection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.GetRestoreTestingSelectionResponse). Specifying the name of a property of type Amazon.Backup.Model.GetRestoreTestingSelectionResponse 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.BAK.GetBAKRestoreTestingSelectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RestoreTestingSelectionName parameter. The -PassThru parameter is deprecated, use -Select '^RestoreTestingSelectionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingSelectionListCmdlet"> <summary> Returns a list of restore testing selections. Can be filtered by <c>MaxResults</c> and <c>RestoreTestingPlanName</c>.<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.BAK.GetBAKRestoreTestingSelectionListCmdlet.RestoreTestingPlanName"> <summary> <para> <para>Returns restore testing selections by the specified restore testing plan name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingSelectionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of items to be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingSelectionListCmdlet.NextToken"> <summary> <para> <para>The next item following a partial list of returned items. For example, if a request is made to return <c>MaxResults</c> number of items, <c>NextToken</c> allows you to return more items in your list starting at the location pointed to by the nexttoken.</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.BAK.GetBAKRestoreTestingSelectionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RestoreTestingSelections'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.ListRestoreTestingSelectionsResponse). Specifying the name of a property of type Amazon.Backup.Model.ListRestoreTestingSelectionsResponse 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.BAK.GetBAKRestoreTestingSelectionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RestoreTestingPlanName parameter. The -PassThru parameter is deprecated, use -Select '^RestoreTestingPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKRestoreTestingSelectionListCmdlet.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.BAK.GetBAKSupportedResourceTypeCmdlet"> <summary> Returns the Amazon Web Services resource types supported by Backup. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.GetBAKSupportedResourceTypeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceTypes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.GetSupportedResourceTypesResponse). Specifying the name of a property of type Amazon.Backup.Model.GetSupportedResourceTypesResponse 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.BAK.MoveBAKRecoveryPointCmdlet"> <summary> This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.MoveBAKRecoveryPointCmdlet.BackupVaultName"> <summary> <para> <para>This is the name of a logical container where the child (nested) recovery point is stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.MoveBAKRecoveryPointCmdlet.RecoveryPointArn"> <summary> <para> <para>This is the Amazon Resource Name (ARN) that uniquely identifies the child (nested) recovery point; for example, <c>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.MoveBAKRecoveryPointCmdlet.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.Backup.Model.DisassociateRecoveryPointFromParentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.MoveBAKRecoveryPointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RecoveryPointArn parameter. The -PassThru parameter is deprecated, use -Select '^RecoveryPointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.MoveBAKRecoveryPointCmdlet.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.BAK.NewBAKBackupPlanCmdlet"> <summary> Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources. <para> If you call <c>CreateBackupPlan</c> with a plan that already exists, you receive an <c>AlreadyExistsException</c> exception. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupPlanCmdlet.BackupPlan_AdvancedBackupSetting"> <summary> <para> <para>Specifies a list of <c>BackupOptions</c> for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupPlanCmdlet.BackupPlan_BackupPlanName"> <summary> <para> <para>The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupPlanCmdlet.BackupPlanTag"> <summary> <para> <para>To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupPlanCmdlet.CreatorRequestId"> <summary> <para> <para>Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a <c>CreatorRequestId</c> that matches an existing backup plan, that plan is returned. This parameter is optional.</para><para>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupPlanCmdlet.BackupPlan_Rule"> <summary> <para> <para>An array of <c>BackupRule</c> objects, each of which specifies a scheduled task that is used to back up a selection of resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupPlanCmdlet.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.Backup.Model.CreateBackupPlanResponse). Specifying the name of a property of type Amazon.Backup.Model.CreateBackupPlanResponse 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.BAK.NewBAKBackupPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupPlan_BackupPlanName parameter. The -PassThru parameter is deprecated, use -Select '^BackupPlan_BackupPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupPlanCmdlet.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.BAK.NewBAKBackupSelectionCmdlet"> <summary> Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json">Assigning resources programmatically</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupSelectionCmdlet.BackupPlanId"> <summary> <para> <para>Uniquely identifies the backup plan to be associated with the selection of resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupSelectionCmdlet.CreatorRequestId"> <summary> <para> <para>A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.</para><para>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupSelectionCmdlet.BackupSelection_IamRoleArn"> <summary> <para> <para>The ARN of the IAM role that Backup uses to authenticate when backing up the target resource; for example, <c>arn:aws:iam::123456789012:role/S3Access</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupSelectionCmdlet.BackupSelection_ListOfTag"> <summary> <para> <para>A list of conditions that you define to assign resources to your backup plans using tags. For example, <c>"StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "true" },</c>. Condition operators are case sensitive.</para><para><c>ListOfTags</c> differs from <c>Conditions</c> as follows:</para><ul><li><para>When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).</para></li><li><para><c>ListOfTags</c> only supports <c>StringEquals</c>. <c>Conditions</c> supports <c>StringEquals</c>, <c>StringLike</c>, <c>StringNotEquals</c>, and <c>StringNotLike</c>. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupSelectionCmdlet.BackupSelection_NotResource"> <summary> <para> <para>A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.</para><para>If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupSelectionCmdlet.BackupSelection_Resource"> <summary> <para> <para>A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.</para><para>If you need to assign many resources to a backup plan, consider a different resource selection strategy, such as assigning all resources of a resource type or refining your resource selection using tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupSelectionCmdlet.BackupSelection_SelectionName"> <summary> <para> <para>The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupSelectionCmdlet.Conditions_StringEqual"> <summary> <para> <para>Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupSelectionCmdlet.Conditions_StringLike"> <summary> <para> <para>Filters the values of your tagged resources for matching tag values with the use of a wildcard character (*) anywhere in the string. For example, "prod*" or "*rod*" matches the tag value "production".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupSelectionCmdlet.Conditions_StringNotEqual"> <summary> <para> <para>Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupSelectionCmdlet.Conditions_StringNotLike"> <summary> <para> <para>Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (*) anywhere in the string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupSelectionCmdlet.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.Backup.Model.CreateBackupSelectionResponse). Specifying the name of a property of type Amazon.Backup.Model.CreateBackupSelectionResponse 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.BAK.NewBAKBackupSelectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupPlanId parameter. The -PassThru parameter is deprecated, use -Select '^BackupPlanId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupSelectionCmdlet.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.BAK.NewBAKBackupVaultCmdlet"> <summary> Creates a logical container where backups are stored. A <c>CreateBackupVault</c> request includes a name, optionally one or more resource tags, an encryption key, and a request ID. <note><para> Do not include sensitive data, such as passport numbers, in the name of a backup vault. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupVaultCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupVaultCmdlet.BackupVaultTag"> <summary> <para> <para>Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupVaultCmdlet.CreatorRequestId"> <summary> <para> <para>A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.</para><para>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupVaultCmdlet.EncryptionKeyArn"> <summary> <para> <para>The server-side encryption key that is used to protect your backups; for example, <c>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupVaultCmdlet.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.Backup.Model.CreateBackupVaultResponse). Specifying the name of a property of type Amazon.Backup.Model.CreateBackupVaultResponse 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.BAK.NewBAKBackupVaultCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupVaultName parameter. The -PassThru parameter is deprecated, use -Select '^BackupVaultName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKBackupVaultCmdlet.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.BAK.NewBAKFrameworkCmdlet"> <summary> Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKFrameworkCmdlet.FrameworkControl"> <summary> <para> <para>A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKFrameworkCmdlet.FrameworkDescription"> <summary> <para> <para>An optional description of the framework with a maximum of 1,024 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKFrameworkCmdlet.FrameworkName"> <summary> <para> <para>The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKFrameworkCmdlet.FrameworkTag"> <summary> <para> <para>Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKFrameworkCmdlet.IdempotencyToken"> <summary> <para> <para>A customer-chosen string that you can use to distinguish between otherwise identical calls to <c>CreateFrameworkInput</c>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKFrameworkCmdlet.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.Backup.Model.CreateFrameworkResponse). Specifying the name of a property of type Amazon.Backup.Model.CreateFrameworkResponse 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.BAK.NewBAKFrameworkCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FrameworkName parameter. The -PassThru parameter is deprecated, use -Select '^FrameworkName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKFrameworkCmdlet.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.BAK.NewBAKLegalHoldCmdlet"> <summary> This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLegalHoldCmdlet.Description"> <summary> <para> <para>This is the string description of the legal hold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLegalHoldCmdlet.DateRange_FromDate"> <summary> <para> <para>This value is the beginning date, inclusive.</para><para>The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLegalHoldCmdlet.IdempotencyToken"> <summary> <para> <para>This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLegalHoldCmdlet.RecoveryPointSelection_ResourceIdentifier"> <summary> <para> <para>These are the resources included in the resource selection (including type of resources and vaults).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLegalHoldCmdlet.Tag"> <summary> <para> <para>Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLegalHoldCmdlet.Title"> <summary> <para> <para>This is the string title of the legal hold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLegalHoldCmdlet.DateRange_ToDate"> <summary> <para> <para>This value is the end date, inclusive.</para><para>The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLegalHoldCmdlet.RecoveryPointSelection_VaultName"> <summary> <para> <para>These are the names of the vaults in which the selected recovery points are contained.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLegalHoldCmdlet.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.Backup.Model.CreateLegalHoldResponse). Specifying the name of a property of type Amazon.Backup.Model.CreateLegalHoldResponse 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.BAK.NewBAKLegalHoldCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Title parameter. The -PassThru parameter is deprecated, use -Select '^Title' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLegalHoldCmdlet.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.BAK.NewBAKLogicallyAirGappedBackupVaultCmdlet"> <summary> This request creates a logical container to where backups may be copied. <para> This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID. </para><note><para> Do not include sensitive data, such as passport numbers, in the name of a backup vault. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLogicallyAirGappedBackupVaultCmdlet.BackupVaultName"> <summary> <para> <para>This is the name of the vault that is being created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLogicallyAirGappedBackupVaultCmdlet.BackupVaultTag"> <summary> <para> <para>These are the tags that will be included in the newly-created vault.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLogicallyAirGappedBackupVaultCmdlet.CreatorRequestId"> <summary> <para> <para>This is the ID of the creation request.</para><para>This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLogicallyAirGappedBackupVaultCmdlet.MaxRetentionDay"> <summary> <para> <para>This is the setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Backup does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).</para><para>If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLogicallyAirGappedBackupVaultCmdlet.MinRetentionDay"> <summary> <para> <para>This setting specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, no minimum retention period is enforced.</para><para>If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If a job retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLogicallyAirGappedBackupVaultCmdlet.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.Backup.Model.CreateLogicallyAirGappedBackupVaultResponse). Specifying the name of a property of type Amazon.Backup.Model.CreateLogicallyAirGappedBackupVaultResponse 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.BAK.NewBAKLogicallyAirGappedBackupVaultCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupVaultName parameter. The -PassThru parameter is deprecated, use -Select '^BackupVaultName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKLogicallyAirGappedBackupVaultCmdlet.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.BAK.NewBAKReportPlanCmdlet"> <summary> Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it. <para> If you call <c>CreateReportPlan</c> with a plan that already exists, you receive an <c>AlreadyExistsException</c> exception. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKReportPlanCmdlet.ReportSetting_Account"> <summary> <para> <para>These are the accounts to be included in the report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKReportPlanCmdlet.ReportDeliveryChannel_Format"> <summary> <para> <para>A list of the format of your reports: <c>CSV</c>, <c>JSON</c>, or both. If not specified, the default format is <c>CSV</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKReportPlanCmdlet.ReportSetting_FrameworkArn"> <summary> <para> <para>The Amazon Resource Names (ARNs) of the frameworks a report covers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKReportPlanCmdlet.IdempotencyToken"> <summary> <para> <para>A customer-chosen string that you can use to distinguish between otherwise identical calls to <c>CreateReportPlanInput</c>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKReportPlanCmdlet.ReportSetting_NumberOfFramework"> <summary> <para> <para>The number of frameworks a report covers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKReportPlanCmdlet.ReportSetting_OrganizationUnit"> <summary> <para> <para>These are the Organizational Units to be included in the report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKReportPlanCmdlet.ReportSetting_Region"> <summary> <para> <para>These are the Regions to be included in the report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKReportPlanCmdlet.ReportPlanDescription"> <summary> <para> <para>An optional description of the report plan with a maximum of 1,024 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKReportPlanCmdlet.ReportPlanName"> <summary> <para> <para>The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKReportPlanCmdlet.ReportPlanTag"> <summary> <para> <para>Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKReportPlanCmdlet.ReportSetting_ReportTemplate"> <summary> <para> <para>Identifies the report template for the report. Reports are built using a report template. The report templates are:</para><para><c>RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKReportPlanCmdlet.ReportDeliveryChannel_S3BucketName"> <summary> <para> <para>The unique name of the S3 bucket that receives your reports.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKReportPlanCmdlet.ReportDeliveryChannel_S3KeyPrefix"> <summary> <para> <para>The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/<c>prefix</c>/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKReportPlanCmdlet.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.Backup.Model.CreateReportPlanResponse). Specifying the name of a property of type Amazon.Backup.Model.CreateReportPlanResponse 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.BAK.NewBAKReportPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReportPlanName parameter. The -PassThru parameter is deprecated, use -Select '^ReportPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKReportPlanCmdlet.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.BAK.NewBAKRestoreTestingPlanCmdlet"> <summary> This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection. <para> You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingPlanCmdlet.RecoveryPointSelection_Algorithm"> <summary> <para> <para>Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingPlanCmdlet.CreatorRequestId"> <summary> <para> <para>This is a unique string that identifies the request and allows failed requests to be retriedwithout the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingPlanCmdlet.RecoveryPointSelection_ExcludeVault"> <summary> <para> <para>Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingPlanCmdlet.RecoveryPointSelection_IncludeVault"> <summary> <para> <para>Accepted values include wildcard ["*"] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:*:*:backup-vault:asdf-*", ...]</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingPlanCmdlet.RecoveryPointSelection_RecoveryPointType"> <summary> <para> <para>These are the types of recovery points.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingPlanCmdlet.RestoreTestingPlan_RestoreTestingPlanName"> <summary> <para> <para>The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingPlanCmdlet.RestoreTestingPlan_ScheduleExpression"> <summary> <para> <para>A CRON expression in specified timezone when a restore testing plan is executed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingPlanCmdlet.RestoreTestingPlan_ScheduleExpressionTimezone"> <summary> <para> <para>Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingPlanCmdlet.RecoveryPointSelection_SelectionWindowDay"> <summary> <para> <para>Accepted values are integers from 1 to 365.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingPlanCmdlet.RestoreTestingPlan_StartWindowHour"> <summary> <para> <para>Defaults to 24 hours.</para><para>A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingPlanCmdlet.Tag"> <summary> <para> <para>Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters,numbers, spaces, and the following characters: + - = . _ : /.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingPlanCmdlet.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.Backup.Model.CreateRestoreTestingPlanResponse). Specifying the name of a property of type Amazon.Backup.Model.CreateRestoreTestingPlanResponse 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.BAK.NewBAKRestoreTestingPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RestoreTestingPlan_RestoreTestingPlanName parameter. The -PassThru parameter is deprecated, use -Select '^RestoreTestingPlan_RestoreTestingPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingPlanCmdlet.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.BAK.NewBAKRestoreTestingSelectionCmdlet"> <summary> This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially. <para> This consists of <c>RestoreTestingSelectionName</c>, <c>ProtectedResourceType</c>, and one of the following: </para><ul><li><para><c>ProtectedResourceArns</c></para></li><li><para><c>ProtectedResourceConditions</c></para></li></ul><para> Each protected resource type can have one single value. </para><para> A restore testing selection can include a wildcard value ("*") for <c>ProtectedResourceArns</c> along with <c>ProtectedResourceConditions</c>. Alternatively, you can include up to 30 specific protected resource ARNs in <c>ProtectedResourceArns</c>. </para><para> Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingSelectionCmdlet.CreatorRequestId"> <summary> <para> <para>This is an optional unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingSelectionCmdlet.RestoreTestingSelection_IamRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: <c>arn:aws:iam::123456789012:role/S3Access</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingSelectionCmdlet.RestoreTestingSelection_ProtectedResourceArn"> <summary> <para> <para>Each protected resource can be filtered by its specific ARNs, such as <c>ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."]</c> or by a wildcard: <c>ProtectedResourceArns: ["*"]</c>, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingSelectionCmdlet.RestoreTestingSelection_ProtectedResourceType"> <summary> <para> <para>The type of Amazon Web Services resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.</para><para>Supported resource types accepted include:</para><ul><li><para><c>Aurora</c> for Amazon Aurora</para></li><li><para><c>DocumentDB</c> for Amazon DocumentDB (with MongoDB compatibility)</para></li><li><para><c>DynamoDB</c> for Amazon DynamoDB</para></li><li><para><c>EBS</c> for Amazon Elastic Block Store</para></li><li><para><c>EC2</c> for Amazon Elastic Compute Cloud</para></li><li><para><c>EFS</c> for Amazon Elastic File System</para></li><li><para><c>FSx</c> for Amazon FSx</para></li><li><para><c>Neptune</c> for Amazon Neptune</para></li><li><para><c>RDS</c> for Amazon Relational Database Service</para></li><li><para><c>S3</c> for Amazon S3</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingSelectionCmdlet.RestoreTestingSelection_RestoreMetadataOverride"> <summary> <para> <para>You can override certain restore metadata keys by including the parameter <c>RestoreMetadataOverrides</c> in the body of <c>RestoreTestingSelection</c>. Key values are not case sensitive.</para><para>See the complete list of <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html">restore testing inferred metadata</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingSelectionCmdlet.RestoreTestingPlanName"> <summary> <para> <para>Input the restore testing plan name that was returned from the related CreateRestoreTestingPlan request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingSelectionCmdlet.RestoreTestingSelection_RestoreTestingSelectionName"> <summary> <para> <para>This is the unique name of the restore testing selection that belongs to the related restore testing plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingSelectionCmdlet.ProtectedResourceConditions_StringEqual"> <summary> <para> <para>Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingSelectionCmdlet.ProtectedResourceConditions_StringNotEqual"> <summary> <para> <para>Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingSelectionCmdlet.RestoreTestingSelection_ValidationWindowHour"> <summary> <para> <para>This is amount of hours (1 to 168) available to run a validation script on the data. The data will be deleted upon the completion of the validation script or the end of the specified retention period, whichever comes first.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingSelectionCmdlet.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.Backup.Model.CreateRestoreTestingSelectionResponse). Specifying the name of a property of type Amazon.Backup.Model.CreateRestoreTestingSelectionResponse 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.BAK.NewBAKRestoreTestingSelectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RestoreTestingPlanName parameter. The -PassThru parameter is deprecated, use -Select '^RestoreTestingPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.NewBAKRestoreTestingSelectionCmdlet.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.BAK.RemoveBAKBackupPlanCmdlet"> <summary> Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupPlanCmdlet.BackupPlanId"> <summary> <para> <para>Uniquely identifies a backup plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupPlanCmdlet.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.Backup.Model.DeleteBackupPlanResponse). Specifying the name of a property of type Amazon.Backup.Model.DeleteBackupPlanResponse 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.BAK.RemoveBAKBackupPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupPlanId parameter. The -PassThru parameter is deprecated, use -Select '^BackupPlanId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupPlanCmdlet.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.BAK.RemoveBAKBackupSelectionCmdlet"> <summary> Deletes the resource selection associated with a backup plan that is specified by the <c>SelectionId</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupSelectionCmdlet.BackupPlanId"> <summary> <para> <para>Uniquely identifies a backup plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupSelectionCmdlet.SelectionId"> <summary> <para> <para>Uniquely identifies the body of a request to assign a set of resources to a backup plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupSelectionCmdlet.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.Backup.Model.DeleteBackupSelectionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupSelectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SelectionId parameter. The -PassThru parameter is deprecated, use -Select '^SelectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupSelectionCmdlet.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.BAK.RemoveBAKBackupVaultCmdlet"> <summary> Deletes the backup vault identified by its name. A vault can be deleted only if it is empty. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultCmdlet.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.Backup.Model.DeleteBackupVaultResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupVaultName parameter. The -PassThru parameter is deprecated, use -Select '^BackupVaultName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultCmdlet.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.BAK.RemoveBAKBackupVaultAccessPolicyCmdlet"> <summary> Deletes the policy document that manages permissions on a backup vault. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultAccessPolicyCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultAccessPolicyCmdlet.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.Backup.Model.DeleteBackupVaultAccessPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultAccessPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupVaultName parameter. The -PassThru parameter is deprecated, use -Select '^BackupVaultName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultAccessPolicyCmdlet.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.BAK.RemoveBAKBackupVaultLockConfigurationCmdlet"> <summary> Deletes Backup Vault Lock from a backup vault specified by a backup vault name. <para> If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you will receive an <c>InvalidRequestException</c> if you attempt to do so. For more information, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html">Vault Lock</a> in the <i>Backup Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultLockConfigurationCmdlet.BackupVaultName"> <summary> <para> <para>The name of the backup vault from which to delete Backup Vault Lock.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultLockConfigurationCmdlet.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.Backup.Model.DeleteBackupVaultLockConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultLockConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupVaultName parameter. The -PassThru parameter is deprecated, use -Select '^BackupVaultName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultLockConfigurationCmdlet.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.BAK.RemoveBAKBackupVaultNotificationCmdlet"> <summary> Deletes event notifications for the specified backup vault. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultNotificationCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultNotificationCmdlet.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.Backup.Model.DeleteBackupVaultNotificationsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultNotificationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupVaultName parameter. The -PassThru parameter is deprecated, use -Select '^BackupVaultName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKBackupVaultNotificationCmdlet.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.BAK.RemoveBAKFrameworkCmdlet"> <summary> Deletes the framework specified by a framework name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKFrameworkCmdlet.FrameworkName"> <summary> <para> <para>The unique name of a framework.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKFrameworkCmdlet.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.Backup.Model.DeleteFrameworkResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKFrameworkCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FrameworkName parameter. The -PassThru parameter is deprecated, use -Select '^FrameworkName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKFrameworkCmdlet.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.BAK.RemoveBAKRecoveryPointCmdlet"> <summary> Deletes the recovery point specified by a recovery point ID. <para> If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup. </para><para> When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an <c>EXPIRED</c> state. </para><para><c>EXPIRED</c> recovery points can be deleted with this API once the IAM role has the <c>iam:CreateServiceLinkedRole</c> action. To learn more about adding this role, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/deleting-backups.html#deleting-backups-troubleshooting"> Troubleshooting manual deletions</a>. </para><para> If the user or role is deleted or the permission within the role is removed, the deletion will not be successful and will enter an <c>EXPIRED</c> state. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKRecoveryPointCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKRecoveryPointCmdlet.RecoveryPointArn"> <summary> <para> <para>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <c>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKRecoveryPointCmdlet.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.Backup.Model.DeleteRecoveryPointResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKRecoveryPointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RecoveryPointArn parameter. The -PassThru parameter is deprecated, use -Select '^RecoveryPointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKRecoveryPointCmdlet.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.BAK.RemoveBAKReportPlanCmdlet"> <summary> Deletes the report plan specified by a report plan name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKReportPlanCmdlet.ReportPlanName"> <summary> <para> <para>The unique name of a report plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKReportPlanCmdlet.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.Backup.Model.DeleteReportPlanResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKReportPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReportPlanName parameter. The -PassThru parameter is deprecated, use -Select '^ReportPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKReportPlanCmdlet.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.BAK.RemoveBAKResourceTagCmdlet"> <summary> Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN) </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKResourceTagCmdlet.ResourceArn"> <summary> <para> <para>An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKResourceTagCmdlet.TagKeyList"> <summary> <para> <para>A list of keys to identify which key-value tags to remove from a resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKResourceTagCmdlet.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.Backup.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKResourceTagCmdlet.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.BAK.RemoveBAKRestoreTestingPlanCmdlet"> <summary> This request deletes the specified restore testing plan. <para> Deletion can only successfully occur if all associated restore testing selections are deleted first. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKRestoreTestingPlanCmdlet.RestoreTestingPlanName"> <summary> <para> <para>Required unique name of the restore testing plan you wish to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKRestoreTestingPlanCmdlet.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.Backup.Model.DeleteRestoreTestingPlanResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKRestoreTestingPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RestoreTestingPlanName parameter. The -PassThru parameter is deprecated, use -Select '^RestoreTestingPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKRestoreTestingPlanCmdlet.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.BAK.RemoveBAKRestoreTestingSelectionCmdlet"> <summary> Input the Restore Testing Plan name and Restore Testing Selection name. <para> All testing selections associated with a restore testing plan must be deleted before the restore testing plan can be deleted. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKRestoreTestingSelectionCmdlet.RestoreTestingPlanName"> <summary> <para> <para>Required unique name of the restore testing plan that contains the restore testing selection you wish to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKRestoreTestingSelectionCmdlet.RestoreTestingSelectionName"> <summary> <para> <para>Required unique name of the restore testing selection you wish to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKRestoreTestingSelectionCmdlet.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.Backup.Model.DeleteRestoreTestingSelectionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKRestoreTestingSelectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RestoreTestingSelectionName parameter. The -PassThru parameter is deprecated, use -Select '^RestoreTestingSelectionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.RemoveBAKRestoreTestingSelectionCmdlet.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.BAK.StartBAKBackupJobCmdlet"> <summary> Starts an on-demand backup job for the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKBackupJobCmdlet.BackupOption"> <summary> <para> <para>Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.</para><para>Valid values: Set to <c>"WindowsVSS":"enabled"</c> to enable the <c>WindowsVSS</c> backup option and create a Windows VSS backup. Set to <c>"WindowsVSS""disabled"</c> to create a regular backup. The <c>WindowsVSS</c> option is not enabled by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKBackupJobCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKBackupJobCmdlet.CompleteWindowMinute"> <summary> <para> <para>A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for <c>StartWindowMinutes</c>, or if the backup started later than scheduled.</para><para>Like <c>StartWindowMinutes</c>, this parameter has a maximum value of 100 years (52,560,000 minutes).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKBackupJobCmdlet.Lifecycle_DeleteAfterDay"> <summary> <para> <para>Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus <c>MoveToColdStorageAfterDays</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKBackupJobCmdlet.IamRoleArn"> <summary> <para> <para>Specifies the IAM role ARN used to create the target recovery point; for example, <c>arn:aws:iam::123456789012:role/S3Access</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKBackupJobCmdlet.IdempotencyToken"> <summary> <para> <para>A customer-chosen string that you can use to distinguish between otherwise identical calls to <c>StartBackupJob</c>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKBackupJobCmdlet.Lifecycle_MoveToColdStorageAfterDay"> <summary> <para> <para>Specifies the number of days after creation that a recovery point is moved to cold storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKBackupJobCmdlet.Lifecycle_OptInToArchiveForSupportedResource"> <summary> <para> <para>Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKBackupJobCmdlet.RecoveryPointTag"> <summary> <para> <para>To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKBackupJobCmdlet.ResourceArn"> <summary> <para> <para>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKBackupJobCmdlet.StartWindowMinute"> <summary> <para> <para>A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.</para><para>This parameter has a maximum value of 100 years (52,560,000 minutes).</para><para>During the start window, the backup job status remains in <c>CREATED</c> status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to <c>RUNNING</c>) or until the job status changes to <c>EXPIRED</c> (which is expected to occur when the start window time is over).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKBackupJobCmdlet.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.Backup.Model.StartBackupJobResponse). Specifying the name of a property of type Amazon.Backup.Model.StartBackupJobResponse 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.BAK.StartBAKBackupJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKBackupJobCmdlet.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.BAK.StartBAKCopyJobCmdlet"> <summary> Starts a job to create a one-time copy of the specified resource. <para> Does not support continuous backups. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKCopyJobCmdlet.Lifecycle_DeleteAfterDay"> <summary> <para> <para>Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus <c>MoveToColdStorageAfterDays</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKCopyJobCmdlet.DestinationBackupVaultArn"> <summary> <para> <para>An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, <c>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKCopyJobCmdlet.IamRoleArn"> <summary> <para> <para>Specifies the IAM role ARN used to copy the target recovery point; for example, <c>arn:aws:iam::123456789012:role/S3Access</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKCopyJobCmdlet.IdempotencyToken"> <summary> <para> <para>A customer-chosen string that you can use to distinguish between otherwise identical calls to <c>StartCopyJob</c>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKCopyJobCmdlet.Lifecycle_MoveToColdStorageAfterDay"> <summary> <para> <para>Specifies the number of days after creation that a recovery point is moved to cold storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKCopyJobCmdlet.Lifecycle_OptInToArchiveForSupportedResource"> <summary> <para> <para>Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKCopyJobCmdlet.RecoveryPointArn"> <summary> <para> <para>An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKCopyJobCmdlet.SourceBackupVaultName"> <summary> <para> <para>The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKCopyJobCmdlet.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.Backup.Model.StartCopyJobResponse). Specifying the name of a property of type Amazon.Backup.Model.StartCopyJobResponse 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.BAK.StartBAKCopyJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SourceBackupVaultName parameter. The -PassThru parameter is deprecated, use -Select '^SourceBackupVaultName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKCopyJobCmdlet.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.BAK.StartBAKReportJobCmdlet"> <summary> Starts an on-demand report job for the specified report plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKReportJobCmdlet.IdempotencyToken"> <summary> <para> <para>A customer-chosen string that you can use to distinguish between otherwise identical calls to <c>StartReportJobInput</c>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKReportJobCmdlet.ReportPlanName"> <summary> <para> <para>The unique name of a report plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKReportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportJobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.StartReportJobResponse). Specifying the name of a property of type Amazon.Backup.Model.StartReportJobResponse 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.BAK.StartBAKReportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReportPlanName parameter. The -PassThru parameter is deprecated, use -Select '^ReportPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKReportJobCmdlet.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.BAK.StartBAKRestoreJobCmdlet"> <summary> Recovers the saved resource identified by an Amazon Resource Name (ARN). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKRestoreJobCmdlet.CopySourceTagsToRestoredResource"> <summary> <para> <para>This is an optional parameter. If this equals <c>True</c>, tags included in the backup will be copied to the restored resource.</para><para>This can only be applied to backups created through Backup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKRestoreJobCmdlet.IamRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: <c>arn:aws:iam::123456789012:role/S3Access</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKRestoreJobCmdlet.IdempotencyToken"> <summary> <para> <para>A customer-chosen string that you can use to distinguish between otherwise identical calls to <c>StartRestoreJob</c>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKRestoreJobCmdlet.Metadata"> <summary> <para> <para>A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.</para><para> You can get configuration metadata about a resource at the time it was backed up by calling <c>GetRecoveryPointRestoreMetadata</c>. However, values in addition to those provided by <c>GetRecoveryPointRestoreMetadata</c> might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.</para><para>You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:</para><ul><li><para><c>file-system-id</c>: The ID of the Amazon EFS file system that is backed up by Backup. Returned in <c>GetRecoveryPointRestoreMetadata</c>.</para></li><li><para><c>Encrypted</c>: A Boolean value that, if true, specifies that the file system is encrypted. If <c>KmsKeyId</c> is specified, <c>Encrypted</c> must be set to <c>true</c>.</para></li><li><para><c>KmsKeyId</c>: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.</para></li><li><para><c>PerformanceMode</c>: Specifies the throughput mode of the file system.</para></li><li><para><c>CreationToken</c>: A user-supplied value that ensures the uniqueness (idempotency) of the request.</para></li><li><para><c>newFileSystem</c>: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.</para></li><li><para><c>ItemsToRestore</c>: An array of one to five strings where each string is a file path. Use <c>ItemsToRestore</c> to restore specific files or directories rather than the entire file system. This parameter is optional. For example, <c>"itemsToRestore":"[\"/my.test\"]"</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKRestoreJobCmdlet.RecoveryPointArn"> <summary> <para> <para>An ARN that uniquely identifies a recovery point; for example, <c>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKRestoreJobCmdlet.ResourceType"> <summary> <para> <para>Starts a job to restore a recovery point for one of the following resources:</para><ul><li><para><c>Aurora</c> for Amazon Aurora</para></li><li><para><c>DocumentDB</c> for Amazon DocumentDB (with MongoDB compatibility)</para></li><li><para><c>CloudFormation</c> for CloudFormation</para></li><li><para><c>DynamoDB</c> for Amazon DynamoDB</para></li><li><para><c>EBS</c> for Amazon Elastic Block Store</para></li><li><para><c>EC2</c> for Amazon Elastic Compute Cloud</para></li><li><para><c>EFS</c> for Amazon Elastic File System</para></li><li><para><c>FSx</c> for Amazon FSx</para></li><li><para><c>Neptune</c> for Amazon Neptune</para></li><li><para><c>RDS</c> for Amazon Relational Database Service</para></li><li><para><c>Redshift</c> for Amazon Redshift</para></li><li><para><c>Storage Gateway</c> for Storage Gateway</para></li><li><para><c>S3</c> for Amazon S3</para></li><li><para><c>Timestream</c> for Amazon Timestream</para></li><li><para><c>VirtualMachine</c> for virtual machines</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKRestoreJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RestoreJobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Backup.Model.StartRestoreJobResponse). Specifying the name of a property of type Amazon.Backup.Model.StartRestoreJobResponse 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.BAK.StartBAKRestoreJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RecoveryPointArn parameter. The -PassThru parameter is deprecated, use -Select '^RecoveryPointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StartBAKRestoreJobCmdlet.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.BAK.StopBAKBackupJobCmdlet"> <summary> Attempts to cancel a job to create a one-time backup of a resource. <para> This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StopBAKBackupJobCmdlet.BackupJobId"> <summary> <para> <para>Uniquely identifies a request to Backup to back up a resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StopBAKBackupJobCmdlet.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.Backup.Model.StopBackupJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StopBAKBackupJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupJobId parameter. The -PassThru parameter is deprecated, use -Select '^BackupJobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StopBAKBackupJobCmdlet.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.BAK.StopBAKLegalHoldCmdlet"> <summary> This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StopBAKLegalHoldCmdlet.CancelDescription"> <summary> <para> <para>String describing the reason for removing the legal hold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StopBAKLegalHoldCmdlet.LegalHoldId"> <summary> <para> <para>Legal hold ID required to remove the specified legal hold on a recovery point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StopBAKLegalHoldCmdlet.RetainRecordInDay"> <summary> <para> <para>The integer amount in days specifying amount of days after this API operation to remove legal hold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StopBAKLegalHoldCmdlet.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.Backup.Model.CancelLegalHoldResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StopBAKLegalHoldCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LegalHoldId parameter. The -PassThru parameter is deprecated, use -Select '^LegalHoldId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.StopBAKLegalHoldCmdlet.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.BAK.UnlockBAKRecoveryPointCmdlet"> <summary> Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan. <para> Does not support snapshot backup recovery points. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UnlockBAKRecoveryPointCmdlet.BackupVaultName"> <summary> <para> <para>The unique name of an Backup vault.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UnlockBAKRecoveryPointCmdlet.RecoveryPointArn"> <summary> <para> <para>An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UnlockBAKRecoveryPointCmdlet.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.Backup.Model.DisassociateRecoveryPointResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UnlockBAKRecoveryPointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RecoveryPointArn parameter. The -PassThru parameter is deprecated, use -Select '^RecoveryPointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UnlockBAKRecoveryPointCmdlet.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.BAK.UpdateBAKBackupPlanCmdlet"> <summary> Updates an existing backup plan identified by its <c>backupPlanId</c> with the input document in JSON format. The new version is uniquely identified by a <c>VersionId</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKBackupPlanCmdlet.BackupPlan_AdvancedBackupSetting"> <summary> <para> <para>Specifies a list of <c>BackupOptions</c> for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKBackupPlanCmdlet.BackupPlanId"> <summary> <para> <para>Uniquely identifies a backup plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKBackupPlanCmdlet.BackupPlan_BackupPlanName"> <summary> <para> <para>The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKBackupPlanCmdlet.BackupPlan_Rule"> <summary> <para> <para>An array of <c>BackupRule</c> objects, each of which specifies a scheduled task that is used to back up a selection of resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKBackupPlanCmdlet.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.Backup.Model.UpdateBackupPlanResponse). Specifying the name of a property of type Amazon.Backup.Model.UpdateBackupPlanResponse 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.BAK.UpdateBAKBackupPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupPlan_BackupPlanName parameter. The -PassThru parameter is deprecated, use -Select '^BackupPlan_BackupPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKBackupPlanCmdlet.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.BAK.UpdateBAKFrameworkCmdlet"> <summary> Updates an existing framework identified by its <c>FrameworkName</c> with the input document in JSON format. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKFrameworkCmdlet.FrameworkControl"> <summary> <para> <para>A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKFrameworkCmdlet.FrameworkDescription"> <summary> <para> <para>An optional description of the framework with a maximum 1,024 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKFrameworkCmdlet.FrameworkName"> <summary> <para> <para>The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKFrameworkCmdlet.IdempotencyToken"> <summary> <para> <para>A customer-chosen string that you can use to distinguish between otherwise identical calls to <c>UpdateFrameworkInput</c>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKFrameworkCmdlet.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.Backup.Model.UpdateFrameworkResponse). Specifying the name of a property of type Amazon.Backup.Model.UpdateFrameworkResponse 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.BAK.UpdateBAKFrameworkCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FrameworkName parameter. The -PassThru parameter is deprecated, use -Select '^FrameworkName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKFrameworkCmdlet.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.BAK.UpdateBAKGlobalSettingCmdlet"> <summary> Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management account. Use the <c>DescribeGlobalSettings</c> API to determine the current settings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKGlobalSettingCmdlet.GlobalSetting"> <summary> <para> <para>A value for <c>isCrossAccountBackupEnabled</c> and a Region. Example: <c>update-global-settings --global-settings isCrossAccountBackupEnabled=false --region us-west-2</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKGlobalSettingCmdlet.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.Backup.Model.UpdateGlobalSettingsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKGlobalSettingCmdlet.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.BAK.UpdateBAKRecoveryPointLifecycleCmdlet"> <summary> Sets the transition lifecycle of a recovery point. <para> The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. </para><para> Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </para><para> Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature availability by resource</a> table. Backup ignores this expression for other resource types. </para><para> This operation does not support continuous backups. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRecoveryPointLifecycleCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRecoveryPointLifecycleCmdlet.Lifecycle_DeleteAfterDay"> <summary> <para> <para>Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus <c>MoveToColdStorageAfterDays</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRecoveryPointLifecycleCmdlet.Lifecycle_MoveToColdStorageAfterDay"> <summary> <para> <para>Specifies the number of days after creation that a recovery point is moved to cold storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRecoveryPointLifecycleCmdlet.Lifecycle_OptInToArchiveForSupportedResource"> <summary> <para> <para>Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRecoveryPointLifecycleCmdlet.RecoveryPointArn"> <summary> <para> <para>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, <c>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRecoveryPointLifecycleCmdlet.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.Backup.Model.UpdateRecoveryPointLifecycleResponse). Specifying the name of a property of type Amazon.Backup.Model.UpdateRecoveryPointLifecycleResponse 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.BAK.UpdateBAKRecoveryPointLifecycleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RecoveryPointArn parameter. The -PassThru parameter is deprecated, use -Select '^RecoveryPointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRecoveryPointLifecycleCmdlet.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.BAK.UpdateBAKRegionSettingCmdlet"> <summary> Updates the current service opt-in settings for the Region. <para> Use the <c>DescribeRegionSettings</c> API to determine the resource types that are supported. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRegionSettingCmdlet.ResourceTypeManagementPreference"> <summary> <para> <para>Enables or disables full Backup management of backups for a resource type. To enable full Backup management for DynamoDB along with <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html"> Backup's advanced DynamoDB backup features</a>, follow the procedure to <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli"> enable advanced DynamoDB backup programmatically</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRegionSettingCmdlet.ResourceTypeOptInPreference"> <summary> <para> <para>Updates the list of services along with the opt-in preferences for the Region.</para><para>If resource assignments are only based on tags, then service opt-in settings are applied. If a resource type is explicitly assigned to a backup plan, such as Amazon S3, Amazon EC2, or Amazon RDS, it will be included in the backup even if the opt-in is not enabled for that particular service. If both a resource type and tags are specified in a resource assignment, the resource type specified in the backup plan takes priority over the tag condition. Service opt-in settings are disregarded in this situation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRegionSettingCmdlet.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.Backup.Model.UpdateRegionSettingsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRegionSettingCmdlet.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.BAK.UpdateBAKReportPlanCmdlet"> <summary> Updates an existing report plan identified by its <c>ReportPlanName</c> with the input document in JSON format. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKReportPlanCmdlet.ReportSetting_Account"> <summary> <para> <para>These are the accounts to be included in the report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKReportPlanCmdlet.ReportDeliveryChannel_Format"> <summary> <para> <para>A list of the format of your reports: <c>CSV</c>, <c>JSON</c>, or both. If not specified, the default format is <c>CSV</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKReportPlanCmdlet.ReportSetting_FrameworkArn"> <summary> <para> <para>The Amazon Resource Names (ARNs) of the frameworks a report covers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKReportPlanCmdlet.IdempotencyToken"> <summary> <para> <para>A customer-chosen string that you can use to distinguish between otherwise identical calls to <c>UpdateReportPlanInput</c>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKReportPlanCmdlet.ReportSetting_NumberOfFramework"> <summary> <para> <para>The number of frameworks a report covers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKReportPlanCmdlet.ReportSetting_OrganizationUnit"> <summary> <para> <para>These are the Organizational Units to be included in the report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKReportPlanCmdlet.ReportSetting_Region"> <summary> <para> <para>These are the Regions to be included in the report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKReportPlanCmdlet.ReportPlanDescription"> <summary> <para> <para>An optional description of the report plan with a maximum 1,024 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKReportPlanCmdlet.ReportPlanName"> <summary> <para> <para>The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKReportPlanCmdlet.ReportSetting_ReportTemplate"> <summary> <para> <para>Identifies the report template for the report. Reports are built using a report template. The report templates are:</para><para><c>RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKReportPlanCmdlet.ReportDeliveryChannel_S3BucketName"> <summary> <para> <para>The unique name of the S3 bucket that receives your reports.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKReportPlanCmdlet.ReportDeliveryChannel_S3KeyPrefix"> <summary> <para> <para>The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/<c>prefix</c>/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKReportPlanCmdlet.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.Backup.Model.UpdateReportPlanResponse). Specifying the name of a property of type Amazon.Backup.Model.UpdateReportPlanResponse 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.BAK.UpdateBAKReportPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReportPlanName parameter. The -PassThru parameter is deprecated, use -Select '^ReportPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKReportPlanCmdlet.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.BAK.UpdateBAKRestoreTestingPlanCmdlet"> <summary> This request will send changes to your specified restore testing plan. <c>RestoreTestingPlanName</c> cannot be updated after it is created. <para><c>RecoveryPointSelection</c> can contain: </para><ul><li><para><c>Algorithm</c></para></li><li><para><c>ExcludeVaults</c></para></li><li><para><c>IncludeVaults</c></para></li><li><para><c>RecoveryPointTypes</c></para></li><li><para><c>SelectionWindowDays</c></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingPlanCmdlet.RecoveryPointSelection_Algorithm"> <summary> <para> <para>Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingPlanCmdlet.RecoveryPointSelection_ExcludeVault"> <summary> <para> <para>Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingPlanCmdlet.RecoveryPointSelection_IncludeVault"> <summary> <para> <para>Accepted values include wildcard ["*"] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:*:*:backup-vault:asdf-*", ...]</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingPlanCmdlet.RecoveryPointSelection_RecoveryPointType"> <summary> <para> <para>These are the types of recovery points.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingPlanCmdlet.RestoreTestingPlanName"> <summary> <para> <para>This is the restore testing plan name you wish to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingPlanCmdlet.RestoreTestingPlan_ScheduleExpression"> <summary> <para> <para>A CRON expression in specified timezone when a restore testing plan is executed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingPlanCmdlet.RestoreTestingPlan_ScheduleExpressionTimezone"> <summary> <para> <para>Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingPlanCmdlet.RecoveryPointSelection_SelectionWindowDay"> <summary> <para> <para>Accepted values are integers from 1 to 365.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingPlanCmdlet.RestoreTestingPlan_StartWindowHour"> <summary> <para> <para>Defaults to 24 hours.</para><para>A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingPlanCmdlet.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.Backup.Model.UpdateRestoreTestingPlanResponse). Specifying the name of a property of type Amazon.Backup.Model.UpdateRestoreTestingPlanResponse 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.BAK.UpdateBAKRestoreTestingPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RestoreTestingPlanName parameter. The -PassThru parameter is deprecated, use -Select '^RestoreTestingPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingPlanCmdlet.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.BAK.UpdateBAKRestoreTestingSelectionCmdlet"> <summary> Most elements except the <c>RestoreTestingSelectionName</c> can be updated with this request. <para><c>RestoreTestingSelection</c> can use either protected resource ARNs or conditions, but not both. That is, if your selection has <c>ProtectedResourceArns</c>, requesting an update with the parameter <c>ProtectedResourceConditions</c> will be unsuccessful. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingSelectionCmdlet.RestoreTestingSelection_IamRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: <c>arn:aws:iam::123456789012:role/S3Access</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingSelectionCmdlet.RestoreTestingSelection_ProtectedResourceArn"> <summary> <para> <para>You can include a list of specific ARNs, such as <c>ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."]</c> or you can include a wildcard: <c>ProtectedResourceArns: ["*"]</c>, but not both.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingSelectionCmdlet.RestoreTestingSelection_RestoreMetadataOverride"> <summary> <para> <para>You can override certain restore metadata keys by including the parameter <c>RestoreMetadataOverrides</c> in the body of <c>RestoreTestingSelection</c>. Key values are not case sensitive.</para><para>See the complete list of <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html">restore testing inferred metadata</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingSelectionCmdlet.RestoreTestingPlanName"> <summary> <para> <para>The restore testing plan name is required to update the indicated testing plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingSelectionCmdlet.RestoreTestingSelectionName"> <summary> <para> <para>This is the required restore testing selection name of the restore testing selection you wish to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingSelectionCmdlet.ProtectedResourceConditions_StringEqual"> <summary> <para> <para>Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingSelectionCmdlet.ProtectedResourceConditions_StringNotEqual"> <summary> <para> <para>Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingSelectionCmdlet.RestoreTestingSelection_ValidationWindowHour"> <summary> <para> <para>This value represents the time, in hours, data is retained after a restore test so that optional validation can be completed.</para><para>Accepted value is an integer between 0 and 168 (the hourly equivalent of seven days).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingSelectionCmdlet.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.Backup.Model.UpdateRestoreTestingSelectionResponse). Specifying the name of a property of type Amazon.Backup.Model.UpdateRestoreTestingSelectionResponse 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.BAK.UpdateBAKRestoreTestingSelectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RestoreTestingSelectionName parameter. The -PassThru parameter is deprecated, use -Select '^RestoreTestingSelectionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.UpdateBAKRestoreTestingSelectionCmdlet.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.BAK.WriteBAKBackupVaultAccessPolicyCmdlet"> <summary> Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultAccessPolicyCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultAccessPolicyCmdlet.Policy"> <summary> <para> <para>The backup vault access policy document in JSON format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultAccessPolicyCmdlet.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.Backup.Model.PutBackupVaultAccessPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultAccessPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupVaultName parameter. The -PassThru parameter is deprecated, use -Select '^BackupVaultName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultAccessPolicyCmdlet.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.BAK.WriteBAKBackupVaultLockConfigurationCmdlet"> <summary> Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault. <note><para> Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the <a href="samples/cohassetreport.zip">Cohasset Associates Compliance Assessment.</a></para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultLockConfigurationCmdlet.BackupVaultName"> <summary> <para> <para>The Backup Vault Lock configuration that specifies the name of the backup vault it protects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultLockConfigurationCmdlet.ChangeableForDay"> <summary> <para> <para>The Backup Vault Lock configuration that specifies the number of days before the lock date. For example, setting <c>ChangeableForDays</c> to 30 on Jan. 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.</para><para>Backup enforces a 72-hour cooling-off period before Vault Lock takes effect and becomes immutable. Therefore, you must set <c>ChangeableForDays</c> to 3 or greater.</para><para>Before the lock date, you can delete Vault Lock from the vault using <c>DeleteBackupVaultLockConfiguration</c> or change the Vault Lock configuration using <c>PutBackupVaultLockConfiguration</c>. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted.</para><para>If this parameter is not specified, you can delete Vault Lock from the vault using <c>DeleteBackupVaultLockConfiguration</c> or change the Vault Lock configuration using <c>PutBackupVaultLockConfiguration</c> at any time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultLockConfigurationCmdlet.MaxRetentionDay"> <summary> <para> <para>The Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years (1460 days).</para><para>If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.</para><para>If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. The longest maximum retention period you can specify is 36500 days (approximately 100 years). Recovery points already saved in the vault prior to Vault Lock are not affected.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultLockConfigurationCmdlet.MinRetentionDay"> <summary> <para> <para>The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).</para><para>If this parameter is not specified, Vault Lock will not enforce a minimum retention period.</para><para>If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. The shortest minimum retention period you can specify is 1 day. Recovery points already saved in the vault prior to Vault Lock are not affected.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultLockConfigurationCmdlet.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.Backup.Model.PutBackupVaultLockConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultLockConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupVaultName parameter. The -PassThru parameter is deprecated, use -Select '^BackupVaultName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultLockConfigurationCmdlet.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.BAK.WriteBAKBackupVaultNotificationCmdlet"> <summary> Turns on notifications on a backup vault for the specified topic and events. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultNotificationCmdlet.BackupVaultEvent"> <summary> <para> <para>An array of events that indicate the status of jobs to back up resources to the backup vault.</para><para>For common use cases and code samples, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html">Using Amazon SNS to track Backup events</a>.</para><para>The following events are supported:</para><ul><li><para><c>BACKUP_JOB_STARTED</c> | <c>BACKUP_JOB_COMPLETED</c></para></li><li><para><c>COPY_JOB_STARTED</c> | <c>COPY_JOB_SUCCESSFUL</c> | <c>COPY_JOB_FAILED</c></para></li><li><para><c>RESTORE_JOB_STARTED</c> | <c>RESTORE_JOB_COMPLETED</c> | <c>RECOVERY_POINT_MODIFIED</c></para></li><li><para><c>S3_BACKUP_OBJECT_FAILED</c> | <c>S3_RESTORE_OBJECT_FAILED</c></para></li></ul><note><para>The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultNotificationCmdlet.BackupVaultName"> <summary> <para> <para>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultNotificationCmdlet.SNSTopicArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, <c>arn:aws:sns:us-west-2:111122223333:MyVaultTopic</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultNotificationCmdlet.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.Backup.Model.PutBackupVaultNotificationsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultNotificationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupVaultName parameter. The -PassThru parameter is deprecated, use -Select '^BackupVaultName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKBackupVaultNotificationCmdlet.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.BAK.WriteBAKRestoreValidationResultCmdlet"> <summary> This request allows you to send your independent self-run restore test validation results. <c>RestoreJobId</c> and <c>ValidationStatus</c> are required. Optionally, you can input a <c>ValidationStatusMessage</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKRestoreValidationResultCmdlet.RestoreJobId"> <summary> <para> <para>This is a unique identifier of a restore job within Backup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKRestoreValidationResultCmdlet.ValidationStatus"> <summary> <para> <para>This is the status of your restore validation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKRestoreValidationResultCmdlet.ValidationStatusMessage"> <summary> <para> <para>This is an optional message string you can input to describe the validation status for the restore test validation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKRestoreValidationResultCmdlet.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.Backup.Model.PutRestoreValidationResultResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKRestoreValidationResultCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RestoreJobId parameter. The -PassThru parameter is deprecated, use -Select '^RestoreJobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAK.WriteBAKRestoreValidationResultCmdlet.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> |