Package software.amazon.awscdk.services.backup

Interface CfnRestoreTestingSelectionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRestoreTestingSelectionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:11.775Z")
@Stability(Stable)
public interface CfnRestoreTestingSelectionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRestoreTestingSelection.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.backup.*;
 CfnRestoreTestingSelectionProps cfnRestoreTestingSelectionProps = CfnRestoreTestingSelectionProps.builder()
         .iamRoleArn("iamRoleArn")
         .protectedResourceType("protectedResourceType")
         .restoreTestingPlanName("restoreTestingPlanName")
         .restoreTestingSelectionName("restoreTestingSelectionName")
         // the properties below are optional
         .protectedResourceArns(List.of("protectedResourceArns"))
         .protectedResourceConditions(ProtectedResourceConditionsProperty.builder()
                 .stringEquals(List.of(KeyValueProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .stringNotEquals(List.of(KeyValueProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build())
         .restoreMetadataOverrides(Map.of(
                 "restoreMetadataOverridesKey", "restoreMetadataOverrides"))
         .validationWindowHours(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRestoreTestingSelectionProps.Builder	A builder for CfnRestoreTestingSelectionProps
static final class	CfnRestoreTestingSelectionProps.Jsii$Proxy	An implementation for CfnRestoreTestingSelectionProps

Method Summary

Modifier and Type	Method	Description
static CfnRestoreTestingSelectionProps.Builder	builder()
String	getIamRoleArn()	The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target resource;
default List<String>	getProtectedResourceArns()	You can include specific ARNs, such as ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."] or you can include a wildcard: ProtectedResourceArns: ["*"] , but not both.
default Object	getProtectedResourceConditions()	In a resource testing selection, this parameter filters by specific conditions such as StringEquals or StringNotEquals .
String	getProtectedResourceType()	The type of AWS resource included in a resource testing selection;
default Object	getRestoreMetadataOverrides()	You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection .
String	getRestoreTestingPlanName()	Unique string that is the name of the restore testing plan.
String	getRestoreTestingSelectionName()	The unique name of the restore testing selection that belongs to the related restore testing plan.
default Number	getValidationWindowHours()	This is amount of hours (1 to 168) available to run a validation script on the data.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIamRoleArn

@Stability(Stable)
@NotNull
String getIamRoleArn()

The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target resource;

for example: arn:aws:iam::123456789012:role/S3Access .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-iamrolearn

getProtectedResourceType

@Stability(Stable)
@NotNull
String getProtectedResourceType()

The type of AWS resource included in a resource testing selection;

for example, an Amazon EBS volume or an Amazon RDS database.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-protectedresourcetype

getRestoreTestingPlanName

@Stability(Stable)
@NotNull
String getRestoreTestingPlanName()

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-restoretestingplanname

getRestoreTestingSelectionName

@Stability(Stable)
@NotNull
String getRestoreTestingSelectionName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-restoretestingselectionname

getProtectedResourceArns

@Stability(Stable)
@Nullable
default List<String> getProtectedResourceArns()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-protectedresourcearns

getProtectedResourceConditions

@Stability(Stable)
@Nullable
default Object getProtectedResourceConditions()

In a resource testing selection, this parameter filters by specific conditions such as StringEquals or StringNotEquals .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-protectedresourceconditions

getRestoreMetadataOverrides

@Stability(Stable)
@Nullable
default Object getRestoreMetadataOverrides()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-restoremetadataoverrides

getValidationWindowHours

@Stability(Stable)
@Nullable
default Number getValidationWindowHours()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-validationwindowhours

builder

@Stability(Stable)
static CfnRestoreTestingSelectionProps.Builder builder()

Returns:

a CfnRestoreTestingSelectionProps.Builder of CfnRestoreTestingSelectionProps