com.amazonaws.services.backup.model

Class RestoreTestingSelectionForCreate

java.lang.Object

com.amazonaws.services.backup.model.RestoreTestingSelectionForCreate

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RestoreTestingSelectionForCreate
extends Object
implements Serializable, Cloneable, StructuredPojo

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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RestoreTestingSelectionForCreate()

Method Summary

Modifier and Type	Method and Description
RestoreTestingSelectionForCreate	addRestoreMetadataOverridesEntry(String key, String value) Add a single RestoreMetadataOverrides entry
RestoreTestingSelectionForCreate	clearRestoreMetadataOverridesEntries() Removes all the entries added into RestoreMetadataOverrides.
RestoreTestingSelectionForCreate	clone()
boolean	equals(Object obj)
String	getIamRoleArn() 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.
List<String>	getProtectedResourceArns() 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.
ProtectedResourceConditions	getProtectedResourceConditions() If you have included the wildcard in ProtectedResourceArns, you can include resource conditions, such as ProtectedResourceConditions: { StringEquals: [{ key: "XXXX", value: "YYYY" }].
String	getProtectedResourceType() The type of Amazon Web Services resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.
Map<String,String>	getRestoreMetadataOverrides() You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection.
String	getRestoreTestingSelectionName() This is the unique name of the restore testing selection that belongs to the related restore testing plan.
Integer	getValidationWindowHours() This is amount of hours (1 to 168) available to run a validation script on the data.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setIamRoleArn(String 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.
void	setProtectedResourceArns(Collection<String> 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.
void	setProtectedResourceConditions(ProtectedResourceConditions protectedResourceConditions) If you have included the wildcard in ProtectedResourceArns, you can include resource conditions, such as ProtectedResourceConditions: { StringEquals: [{ key: "XXXX", value: "YYYY" }].
void	setProtectedResourceType(String 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.
void	setRestoreMetadataOverrides(Map<String,String> restoreMetadataOverrides) You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection.
void	setRestoreTestingSelectionName(String restoreTestingSelectionName) This is the unique name of the restore testing selection that belongs to the related restore testing plan.
void	setValidationWindowHours(Integer validationWindowHours) This is amount of hours (1 to 168) available to run a validation script on the data.
String	toString() Returns a string representation of this object.
RestoreTestingSelectionForCreate	withIamRoleArn(String 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.
RestoreTestingSelectionForCreate	withProtectedResourceArns(Collection<String> 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.
RestoreTestingSelectionForCreate	withProtectedResourceArns(String... 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.
RestoreTestingSelectionForCreate	withProtectedResourceConditions(ProtectedResourceConditions protectedResourceConditions) If you have included the wildcard in ProtectedResourceArns, you can include resource conditions, such as ProtectedResourceConditions: { StringEquals: [{ key: "XXXX", value: "YYYY" }].
RestoreTestingSelectionForCreate	withProtectedResourceType(String 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.
RestoreTestingSelectionForCreate	withRestoreMetadataOverrides(Map<String,String> restoreMetadataOverrides) You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection.
RestoreTestingSelectionForCreate	withRestoreTestingSelectionName(String restoreTestingSelectionName) This is the unique name of the restore testing selection that belongs to the related restore testing plan.
RestoreTestingSelectionForCreate	withValidationWindowHours(Integer validationWindowHours) This is amount of hours (1 to 168) available to run a validation script on the data.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RestoreTestingSelectionForCreate

public RestoreTestingSelectionForCreate()

Method Detail

setIamRoleArn

public void setIamRoleArn(String 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.

Parameters:

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.

getIamRoleArn

public String getIamRoleArn()

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.

Returns:

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.

withIamRoleArn

public RestoreTestingSelectionForCreate withIamRoleArn(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getProtectedResourceArns

public List<String> getProtectedResourceArns()

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.

Returns:

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.

setProtectedResourceArns

public void setProtectedResourceArns(Collection<String> 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.

Parameters:

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.

withProtectedResourceArns

public RestoreTestingSelectionForCreate withProtectedResourceArns(String... 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.

NOTE: This method appends the values to the existing list (if any). Use setProtectedResourceArns(java.util.Collection) or withProtectedResourceArns(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withProtectedResourceArns

public RestoreTestingSelectionForCreate withProtectedResourceArns(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setProtectedResourceConditions

public void setProtectedResourceConditions(ProtectedResourceConditions protectedResourceConditions)

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

Parameters:

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

getProtectedResourceConditions

public ProtectedResourceConditions getProtectedResourceConditions()

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

Returns:

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

withProtectedResourceConditions

public RestoreTestingSelectionForCreate withProtectedResourceConditions(ProtectedResourceConditions protectedResourceConditions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setProtectedResourceType

public void setProtectedResourceType(String 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

Parameters:

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

getProtectedResourceType

public String getProtectedResourceType()

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

Returns:

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

withProtectedResourceType

public RestoreTestingSelectionForCreate withProtectedResourceType(String 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getRestoreMetadataOverrides

public Map<String,String> 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.

Returns:

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.

setRestoreMetadataOverrides

public void setRestoreMetadataOverrides(Map<String,String> 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.

Parameters:

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.

withRestoreMetadataOverrides

public RestoreTestingSelectionForCreate withRestoreMetadataOverrides(Map<String,String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addRestoreMetadataOverridesEntry

public RestoreTestingSelectionForCreate addRestoreMetadataOverridesEntry(String key,
                                                                         String value)

Add a single RestoreMetadataOverrides entry

See Also:

withRestoreMetadataOverrides(java.util.Map<java.lang.String, java.lang.String>)

clearRestoreMetadataOverridesEntries

public RestoreTestingSelectionForCreate clearRestoreMetadataOverridesEntries()

Removes all the entries added into RestoreMetadataOverrides.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRestoreTestingSelectionName

public void setRestoreTestingSelectionName(String restoreTestingSelectionName)

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

Parameters:

restoreTestingSelectionName - This is the unique name of the restore testing selection that belongs to the related restore testing plan.

getRestoreTestingSelectionName

public String getRestoreTestingSelectionName()

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

Returns:

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

withRestoreTestingSelectionName

public RestoreTestingSelectionForCreate withRestoreTestingSelectionName(String restoreTestingSelectionName)

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

Parameters:

restoreTestingSelectionName - This is the unique name of the restore testing selection that belongs to the related restore testing plan.

Returns:

Returns a reference to this object so that method calls can be chained together.

setValidationWindowHours

public void setValidationWindowHours(Integer validationWindowHours)

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.

Parameters:

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

getValidationWindowHours

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

Returns:

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.

withValidationWindowHours

public RestoreTestingSelectionForCreate withValidationWindowHours(Integer validationWindowHours)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RestoreTestingSelectionForCreate clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.