Interface StartRestoreJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BackupRequest.Builder, Buildable, CopyableBuilder<StartRestoreJobRequest.Builder,StartRestoreJobRequest>, SdkBuilder<StartRestoreJobRequest.Builder,StartRestoreJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartRestoreJobRequest

@Mutable
@NotThreadSafe
public static interface StartRestoreJobRequest.Builder
extends BackupRequest.Builder, SdkPojo, CopyableBuilder<StartRestoreJobRequest.Builder,StartRestoreJobRequest>

Method Summary

Modifier and Type	Method	Description
StartRestoreJobRequest.Builder	copySourceTagsToRestoredResource(Boolean copySourceTagsToRestoredResource)	This is an optional parameter.
StartRestoreJobRequest.Builder	iamRoleArn(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.
StartRestoreJobRequest.Builder	idempotencyToken(String idempotencyToken)	A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob.
StartRestoreJobRequest.Builder	metadata(Map<String,String> metadata)	A set of metadata key-value pairs.
StartRestoreJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartRestoreJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
StartRestoreJobRequest.Builder	recoveryPointArn(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.
StartRestoreJobRequest.Builder	resourceType(String resourceType)	Starts a job to restore a recovery point for one of the following resources:

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.backup.model.BackupRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

recoveryPointArn

StartRestoreJobRequest.Builder recoveryPointArn(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.

Parameters:

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:

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

metadata

StartRestoreJobRequest.Builder metadata(Map<String,String> metadata)

A set of metadata key-value pairs.

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.

For more information about the metadata for each resource, see the following:

• Metadata for Amazon Aurora

• Metadata for Amazon DocumentDB

• Metadata for CloudFormation

• Metadata for Amazon DynamoDB

• Metadata for Amazon EBS

• Metadata for Amazon EC2

• Metadata for Amazon EFS

• Metadata for Amazon FSx

• Metadata for Amazon Neptune

• Metadata for Amazon RDS

• Metadata for Amazon Redshift

• Metadata for Storage Gateway

• Metadata for Amazon S3

• Metadata for Amazon Timestream

• Metadata for virtual machines

Parameters:

metadata - A set of metadata key-value pairs.

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.

For more information about the metadata for each resource, see the following:

• Metadata for Amazon Aurora

• Metadata for Amazon DocumentDB

• Metadata for CloudFormation

• Metadata for Amazon DynamoDB

• Metadata for Amazon EBS

• Metadata for Amazon EC2

• Metadata for Amazon EFS

• Metadata for Amazon FSx

• Metadata for Amazon Neptune

• Metadata for Amazon RDS

• Metadata for Amazon Redshift

• Metadata for Storage Gateway

• Metadata for Amazon S3

• Metadata for Amazon Timestream

• Metadata for virtual machines

Returns:

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

iamRoleArn

StartRestoreJobRequest.Builder iamRoleArn(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.

idempotencyToken

StartRestoreJobRequest.Builder idempotencyToken(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.

Parameters:

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:

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

resourceType

StartRestoreJobRequest.Builder resourceType(String resourceType)

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

• Aurora - Amazon Aurora

• DocumentDB - Amazon DocumentDB

• CloudFormation - CloudFormation

• DynamoDB - Amazon DynamoDB

• EBS - Amazon Elastic Block Store

• EC2 - Amazon Elastic Compute Cloud

• EFS - Amazon Elastic File System

• FSx - Amazon FSx

• Neptune - Amazon Neptune

• RDS - Amazon Relational Database Service

• Redshift - Amazon Redshift

• Storage Gateway - Storage Gateway

• S3 - Amazon Simple Storage Service

• Timestream - Amazon Timestream

• VirtualMachine - Virtual machines

Parameters:

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

• Aurora - Amazon Aurora

• DocumentDB - Amazon DocumentDB

• CloudFormation - CloudFormation

• DynamoDB - Amazon DynamoDB

• EBS - Amazon Elastic Block Store

• EC2 - Amazon Elastic Compute Cloud

• EFS - Amazon Elastic File System

• FSx - Amazon FSx

• Neptune - Amazon Neptune

• RDS - Amazon Relational Database Service

• Redshift - Amazon Redshift

• Storage Gateway - Storage Gateway

• S3 - Amazon Simple Storage Service

• Timestream - Amazon Timestream

• VirtualMachine - Virtual machines

Returns:

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

copySourceTagsToRestoredResource

StartRestoreJobRequest.Builder copySourceTagsToRestoredResource(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.

Parameters:

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:

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

overrideConfiguration

StartRestoreJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

StartRestoreJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.