Skip to content

CrossRegionCopyRule

Source code in docs_src/capo_dlm/types/cross_region_copy_rule.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class CrossRegionCopyRule(TypedDict, closed=True):
    target_region: NotRequired["capo_dlm.types.target_region.TargetRegion"]
    """<note> <p>Use this parameter for AMI policies only. For snapshot policies, use <b>Target</b> instead. For snapshot policies created before the <b>Target</b> parameter was introduced, this parameter indicates the target Region for snapshot copies.</p> <p></p> </note> <p> <b>[Custom AMI policies only]</b> The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.</p>"""
    target: NotRequired["capo_dlm.types.target.Target"]
    """<note> <p>Use this parameter for snapshot policies only. For AMI policies, use <b>TargetRegion</b> instead.</p> </note> <p> <b>[Custom snapshot policies only]</b> The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.</p>"""
    encrypted: NotRequired["capo_dlm.types.encrypted.Encrypted"]
    """<p>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.</p>"""
    cmk_arn: NotRequired["capo_dlm.types.cmk_arn.CmkArn"]
    """<p>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.</p>"""
    copy_tags: NotRequired["capo_dlm.types.copy_tags_nullable.CopyTagsNullable"]
    """<p>Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.</p>"""
    retain_rule: NotRequired[
        "capo_dlm.types.cross_region_copy_retain_rule.CrossRegionCopyRetainRule"
    ]
    """<p>The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.</p>"""
    deprecate_rule: NotRequired[
        "capo_dlm.types.cross_region_copy_deprecate_rule.CrossRegionCopyDeprecateRule"
    ]
    """<p> <b>[Custom AMI policies only]</b> The AMI deprecation rule for cross-Region AMI copies created by the rule.</p>"""

cmk_arn instance-attribute 

cmk_arn: NotRequired[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.

copy_tags instance-attribute 

copy_tags: NotRequired[CopyTagsNullable]

Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.

deprecate_rule instance-attribute 

deprecate_rule: NotRequired[CrossRegionCopyDeprecateRule]

[Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.

encrypted instance-attribute 

encrypted: NotRequired[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.

retain_rule instance-attribute 

retain_rule: NotRequired[CrossRegionCopyRetainRule]

The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.

target instance-attribute 

target: NotRequired[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.

target_region instance-attribute 

target_region: NotRequired[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.