Interface StartRecoveryPlanExecutionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartRecoveryPlanExecutionRequest.Builder,StartRecoveryPlanExecutionRequest>, DrsRequest.Builder, SdkBuilder<StartRecoveryPlanExecutionRequest.Builder,StartRecoveryPlanExecutionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartRecoveryPlanExecutionRequest

@Mutable
@NotThreadSafe
public static interface StartRecoveryPlanExecutionRequest.Builder
extends DrsRequest.Builder, SdkPojo, CopyableBuilder<StartRecoveryPlanExecutionRequest.Builder,StartRecoveryPlanExecutionRequest>

Method Summary

Modifier and Type	Method	Description
StartRecoveryPlanExecutionRequest.Builder	clientToken(String clientToken)	A unique string provided to ensure request idempotency.
StartRecoveryPlanExecutionRequest.Builder	mode(String mode)	The execution mode (DRILL or RECOVERY).
StartRecoveryPlanExecutionRequest.Builder	mode(RecoveryPlanExecutionMode mode)	The execution mode (DRILL or RECOVERY).
StartRecoveryPlanExecutionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartRecoveryPlanExecutionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
StartRecoveryPlanExecutionRequest.Builder	recoveryPlanArn(String recoveryPlanArn)	The ARN of the Recovery Plan to execute.
StartRecoveryPlanExecutionRequest.Builder	sourceServers(Collection<RecoveryPlanExecutionSourceServer> sourceServers)	Optional list of source servers with specific recovery snapshots.
StartRecoveryPlanExecutionRequest.Builder	sourceServers(Consumer<RecoveryPlanExecutionSourceServer.Builder>... sourceServers)	Optional list of source servers with specific recovery snapshots.
StartRecoveryPlanExecutionRequest.Builder	sourceServers(RecoveryPlanExecutionSourceServer... sourceServers)	Optional list of source servers with specific recovery snapshots.
StartRecoveryPlanExecutionRequest.Builder	tags(Map<String,String> tags)	The tags to apply to the Recovery Plan execution.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.drs.model.DrsRequest.Builder

build

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

recoveryPlanArn

StartRecoveryPlanExecutionRequest.Builder recoveryPlanArn(String recoveryPlanArn)

The ARN of the Recovery Plan to execute.

Parameters:

recoveryPlanArn - The ARN of the Recovery Plan to execute.

Returns:

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

mode

StartRecoveryPlanExecutionRequest.Builder mode(String mode)

The execution mode (DRILL or RECOVERY).

Parameters:

mode - The execution mode (DRILL or RECOVERY).

Returns:

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

See Also:

• RecoveryPlanExecutionMode
• RecoveryPlanExecutionMode

mode

StartRecoveryPlanExecutionRequest.Builder mode(RecoveryPlanExecutionMode mode)

The execution mode (DRILL or RECOVERY).

Parameters:

mode - The execution mode (DRILL or RECOVERY).

Returns:

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

See Also:

• RecoveryPlanExecutionMode
• RecoveryPlanExecutionMode

clientToken

StartRecoveryPlanExecutionRequest.Builder clientToken(String clientToken)

A unique string provided to ensure request idempotency.

Parameters:

clientToken - A unique string provided to ensure request idempotency.

Returns:

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

sourceServers

StartRecoveryPlanExecutionRequest.Builder sourceServers(Collection<RecoveryPlanExecutionSourceServer> sourceServers)

Optional list of source servers with specific recovery snapshots. If not provided, the latest snapshot is used for each server.

Parameters:

sourceServers - Optional list of source servers with specific recovery snapshots. If not provided, the latest snapshot is used for each server.

Returns:

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

sourceServers

StartRecoveryPlanExecutionRequest.Builder sourceServers(RecoveryPlanExecutionSourceServer... sourceServers)

Optional list of source servers with specific recovery snapshots. If not provided, the latest snapshot is used for each server.

Parameters:

sourceServers - Optional list of source servers with specific recovery snapshots. If not provided, the latest snapshot is used for each server.

Returns:

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

sourceServers

StartRecoveryPlanExecutionRequest.Builder sourceServers(Consumer<RecoveryPlanExecutionSourceServer.Builder>... sourceServers)

Optional list of source servers with specific recovery snapshots. If not provided, the latest snapshot is used for each server.

This is a convenience method that creates an instance of the RecoveryPlanExecutionSourceServer.Builder avoiding the need to create one manually via RecoveryPlanExecutionSourceServer.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceServers(List<RecoveryPlanExecutionSourceServer>).

Parameters:

sourceServers - a consumer that will call methods on RecoveryPlanExecutionSourceServer.Builder

Returns:

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

See Also:

• sourceServers(java.util.Collection<RecoveryPlanExecutionSourceServer>)

tags

StartRecoveryPlanExecutionRequest.Builder tags(Map<String,String> tags)

The tags to apply to the Recovery Plan execution.

Parameters:

tags - The tags to apply to the Recovery Plan execution.

Returns:

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

overrideConfiguration

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

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