Class CrossRegionCopyRule

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:
  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CrossRegionCopyRule.Builder,CrossRegionCopyRule>
      Returns:
      a builder for type T
    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.