java.lang.Object
- software.amazon.awssdk.services.dlm.model.CrossRegionCopyRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CrossRegionCopyRule.Builder,CrossRegionCopyRule>
```
@Generated("software.amazon.awssdk:codegen")
public final class CrossRegionCopyRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CrossRegionCopyRule.Builder,CrossRegionCopyRule>
```
[Custom snapshot and AMI policies only] Specifies a cross-Region copy rule for a snapshot and AMI policies.

To specify a cross-Region copy action for event-based polices, use CrossRegionCopyAction.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CrossRegionCopyRule.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CrossRegionCopyRule.Builder`	`builder()`
`String`	`cmkArn()`	The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption.
`Boolean`	`copyTags()`	Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
`CrossRegionCopyDeprecateRule`	`deprecateRule()`	[Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
`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 that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CrossRegionCopyRule.Builder>`	`serializableBuilderClass()`
`String`	`target()`
`String`	`targetRegion()`
`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()
```
    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:
    
    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.
  - target
```
public final 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.
    
    Returns:
    
    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.
  - 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 KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.
    
    Returns:
    
    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.
  - copyTags
```
public final Boolean copyTags()
```
    Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
    
    Returns:
    
    Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
  - retainRule
```
public final CrossRegionCopyRetainRule retainRule()
```
    The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
    
    Returns:
    
    The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
  - deprecateRule
```
public final CrossRegionCopyDeprecateRule deprecateRule()
```
    [Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
    
    Returns:
    
    [Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CrossRegionCopyRule

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

targetRegion

target

encrypted

cmkArn

copyTags

retainRule

deprecateRule

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField