Skip to content

InstanceSnapshot

Source code in docs_src/capo_lightsail/types/instance_snapshot.py
class InstanceSnapshot(TypedDict, closed=True):
    name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The name of the snapshot.</p>"""
    arn: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon Resource Name (ARN) of the snapshot (<code>arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE</code>).</p>"""
    support_code: NotRequired["capo_lightsail.types.string.string"]
    """<p>The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.</p>"""
    created_at: NotRequired["capo_lightsail.types.iso_date.IsoDate"]
    """<p>The timestamp when the snapshot was created (<code>1479907467.024</code>).</p>"""
    location: NotRequired["capo_lightsail.types.resource_location.ResourceLocation"]
    """<p>The region name and Availability Zone where you created the snapshot.</p>"""
    resource_type: NotRequired["capo_lightsail.types.resource_type.ResourceType"]
    """<p>The type of resource (usually <code>InstanceSnapshot</code>).</p>"""
    tags: NotRequired["capo_lightsail.types.tag_list.TagList"]
    """<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>"""
    state: NotRequired[
        "capo_lightsail.types.instance_snapshot_state.InstanceSnapshotState"
    ]
    """<p>The state the snapshot is in.</p>"""
    progress: NotRequired["capo_lightsail.types.string.string"]
    """<p>The progress of the snapshot.</p> <note> <p>This is populated only for disk snapshots, and is <code>null</code> for instance snapshots.</p> </note>"""
    from_attached_disks: NotRequired["capo_lightsail.types.disk_list.DiskList"]
    """<p>An array of disk objects containing information about all block storage disks.</p>"""
    from_instance_name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The instance from which the snapshot was created.</p>"""
    from_instance_arn: NotRequired[
        "capo_lightsail.types.non_empty_string.NonEmptyString"
    ]
    """<p>The Amazon Resource Name (ARN) of the instance from which the snapshot was created (<code>arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE</code>).</p>"""
    from_blueprint_id: NotRequired["capo_lightsail.types.string.string"]
    """<p>The blueprint ID from which you created the snapshot (<code>amazon_linux_2023</code>). A blueprint is a virtual private server (or <i>instance</i>) image used to create instances quickly.</p>"""
    from_bundle_id: NotRequired["capo_lightsail.types.string.string"]
    """<p>The bundle ID from which you created the snapshot (<code>micro_x_x</code>).</p>"""
    is_from_auto_snapshot: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>A Boolean value indicating whether the snapshot was created from an automatic snapshot.</p>"""
    size_in_gb: NotRequired["capo_lightsail.types.integer.integer"]
    """<p>The size in GB of the SSD.</p>"""

arn instance-attribute

arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the snapshot (arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

created_at instance-attribute

created_at: NotRequired[IsoDate]

The timestamp when the snapshot was created (1479907467.024).

from_attached_disks instance-attribute

from_attached_disks: NotRequired[DiskList]

An array of disk objects containing information about all block storage disks.

from_blueprint_id instance-attribute

from_blueprint_id: NotRequired[string]

The blueprint ID from which you created the snapshot (amazon_linux_2023). A blueprint is a virtual private server (or instance) image used to create instances quickly.

from_bundle_id instance-attribute

from_bundle_id: NotRequired[string]

The bundle ID from which you created the snapshot (micro_x_x).

from_instance_arn instance-attribute

from_instance_arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the instance from which the snapshot was created (arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

from_instance_name instance-attribute

from_instance_name: NotRequired[ResourceName]

The instance from which the snapshot was created.

is_from_auto_snapshot instance-attribute

is_from_auto_snapshot: NotRequired[boolean]

A Boolean value indicating whether the snapshot was created from an automatic snapshot.

location instance-attribute

location: NotRequired[ResourceLocation]

The region name and Availability Zone where you created the snapshot.

name instance-attribute

name: NotRequired[ResourceName]

The name of the snapshot.

progress instance-attribute

progress: NotRequired[string]

The progress of the snapshot.

This is populated only for disk snapshots, and is null for instance snapshots.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

The type of resource (usually InstanceSnapshot).

size_in_gb instance-attribute

size_in_gb: NotRequired[integer]

The size in GB of the SSD.

state instance-attribute

state: NotRequired[InstanceSnapshotState]

The state the snapshot is in.

support_code instance-attribute

support_code: NotRequired[string]

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

tags instance-attribute

tags: NotRequired[TagList]

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.