Skip to content

DiskSnapshot

Source code in docs_src/capo_lightsail/types/disk_snapshot.py
class DiskSnapshot(TypedDict, closed=True):
    name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The name of the disk snapshot (<code>my-disk-snapshot</code>).</p>"""
    arn: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon Resource Name (ARN) of the disk snapshot.</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 date when the disk snapshot was created.</p>"""
    location: NotRequired["capo_lightsail.types.resource_location.ResourceLocation"]
    """<p>The AWS Region and Availability Zone where the disk snapshot was created.</p>"""
    resource_type: NotRequired["capo_lightsail.types.resource_type.ResourceType"]
    """<p>The Lightsail resource type (<code>DiskSnapshot</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>"""
    size_in_gb: NotRequired["capo_lightsail.types.integer.integer"]
    """<p>The size of the disk in GB.</p>"""
    state: NotRequired["capo_lightsail.types.disk_snapshot_state.DiskSnapshotState"]
    """<p>The status of the disk snapshot operation.</p>"""
    progress: NotRequired["capo_lightsail.types.string.string"]
    """<p>The progress of the snapshot.</p>"""
    from_disk_name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The unique name of the source disk from which the disk snapshot was created.</p>"""
    from_disk_arn: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.</p>"""
    from_instance_name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The unique name of the source instance from which the disk (system volume) snapshot was created.</p>"""
    from_instance_arn: NotRequired[
        "capo_lightsail.types.non_empty_string.NonEmptyString"
    ]
    """<p>The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.</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>"""

arn instance-attribute

arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the disk snapshot.

created_at instance-attribute

created_at: NotRequired[IsoDate]

The date when the disk snapshot was created.

from_disk_arn instance-attribute

from_disk_arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.

from_disk_name instance-attribute

from_disk_name: NotRequired[ResourceName]

The unique name of the source disk from which the disk snapshot was created.

from_instance_arn instance-attribute

from_instance_arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.

from_instance_name instance-attribute

from_instance_name: NotRequired[ResourceName]

The unique name of the source instance from which the disk (system volume) 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 AWS Region and Availability Zone where the disk snapshot was created.

name instance-attribute

name: NotRequired[ResourceName]

The name of the disk snapshot (my-disk-snapshot).

progress instance-attribute

progress: NotRequired[string]

The progress of the snapshot.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

The Lightsail resource type (DiskSnapshot).

size_in_gb instance-attribute

size_in_gb: NotRequired[integer]

The size of the disk in GB.

state instance-attribute

state: NotRequired[DiskSnapshotState]

The status of the disk snapshot operation.

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.