/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.backup.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class StartRestoreJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

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

*/ private String recoveryPointArn; /** *

* 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: *

* */ private java.util.Map metadata; /** *

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

*/ private String iamRoleArn; /** *

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

*/ private String idempotencyToken; /** *

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

* */ private String resourceType; /** *

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

*/ private Boolean copySourceTagsToRestoredResource; /** *

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

* * @param 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. */ public void setRecoveryPointArn(String recoveryPointArn) { this.recoveryPointArn = 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. *

* * @return An ARN that uniquely identifies a recovery point; for example, * arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. */ public String getRecoveryPointArn() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public StartRestoreJobRequest withRecoveryPointArn(String recoveryPointArn) { setRecoveryPointArn(recoveryPointArn); return this; } /** *

* 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: *

* * * @return 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: *

*