Package 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	Description
CrossRegionCopyRule.Builder	cmkArn(String cmkArn)	The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption.
CrossRegionCopyRule.Builder	copyTags(Boolean copyTags)	Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
default CrossRegionCopyRule.Builder	deprecateRule(Consumer<CrossRegionCopyDeprecateRule.Builder> deprecateRule)	[Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
CrossRegionCopyRule.Builder	deprecateRule(CrossRegionCopyDeprecateRule deprecateRule)	[Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
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 that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
CrossRegionCopyRule.Builder	retainRule(CrossRegionCopyRetainRule retainRule)	The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
CrossRegionCopyRule.Builder	target(String target)
CrossRegionCopyRule.Builder	targetRegion(String targetRegion)

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, sdkFields

Method Detail

targetRegion

CrossRegionCopyRule.Builder targetRegion(String targetRegion)

Use this parameter for AMI policies only. For snapshot policies, use Target instead. For snapshot policies created before the Target parameter was introduced, this parameter indicates the target Region for snapshot copies.

[Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.

Parameters:

targetRegion -

Use this parameter for AMI policies only. For snapshot policies, use Target instead. For snapshot policies created before the Target parameter was introduced, this parameter indicates the target Region for snapshot copies.

[Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.

Returns:

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

target

CrossRegionCopyRule.Builder target(String target)

Use this parameter for snapshot policies only. For AMI policies, use TargetRegion instead.

[Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.

Parameters:

target -

Use this parameter for snapshot policies only. For AMI policies, use TargetRegion instead.

[Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.

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 KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.

Parameters:

cmkArn - The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.

Returns:

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

copyTags

CrossRegionCopyRule.Builder copyTags(Boolean copyTags)

Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.

Parameters:

copyTags - Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.

Returns:

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

retainRule

CrossRegionCopyRule.Builder retainRule(CrossRegionCopyRetainRule retainRule)

The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.

Parameters:

retainRule - The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.

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 that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.

This is a convenience method 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)

deprecateRule

CrossRegionCopyRule.Builder deprecateRule(CrossRegionCopyDeprecateRule deprecateRule)

[Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.

Parameters:

deprecateRule - [Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.

Returns:

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

deprecateRule

default CrossRegionCopyRule.Builder deprecateRule(Consumer<CrossRegionCopyDeprecateRule.Builder> deprecateRule)

[Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.

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

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

Parameters:

deprecateRule - a consumer that will call methods on CrossRegionCopyDeprecateRule.Builder

Returns:

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

See Also:

deprecateRule(CrossRegionCopyDeprecateRule)