Class RestoreTestingSelectionForCreate
- java.lang.Object
-
- software.amazon.awssdk.services.backup.model.RestoreTestingSelectionForCreate
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<RestoreTestingSelectionForCreate.Builder,RestoreTestingSelectionForCreate>
@Generated("software.amazon.awssdk:codegen") public final class RestoreTestingSelectionForCreate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RestoreTestingSelectionForCreate.Builder,RestoreTestingSelectionForCreate>
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
ProtectedResourceArnsalong withProtectedResourceConditions. Alternatively, you can include up to 30 specific protected resource ARNs inProtectedResourceArns.ProtectedResourceConditionsexamples include asStringEqualsandStringNotEquals.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRestoreTestingSelectionForCreate.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RestoreTestingSelectionForCreate.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasProtectedResourceArns()For responses, this returns true if the service returned a value for the ProtectedResourceArns property.booleanhasRestoreMetadataOverrides()For responses, this returns true if the service returned a value for the RestoreMetadataOverrides property.StringiamRoleArn()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>protectedResourceArns()Each protected resource can be filtered by its specific ARNs, such asProtectedResourceArns: ["arn:aws:...", "arn:aws:..."]or by a wildcard:ProtectedResourceArns: ["*"], but not both.ProtectedResourceConditionsprotectedResourceConditions()If you have included the wildcard in ProtectedResourceArns, you can include resource conditions, such asProtectedResourceConditions: { StringEquals: [{ key: "XXXX", value: "YYYY" }].StringprotectedResourceType()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>restoreMetadataOverrides()You can override certain restore metadata keys by including the parameterRestoreMetadataOverridesin the body ofRestoreTestingSelection.StringrestoreTestingSelectionName()This is the unique name of the restore testing selection that belongs to the related restore testing plan.List<SdkField<?>>sdkFields()static Class<? extends RestoreTestingSelectionForCreate.Builder>serializableBuilderClass()RestoreTestingSelectionForCreate.BuildertoBuilder()StringtoString()Returns a string representation of this object.IntegervalidationWindowHours()This is amount of hours (1 to 168) available to run a validation script on the data.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
iamRoleArn
public final 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.- 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.
-
hasProtectedResourceArns
public final boolean hasProtectedResourceArns()
For responses, this returns true if the service returned a value for the ProtectedResourceArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
protectedResourceArns
public final List<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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasProtectedResourceArns()method.- 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.
-
protectedResourceConditions
public final ProtectedResourceConditions protectedResourceConditions()
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" }].
-
protectedResourceType
public final 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:
-
Aurorafor Amazon Aurora -
DocumentDBfor Amazon DocumentDB (with MongoDB compatibility) -
DynamoDBfor Amazon DynamoDB -
EBSfor Amazon Elastic Block Store -
EC2for Amazon Elastic Compute Cloud -
EFSfor Amazon Elastic File System -
FSxfor Amazon FSx -
Neptunefor Amazon Neptune -
RDSfor Amazon Relational Database Service -
S3for 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:
-
Aurorafor Amazon Aurora -
DocumentDBfor Amazon DocumentDB (with MongoDB compatibility) -
DynamoDBfor Amazon DynamoDB -
EBSfor Amazon Elastic Block Store -
EC2for Amazon Elastic Compute Cloud -
EFSfor Amazon Elastic File System -
FSxfor Amazon FSx -
Neptunefor Amazon Neptune -
RDSfor Amazon Relational Database Service -
S3for Amazon S3
-
-
-
hasRestoreMetadataOverrides
public final boolean hasRestoreMetadataOverrides()
For responses, this returns true if the service returned a value for the RestoreMetadataOverrides property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
restoreMetadataOverrides
public final Map<String,String> restoreMetadataOverrides()
You can override certain restore metadata keys by including the parameter
RestoreMetadataOverridesin the body ofRestoreTestingSelection. Key values are not case sensitive.See the complete list of restore testing inferred metadata.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRestoreMetadataOverrides()method.- Returns:
- You can override certain restore metadata keys by including the parameter
RestoreMetadataOverridesin the body ofRestoreTestingSelection. Key values are not case sensitive.See the complete list of restore testing inferred metadata.
-
restoreTestingSelectionName
public final String restoreTestingSelectionName()
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.
-
validationWindowHours
public final 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.
- 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.
-
toBuilder
public RestoreTestingSelectionForCreate.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RestoreTestingSelectionForCreate.Builder,RestoreTestingSelectionForCreate>
-
builder
public static RestoreTestingSelectionForCreate.Builder builder()
-
serializableBuilderClass
public static Class<? extends RestoreTestingSelectionForCreate.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final 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.
-
-