Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . backup ]

create-restore-testing-selection¶

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.

Synopsis¶

  create-restore-testing-selection
[--creator-request-id <value>]
--restore-testing-plan-name <value>
--restore-testing-selection <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--creator-request-id (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.

--restore-testing-plan-name (string)

Input the restore testing plan name that was returned from the related CreateRestoreTestingPlan request.

--restore-testing-selection (structure)

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 .

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 .

ProtectedResourceArns -> (list)

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.

(string)

ProtectedResourceConditions -> (structure)

If you have included the wildcard in ProtectedResourceArns, you can include resource conditions, such as ProtectedResourceConditions: { StringEquals: [{ key: "XXXX", value: "YYYY" }] .

StringEquals -> (list)

Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."

(structure)

Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: + - = . _ : /

Key -> (string)

The tag key (String). The key can't start with aws: .

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$

Value -> (string)

The value of the key.

Length Constraints: Maximum length of 256.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

StringNotEquals -> (list)

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."

(structure)

Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: + - = . _ : /

Key -> (string)

The tag key (String). The key can't start with aws: .

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$

Value -> (string)

The value of the key.

Length Constraints: Maximum length of 256.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

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

RestoreMetadataOverrides -> (map)

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 .

key -> (string)

value -> (string)

RestoreTestingSelectionName -> (string)

The unique name of the restore testing selection that belongs to the related restore testing plan.

ValidationWindowHours -> (integer)

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.

JSON Syntax:

{
  "IamRoleArn": "string",
  "ProtectedResourceArns": ["string", ...],
  "ProtectedResourceConditions": {
    "StringEquals": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ],
    "StringNotEquals": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  },
  "ProtectedResourceType": "string",
  "RestoreMetadataOverrides": {"string": "string"
    ...},
  "RestoreTestingSelectionName": "string",
  "ValidationWindowHours": integer
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

CreationTime -> (timestamp)

The time that the resource testing selection was created.

RestoreTestingPlanArn -> (string)

The ARN of the restore testing plan with which the restore testing selection is associated.

RestoreTestingPlanName -> (string)

The name of the restore testing plan.

The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.

RestoreTestingSelectionName -> (string)

The name of the restore testing selection for the related restore testing plan.

Table Of Contents

Feedback

User Guide