Class CrossRegionCopyRule
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CrossRegionCopyRule.Builder
builder()
final String
cmkArn()
The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption.final Boolean
copyTags()
Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.[Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.final Boolean
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.static Class
<? extends CrossRegionCopyRule.Builder> final String
target()
final String
Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
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
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
[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
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 interfaceToCopyableBuilder<CrossRegionCopyRule.Builder,
CrossRegionCopyRule> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-