Disk ¶

class Disk(TypedDict, closed=True):
    name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The unique name of the disk.</p>"""
    arn: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon Resource Name (ARN) of the disk.</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 was created.</p>"""
    location: NotRequired["capo_lightsail.types.resource_location.ResourceLocation"]
    """<p>The AWS Region and Availability Zone where the disk is located.</p>"""
    resource_type: NotRequired["capo_lightsail.types.resource_type.ResourceType"]
    """<p>The Lightsail resource type (<code>Disk</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>"""
    add_ons: NotRequired["capo_lightsail.types.add_on_list.AddOnList"]
    """<p>An array of objects representing the add-ons enabled on the disk.</p>"""
    size_in_gb: NotRequired["capo_lightsail.types.integer.integer"]
    """<p>The size of the disk in GB.</p>"""
    is_system_disk: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).</p>"""
    iops: NotRequired["capo_lightsail.types.integer.integer"]
    """<p>The input/output operations per second (IOPS) of the disk.</p>"""
    path: NotRequired["capo_lightsail.types.string.string"]
    """<p>The disk path.</p>"""
    state: NotRequired["capo_lightsail.types.disk_state.DiskState"]
    """<p>Describes the status of the disk.</p>"""
    attached_to: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The resources to which the disk is attached.</p>"""
    is_attached: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>A Boolean value indicating whether the disk is attached.</p>"""
    attachment_state: NotRequired["capo_lightsail.types.string.string"]
    """<p>(Discontinued) The attachment state of the disk.</p> <note> <p>In releases prior to November 14, 2017, this parameter returned <code>attached</code> for system disks in the API response. It is now discontinued, but still included in the response. Use <code>isAttached</code> instead.</p> </note>"""
    gb_in_use: NotRequired["capo_lightsail.types.integer.integer"]
    """<p>(Discontinued) The number of GB in use by the disk.</p> <note> <p>In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.</p> </note>"""
    auto_mount_status: NotRequired[
        "capo_lightsail.types.auto_mount_status.AutoMountStatus"
    ]
    """<p>The status of automatically mounting a storage disk to a virtual computer.</p> <important> <p>This parameter only applies to Lightsail for Research resources.</p> </important>"""