Skip to content

Parameters

Source code in docs_src/capo_dlm/types/parameters.py
class Parameters(TypedDict, closed=True):
    exclude_boot_volume: NotRequired[
        "capo_dlm.types.exclude_boot_volume.ExcludeBootVolume"
    ]
    """<p> <b>[Custom snapshot policies that target instances only]</b> Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is <code>false</code>. If you specify <code>true</code>, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.</p>"""
    no_reboot: NotRequired["capo_dlm.types.no_reboot.NoReboot"]
    """<p> <b>[Custom AMI policies only]</b> Indicates whether targeted instances are rebooted when the lifecycle policy runs. <code>true</code> indicates that targeted instances are not rebooted when the policy runs. <code>false</code> indicates that target instances are rebooted when the policy runs. The default is <code>true</code> (instances are not rebooted).</p>"""
    exclude_data_volume_tags: NotRequired[
        "capo_dlm.types.exclude_data_volume_tag_list.ExcludeDataVolumeTagList"
    ]
    """<p> <b>[Custom snapshot policies that target instances only]</b> The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.</p> <p>If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.</p>"""

exclude_boot_volume instance-attribute

exclude_boot_volume: NotRequired[ExcludeBootVolume]

[Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.

exclude_data_volume_tags instance-attribute

exclude_data_volume_tags: NotRequired[ExcludeDataVolumeTagList]

[Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from multi-volume snapshot sets.

If you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy.

no_reboot instance-attribute

no_reboot: NotRequired[NoReboot]

[Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).