Interface CreateLegalHoldRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateLegalHoldRequest

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

Method Summary

Modifier and Type	Method	Description
CreateLegalHoldRequest.Builder	description(String description)	The description of the legal hold.
CreateLegalHoldRequest.Builder	idempotencyToken(String idempotencyToken)	This is a user-chosen string used to distinguish between otherwise identical calls.
CreateLegalHoldRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateLegalHoldRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateLegalHoldRequest.Builder	recoveryPointSelection(Consumer<RecoveryPointSelection.Builder> recoveryPointSelection)	The criteria to assign a set of resources, such as resource types or backup vaults.
CreateLegalHoldRequest.Builder	recoveryPointSelection(RecoveryPointSelection recoveryPointSelection)	The criteria to assign a set of resources, such as resource types or backup vaults.
CreateLegalHoldRequest.Builder	tags(Map<String,String> tags)	Optional tags to include.
CreateLegalHoldRequest.Builder	title(String title)	The title of the legal hold.

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

title

CreateLegalHoldRequest.Builder title(String title)

The title of the legal hold.

Parameters:

title - The title of the legal hold.

Returns:

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

description

CreateLegalHoldRequest.Builder description(String description)

The description of the legal hold.

Parameters:

description - The description of the legal hold.

Returns:

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

idempotencyToken

CreateLegalHoldRequest.Builder idempotencyToken(String idempotencyToken)

This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Parameters:

idempotencyToken - This is a user-chosen string used to distinguish between otherwise identical calls. 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.

recoveryPointSelection

CreateLegalHoldRequest.Builder recoveryPointSelection(RecoveryPointSelection recoveryPointSelection)

The criteria to assign a set of resources, such as resource types or backup vaults.

Parameters:

recoveryPointSelection - The criteria to assign a set of resources, such as resource types or backup vaults.

Returns:

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

recoveryPointSelection

default CreateLegalHoldRequest.Builder recoveryPointSelection(Consumer<RecoveryPointSelection.Builder> recoveryPointSelection)

The criteria to assign a set of resources, such as resource types or backup vaults.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to recoveryPointSelection(RecoveryPointSelection).

Parameters:

recoveryPointSelection - a consumer that will call methods on RecoveryPointSelection.Builder

Returns:

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

See Also:

• recoveryPointSelection(RecoveryPointSelection)

tags

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

Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

Parameters:

tags - Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

Returns:

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

overrideConfiguration

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

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