CrossRegionCopyRule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.dlm.model.CrossRegionCopyRule

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CrossRegionCopyRule
extends Object
implements Serializable, Cloneable, StructuredPojo

Specifies a rule for cross-Region snapshot copies.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CrossRegionCopyRule()

Constructors
Constructor and Description
`CrossRegionCopyRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CrossRegionCopyRule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCmkArn()` The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption.
`Boolean`	`getCopyTags()` Copy all user-defined tags from the source snapshot to the copied snapshot.
`Boolean`	`getEncrypted()` To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter.
`CrossRegionCopyRetainRule`	`getRetainRule()` The retention rule.
`String`	`getTarget()` The Amazon Resource Name (ARN) of the target AWS Outpost for the snapshot copies.
`String`	`getTargetRegion()` The target Region for the snapshot copies.
`int`	`hashCode()`
`Boolean`	`isCopyTags()` Copy all user-defined tags from the source snapshot to the copied snapshot.
`Boolean`	`isEncrypted()` To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCmkArn(String cmkArn)` The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption.
`void`	`setCopyTags(Boolean copyTags)` Copy all user-defined tags from the source snapshot to the copied snapshot.
`void`	`setEncrypted(Boolean encrypted)` To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter.
`void`	`setRetainRule(CrossRegionCopyRetainRule retainRule)` The retention rule.
`void`	`setTarget(String target)` The Amazon Resource Name (ARN) of the target AWS Outpost for the snapshot copies.
`void`	`setTargetRegion(String targetRegion)` The target Region for the snapshot copies.
`String`	`toString()` Returns a string representation of this object.
`CrossRegionCopyRule`	`withCmkArn(String cmkArn)` The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption.
`CrossRegionCopyRule`	`withCopyTags(Boolean copyTags)` Copy all user-defined tags from the source snapshot to the copied snapshot.
`CrossRegionCopyRule`	`withEncrypted(Boolean encrypted)` To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter.
`CrossRegionCopyRule`	`withRetainRule(CrossRegionCopyRetainRule retainRule)` The retention rule.
`CrossRegionCopyRule`	`withTarget(String target)` The Amazon Resource Name (ARN) of the target AWS Outpost for the snapshot copies.
`CrossRegionCopyRule`	`withTargetRegion(String targetRegion)` The target Region for the snapshot copies.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CrossRegionCopyRule
```
public CrossRegionCopyRule()
```
- Method Detail
  - setTargetRegion
```
public void setTargetRegion(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.
  - getTargetRegion
```
public String getTargetRegion()
```
    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.
  - withTargetRegion
```
public CrossRegionCopyRule withTargetRegion(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.
  - setTarget
```
public void setTarget(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.
  - getTarget
```
public String getTarget()
```
    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.
  - withTarget
```
public CrossRegionCopyRule withTarget(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.
  - setEncrypted
```
public void setEncrypted(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.
  - getEncrypted
```
public Boolean getEncrypted()
```
    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.
  - withEncrypted
```
public CrossRegionCopyRule withEncrypted(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.
  - isEncrypted
```
public Boolean isEncrypted()
```
    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.
  - setCmkArn
```
public void setCmkArn(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.
  - getCmkArn
```
public String getCmkArn()
```
    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.
  - withCmkArn
```
public CrossRegionCopyRule withCmkArn(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.
  - setCopyTags
```
public void setCopyTags(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.
  - getCopyTags
```
public Boolean getCopyTags()
```
    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.
  - withCopyTags
```
public CrossRegionCopyRule withCopyTags(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.
  - isCopyTags
```
public Boolean isCopyTags()
```
    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.
  - setRetainRule
```
public void setRetainRule(CrossRegionCopyRetainRule retainRule)
```
    The retention rule.
    
    Parameters:
    
    retainRule - The retention rule.
  - getRetainRule
```
public CrossRegionCopyRetainRule getRetainRule()
```
    The retention rule.
    
    Returns:
    
    The retention rule.
  - withRetainRule
```
public CrossRegionCopyRule withRetainRule(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CrossRegionCopyRule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CrossRegionCopyRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CrossRegionCopyRule

Method Detail

setTargetRegion

getTargetRegion

withTargetRegion

setTarget

getTarget

withTarget

setEncrypted

getEncrypted

withEncrypted

isEncrypted

setCmkArn

getCmkArn

withCmkArn

setCopyTags

getCopyTags

withCopyTags

isCopyTags

setRetainRule

getRetainRule

withRetainRule

toString

equals

hashCode

clone

marshall