software.amazon.awssdk.services.fsx.model

Interface CopyBackupRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CopyBackupRequest.Builder,CopyBackupRequest>, FSxRequest.Builder, SdkBuilder<CopyBackupRequest.Builder,CopyBackupRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CopyBackupRequest

public static interface CopyBackupRequest.Builder
extends FSxRequest.Builder, SdkPojo, CopyableBuilder<CopyBackupRequest.Builder,CopyBackupRequest>

Method Summary

Modifier and Type	Method and Description
CopyBackupRequest.Builder	clientRequestToken(String clientRequestToken) Sets the value of the ClientRequestToken property for this object.
CopyBackupRequest.Builder	copyTags(Boolean copyTags) A Boolean flag indicating whether tags from the source backup should be copied to the backup copy.
CopyBackupRequest.Builder	kmsKeyId(String kmsKeyId) Sets the value of the KmsKeyId property for this object.
CopyBackupRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CopyBackupRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CopyBackupRequest.Builder	sourceBackupId(String sourceBackupId) The ID of the source backup.
CopyBackupRequest.Builder	sourceRegion(String sourceRegion) The source Amazon Web Services Region of the backup.
CopyBackupRequest.Builder	tags(Collection<Tag> tags) Sets the value of the Tags property for this object.
CopyBackupRequest.Builder	tags(Consumer<Tag.Builder>... tags) Sets the value of the Tags property for this object.
CopyBackupRequest.Builder	tags(Tag... tags) Sets the value of the Tags property for this object.

Methods inherited from interface software.amazon.awssdk.services.fsx.model.FSxRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

clientRequestToken

CopyBackupRequest.Builder clientRequestToken(String clientRequestToken)

Sets the value of the ClientRequestToken property for this object.

Parameters:

clientRequestToken - The new value for the ClientRequestToken property for this object.

Returns:

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

sourceBackupId

CopyBackupRequest.Builder sourceBackupId(String sourceBackupId)

The ID of the source backup. Specifies the ID of the backup that's being copied.

Parameters:

sourceBackupId - The ID of the source backup. Specifies the ID of the backup that's being copied.

Returns:

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

sourceRegion

CopyBackupRequest.Builder sourceRegion(String sourceRegion)

The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, SourceRegion defaults to the Region where the request is sent from (in-Region copy).

Parameters:

sourceRegion - The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, SourceRegion defaults to the Region where the request is sent from (in-Region copy).

Returns:

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

kmsKeyId

CopyBackupRequest.Builder kmsKeyId(String kmsKeyId)

Sets the value of the KmsKeyId property for this object.

Parameters:

kmsKeyId - The new value for the KmsKeyId property for this object.

Returns:

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

copyTags

CopyBackupRequest.Builder copyTags(Boolean copyTags)

A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.

If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.

Parameters:

copyTags - A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.

If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.

Returns:

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

tags

CopyBackupRequest.Builder tags(Collection<Tag> tags)

Sets the value of the Tags property for this object.

Parameters:

tags - The new value for the Tags property for this object.

Returns:

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

tags

CopyBackupRequest.Builder tags(Tag... tags)

Sets the value of the Tags property for this object.

Parameters:

tags - The new value for the Tags property for this object.

Returns:

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

tags

CopyBackupRequest.Builder tags(Consumer<Tag.Builder>... tags)

Sets the value of the Tags property for this object. This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

overrideConfiguration

CopyBackupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder