software.amazon.awssdk.services.dlm.model

Class CrossRegionCopyRule

java.lang.Object

software.amazon.awssdk.services.dlm.model.CrossRegionCopyRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CrossRegionCopyRule.Builder,CrossRegionCopyRule>

@Generated(value="software.amazon.awssdk:codegen")
public final class CrossRegionCopyRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CrossRegionCopyRule.Builder,CrossRegionCopyRule>

Specifies a rule for cross-Region snapshot copies.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CrossRegionCopyRule.Builder

Method Summary

Modifier and Type	Method and Description
static CrossRegionCopyRule.Builder	builder()
String	cmkArn() The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption.
Boolean	copyTags() Copy all user-defined tags from the source snapshot to the copied snapshot.
Boolean	encrypted() To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
CrossRegionCopyRetainRule	retainRule() The retention rule.
List<SdkField<?>>	sdkFields()
static Class<? extends CrossRegionCopyRule.Builder>	serializableBuilderClass()
String	target() The Amazon Resource Name (ARN) of the target AWS Outpost for the snapshot copies.
String	targetRegion() The target Region for the snapshot copies.
CrossRegionCopyRule.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

targetRegion

public final 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.

Returns:

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.

target

public final 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.

Returns:

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.

encrypted

public final 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.

Returns:

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.

cmkArn

public final 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.

Returns:

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.

copyTags

public final Boolean copyTags()

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

Returns:

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

retainRule

public final CrossRegionCopyRetainRule retainRule()

The retention rule.

Returns:

The retention rule.

toBuilder

public CrossRegionCopyRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CrossRegionCopyRule.Builder,CrossRegionCopyRule>

builder

public static CrossRegionCopyRule.Builder builder()

serializableBuilderClass

public static Class<? extends CrossRegionCopyRule.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo