Skip to content

CopySnapshotRequest

Source code in docs_src/capo_lightsail/types/copy_snapshot_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class CopySnapshotRequest(TypedDict, closed=True):
    source_snapshot_name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The name of the source manual snapshot to copy.</p> <p>Constraint:</p> <ul> <li> <p>Define this parameter only when copying a manual snapshot as another manual snapshot.</p> </li> </ul>"""
    source_resource_name: NotRequired["capo_lightsail.types.string.string"]
    """<p>The name of the source instance or disk from which the source automatic snapshot was created.</p> <p>Constraint:</p> <ul> <li> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-keeping-automatic-snapshots">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>"""
    restore_date: NotRequired["capo_lightsail.types.string.string"]
    """<p>The date of the source automatic snapshot to copy. Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-keeping-automatic-snapshots">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>"""
    use_latest_restorable_auto_snapshot: NotRequired[
        "capo_lightsail.types.boolean.boolean"
    ]
    """<p>A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-keeping-automatic-snapshots">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>"""
    target_snapshot_name: "capo_lightsail.types.resource_name.ResourceName"
    """<p>The name of the new manual snapshot to be created as a copy.</p>"""
    source_region: "capo_lightsail.types.region_name.RegionName"
    """<p>The Amazon Web Services Region where the source manual or automatic snapshot is located.</p>"""

restore_date instance-attribute 

restore_date: NotRequired[string]

The date of the source automatic snapshot to copy. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

  • Must be specified in YYYY-MM-DD format.

  • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

  • Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.

source_region instance-attribute 

source_region: RegionName

The Amazon Web Services Region where the source manual or automatic snapshot is located.

source_resource_name instance-attribute 

source_resource_name: NotRequired[string]

The name of the source instance or disk from which the source automatic snapshot was created.

Constraint:

source_snapshot_name instance-attribute 

source_snapshot_name: NotRequired[ResourceName]

The name of the source manual snapshot to copy.

Constraint:

  • Define this parameter only when copying a manual snapshot as another manual snapshot.

target_snapshot_name instance-attribute 

target_snapshot_name: ResourceName

The name of the new manual snapshot to be created as a copy.

use_latest_restorable_auto_snapshot instance-attribute 

use_latest_restorable_auto_snapshot: NotRequired[boolean]

A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.

Constraints:

  • This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

  • Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.