[ aws . backup ]

update-restore-testing-selection

Description

Updates the specified restore testing selection.

Most elements except the RestoreTestingSelectionName can be updated with this request.

You can use either protected resource ARNs or conditions, but not both.

See also: AWS API Documentation

Synopsis

  update-restore-testing-selection
--restore-testing-plan-name <value>
--restore-testing-selection <value>
--restore-testing-selection-name <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

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

The restore testing plan name is required to update the indicated testing plan.

--restore-testing-selection (structure)

To update your restore testing selection, you can use either protected resource ARNs or conditions, but not both. That is, if your selection has ProtectedResourceArns , requesting an update with the parameter ProtectedResourceConditions will be unsuccessful.

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)

You can include a list of specific ARNs, such as ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."] or you can include a wildcard: ProtectedResourceArns: ["*"] , but not both.

(string)

ProtectedResourceConditions -> (structure)

The conditions that you define for resources in your restore testing plan using tags.

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}_.:/=+\-@]*)$

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)

ValidationWindowHours -> (integer)

This value represents the time, in hours, data is retained after a restore test so that optional validation can be completed.

Accepted value is an integer between 0 and 168 (the hourly equivalent of seven days).

JSON Syntax:

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

--restore-testing-selection-name (string)

The required restore testing selection name of the restore testing selection you wish to update.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
• yaml
• yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

CreationTime -> (timestamp)

The time the resource testing selection was updated successfully.

RestoreTestingPlanArn -> (string)

Unique string that is the name of the restore testing plan.

RestoreTestingPlanName -> (string)

The restore testing plan with which the updated restore testing selection is associated.

RestoreTestingSelectionName -> (string)

The returned restore testing selection name.

UpdateTime -> (timestamp)

The time the update completed for the restore testing selection.