AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Backup CreateRestoreTestingSelection API operation.

Syntax

New-BAKRestoreTestingSelection
-RestoreTestingPlanName <String>
-CreatorRequestId <String>
-RestoreTestingSelection_IamRoleArn <String>
-RestoreTestingSelection_ProtectedResourceArn <String[]>
-RestoreTestingSelection_ProtectedResourceType <String>
-RestoreTestingSelection_RestoreMetadataOverride <Hashtable>
-RestoreTestingSelection_RestoreTestingSelectionName <String>
-ProtectedResourceConditions_StringEqual <KeyValue[]>
-ProtectedResourceConditions_StringNotEqual <KeyValue[]>
-RestoreTestingSelection_ValidationWindowHour <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonBackupConfig>

Description

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. This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the following:
  • ProtectedResourceArns
  • ProtectedResourceConditions
Each protected resource type can have one single value. A restore testing selection can include a wildcard value ("*") for ProtectedResourceArns along with ProtectedResourceConditions. Alternatively, you can include up to 30 specific protected resource ARNs in ProtectedResourceArns. Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.

Parameters

-ClientConfig <AmazonBackupConfig>
Amazon.PowerShell.Cmdlets.BAK.AmazonBackupClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CreatorRequestId <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProtectedResourceConditions_StringEqual <KeyValue[]>
Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRestoreTestingSelection_ProtectedResourceConditions_StringEquals
-ProtectedResourceConditions_StringNotEqual <KeyValue[]>
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."
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRestoreTestingSelection_ProtectedResourceConditions_StringNotEquals
-RestoreTestingPlanName <String>
Input the restore testing plan name that was returned from the related CreateRestoreTestingPlan request.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-RestoreTestingSelection_IamRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestoreTestingSelection_ProtectedResourceArn <String[]>
Each protected resource can be filtered by its specific ARNs, such as ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."] or by a wildcard: ProtectedResourceArns: ["*"], but not both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRestoreTestingSelection_ProtectedResourceArns
-RestoreTestingSelection_ProtectedResourceType <String>
The type of Amazon Web Services resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.Supported resource types accepted include:
  • Aurora for Amazon Aurora
  • DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
  • DynamoDB for Amazon DynamoDB
  • EBS for Amazon Elastic Block Store
  • EC2 for Amazon Elastic Compute Cloud
  • EFS for Amazon Elastic File System
  • FSx for Amazon FSx
  • Neptune for Amazon Neptune
  • RDS for Amazon Relational Database Service
  • S3 for Amazon S3
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestoreTestingSelection_RestoreMetadataOverride <Hashtable>
You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection. Key values are not case sensitive.See the complete list of restore testing inferred metadata.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRestoreTestingSelection_RestoreMetadataOverrides
-RestoreTestingSelection_RestoreTestingSelectionName <String>
This is the unique name of the restore testing selection that belongs to the related restore testing plan.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RestoreTestingSelection_ValidationWindowHour <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRestoreTestingSelection_ValidationWindowHours
-Select <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Backup.Model.CreateRestoreTestingSelectionResponse
This cmdlet returns an Amazon.Backup.Model.CreateRestoreTestingSelectionResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z