Skip to content

/AWS1/CL_BUPRESTORETSTINGSEL00

This contains metadata about a specific restore testing selection.

ProtectedResourceType is required, such as Amazon EBS or Amazon EC2.

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.

ProtectedResourceConditions examples include as StringEquals and StringNotEquals.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_iamrolearn TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

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.

iv_protectedresourcetype TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

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

iv_restoretestingselionname TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

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

The name consists of only alphanumeric characters and underscores. Maximum length is 50.

Optional arguments:

it_protectedresourcearns TYPE /AWS1/CL_BUPSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST

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.

io_protectedresourceconds TYPE REF TO /AWS1/CL_BUPPROTECTEDRESRCCO00 /AWS1/CL_BUPPROTECTEDRESRCCO00

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

it_restoremetadataoverrides TYPE /AWS1/CL_BUPSENSITIVESTRMAP_W=>TT_SENSITIVESTRINGMAP TT_SENSITIVESTRINGMAP

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.

iv_validationwindowhours TYPE /AWS1/BUPINTEGER /AWS1/BUPINTEGER

This is amount of hours (0 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.

Queryable Attributes

IamRoleArn

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.

Accessible with the following methods

Method Description
GET_IAMROLEARN() Getter for IAMROLEARN, with configurable default
ASK_IAMROLEARN() Getter for IAMROLEARN w/ exceptions if field has no value
HAS_IAMROLEARN() Determine if IAMROLEARN has a value

ProtectedResourceArns

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.

Accessible with the following methods

Method Description
GET_PROTECTEDRESOURCEARNS() Getter for PROTECTEDRESOURCEARNS, with configurable default
ASK_PROTECTEDRESOURCEARNS() Getter for PROTECTEDRESOURCEARNS w/ exceptions if field has
HAS_PROTECTEDRESOURCEARNS() Determine if PROTECTEDRESOURCEARNS has a value

ProtectedResourceConditions

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

Accessible with the following methods

Method Description
GET_PROTECTEDRESOURCECONDS() Getter for PROTECTEDRESOURCECONDITIONS

ProtectedResourceType

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

Accessible with the following methods

Method Description
GET_PROTECTEDRESOURCETYPE() Getter for PROTECTEDRESOURCETYPE, with configurable default
ASK_PROTECTEDRESOURCETYPE() Getter for PROTECTEDRESOURCETYPE w/ exceptions if field has
HAS_PROTECTEDRESOURCETYPE() Determine if PROTECTEDRESOURCETYPE has a value

RestoreMetadataOverrides

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.

Accessible with the following methods

Method Description
GET_RESTOREMETADATAOVERRIDES() Getter for RESTOREMETADATAOVERRIDES, with configurable defau
ASK_RESTOREMETADATAOVERRIDES() Getter for RESTOREMETADATAOVERRIDES w/ exceptions if field h
HAS_RESTOREMETADATAOVERRIDES() Determine if RESTOREMETADATAOVERRIDES has a value

RestoreTestingSelectionName

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

The name consists of only alphanumeric characters and underscores. Maximum length is 50.

Accessible with the following methods

Method Description
GET_RESTORETESTINGSELIONNAME() Getter for RESTORETESTINGSELECTIONNAME, with configurable de
ASK_RESTORETESTINGSELIONNAME() Getter for RESTORETESTINGSELECTIONNAME w/ exceptions if fiel
HAS_RESTORETESTINGSELIONNAME() Determine if RESTORETESTINGSELECTIONNAME has a value

ValidationWindowHours

This is amount of hours (0 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.

Accessible with the following methods

Method Description
GET_VALIDATIONWINDOWHOURS() Getter for VALIDATIONWINDOWHOURS