software.amazon.awssdk.services.backup.model

Class StartRestoreJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.backup.model.BackupRequest

software.amazon.awssdk.services.backup.model.StartRestoreJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartRestoreJobRequest.Builder,StartRestoreJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartRestoreJobRequest
extends BackupRequest
implements ToCopyableBuilder<StartRestoreJobRequest.Builder,StartRestoreJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartRestoreJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartRestoreJobRequest.Builder	builder()
Boolean	copySourceTagsToRestoredResource() This is an optional parameter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetadata() For responses, this returns true if the service returned a value for the Metadata property.
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.
String	idempotencyToken() A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob.
Map<String,String>	metadata() A set of metadata key-value pairs.
String	recoveryPointArn() An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
String	resourceType() Starts a job to restore a recovery point for one of the following resources:
List<SdkField<?>>	sdkFields()
static Class<? extends StartRestoreJobRequest.Builder>	serializableBuilderClass()
StartRestoreJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

recoveryPointArn

public final String recoveryPointArn()

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Returns:

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

hasMetadata

public final boolean hasMetadata()

For responses, this returns true if the service returned a value for the Metadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

metadata

public final Map<String,String> metadata()

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

• file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in GetRecoveryPointRestoreMetadata.

• Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

• KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.

• PerformanceMode: Specifies the throughput mode of the file system.

• CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

• newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

• ItemsToRestore: An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]".

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 hasMetadata() method.

Returns:

A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

• file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in GetRecoveryPointRestoreMetadata.

• Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

• KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.

• PerformanceMode: Specifies the throughput mode of the file system.

• CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

• newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

• ItemsToRestore: An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]".

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.

idempotencyToken

public final String idempotencyToken()

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Returns:

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

resourceType

public final String resourceType()

Starts a job to restore a recovery point for one of the following resources:

• Aurora for Amazon Aurora

• DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

• CloudFormation for CloudFormation

• 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

• Redshift for Amazon Redshift

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• Timestream for Amazon Timestream

• VirtualMachine for virtual machines

Returns:

Starts a job to restore a recovery point for one of the following resources:

• Aurora for Amazon Aurora

• DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

• CloudFormation for CloudFormation

• 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

• Redshift for Amazon Redshift

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• Timestream for Amazon Timestream

• VirtualMachine for virtual machines

copySourceTagsToRestoredResource

public final Boolean copySourceTagsToRestoredResource()

This is an optional parameter. If this equals True, tags included in the backup will be copied to the restored resource.

This can only be applied to backups created through Backup.

Returns:

This is an optional parameter. If this equals True, tags included in the backup will be copied to the restored resource.

This can only be applied to backups created through Backup.

toBuilder

public StartRestoreJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartRestoreJobRequest.Builder,StartRestoreJobRequest>

Specified by:

toBuilder in class BackupRequest

builder

public static StartRestoreJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartRestoreJobRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo