software.amazon.awssdk.services.dlm.model

Interface CrossRegionCopyRule.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CrossRegionCopyRule.Builder,CrossRegionCopyRule>, SdkBuilder<CrossRegionCopyRule.Builder,CrossRegionCopyRule>, SdkPojo

Enclosing class:

CrossRegionCopyRule

public static interface CrossRegionCopyRule.Builder
extends SdkPojo, CopyableBuilder<CrossRegionCopyRule.Builder,CrossRegionCopyRule>

Method Summary

Modifier and Type	Method and Description
CrossRegionCopyRule.Builder	cmkArn(String cmkArn) The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption.
CrossRegionCopyRule.Builder	copyTags(Boolean copyTags) Copy all user-defined tags from the source snapshot to the copied snapshot.
CrossRegionCopyRule.Builder	encrypted(Boolean encrypted) To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter.
default CrossRegionCopyRule.Builder	retainRule(Consumer<CrossRegionCopyRetainRule.Builder> retainRule) The retention rule.
CrossRegionCopyRule.Builder	retainRule(CrossRegionCopyRetainRule retainRule) The retention rule.
CrossRegionCopyRule.Builder	target(String target) The Amazon Resource Name (ARN) of the target AWS Outpost for the snapshot copies.
CrossRegionCopyRule.Builder	targetRegion(String targetRegion) The target Region for the snapshot copies.

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

targetRegion

CrossRegionCopyRule.Builder targetRegion(String targetRegion)

The target Region for the snapshot copies.

If you specify a target Region, you must omit Target. You cannot specify a target Region and a target Outpost in the same rule.

Parameters:

targetRegion - The target Region for the snapshot copies.

If you specify a target Region, you must omit Target. You cannot specify a target Region and a target Outpost in the same rule.

Returns:

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

target

CrossRegionCopyRule.Builder target(String target)

The Amazon Resource Name (ARN) of the target AWS Outpost for the snapshot copies.

If you specify an ARN, you must omit TargetRegion. You cannot specify a target Region and a target Outpost in the same rule.

Parameters:

target - The Amazon Resource Name (ARN) of the target AWS Outpost for the snapshot copies.

If you specify an ARN, you must omit TargetRegion. You cannot specify a target Region and a target Outpost in the same rule.

Returns:

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

encrypted

CrossRegionCopyRule.Builder encrypted(Boolean encrypted)

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.

Parameters:

encrypted - To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.

Returns:

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

cmkArn

CrossRegionCopyRule.Builder cmkArn(String cmkArn)

The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used.

Parameters:

cmkArn - The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used.

Returns:

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

copyTags

CrossRegionCopyRule.Builder copyTags(Boolean copyTags)

Copy all user-defined tags from the source snapshot to the copied snapshot.

Parameters:

copyTags - Copy all user-defined tags from the source snapshot to the copied snapshot.

Returns:

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

retainRule

CrossRegionCopyRule.Builder retainRule(CrossRegionCopyRetainRule retainRule)

The retention rule.

Parameters:

retainRule - The retention rule.

Returns:

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

retainRule

default CrossRegionCopyRule.Builder retainRule(Consumer<CrossRegionCopyRetainRule.Builder> retainRule)

The retention rule.

This is a convenience that creates an instance of the CrossRegionCopyRetainRule.Builder avoiding the need to create one manually via CrossRegionCopyRetainRule.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retainRule(CrossRegionCopyRetainRule).

Parameters:

retainRule - a consumer that will call methods on CrossRegionCopyRetainRule.Builder

Returns:

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

See Also:

retainRule(CrossRegionCopyRetainRule)