Skip to content

Instance

Source code in docs_src/capo_lightsail/types/instance.py
class Instance(TypedDict, closed=True):
    name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The name the user gave the instance (<code>Amazon_Linux_2023-1</code>).</p>"""
    arn: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon Resource Name (ARN) of the instance (<code>arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-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 instance was created (<code>1479734909.17</code>) in Unix time format.</p>"""
    location: NotRequired["capo_lightsail.types.resource_location.ResourceLocation"]
    """<p>The region name and Availability Zone where the instance is located.</p>"""
    resource_type: NotRequired["capo_lightsail.types.resource_type.ResourceType"]
    """<p>The type of resource (usually <code>Instance</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>"""
    blueprint_id: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The blueprint ID (<code>amazon_linux_2023</code>).</p>"""
    blueprint_name: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The friendly name of the blueprint (<code>Amazon Linux 2023</code>).</p>"""
    bundle_id: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The bundle for the instance (<code>micro_x_x</code>).</p>"""
    add_ons: NotRequired["capo_lightsail.types.add_on_list.AddOnList"]
    """<p>An array of objects representing the add-ons enabled on the instance.</p>"""
    is_static_ip: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>A Boolean value indicating whether this instance has a static IP assigned to it.</p>"""
    private_ip_address: NotRequired["capo_lightsail.types.ip_address.IpAddress"]
    """<p>The private IP address of the instance.</p>"""
    public_ip_address: NotRequired["capo_lightsail.types.ip_address.IpAddress"]
    """<p>The public IP address of the instance.</p>"""
    ipv6_addresses: NotRequired[
        "capo_lightsail.types.ipv6_address_list.Ipv6AddressList"
    ]
    """<p>The IPv6 addresses of the instance.</p>"""
    ip_address_type: NotRequired["capo_lightsail.types.ip_address_type.IpAddressType"]
    """<p>The IP address type of the instance.</p> <p>The possible values are <code>ipv4</code> for IPv4 only, <code>ipv6</code> for IPv6 only, and <code>dualstack</code> for IPv4 and IPv6.</p>"""
    hardware: NotRequired["capo_lightsail.types.instance_hardware.InstanceHardware"]
    """<p>The size of the vCPU and the amount of RAM for the instance.</p>"""
    networking: NotRequired[
        "capo_lightsail.types.instance_networking.InstanceNetworking"
    ]
    """<p>Information about the public ports and monthly data transfer rates for the instance.</p>"""
    state: NotRequired["capo_lightsail.types.instance_state.InstanceState"]
    """<p>The status code and the state (<code>running</code>) for the instance.</p>"""
    username: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The user name for connecting to the instance (<code>ec2-user</code>).</p>"""
    ssh_key_name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The name of the SSH key being used to connect to the instance (<code>LightsailDefaultKeyPair</code>).</p>"""
    metadata_options: NotRequired[
        "capo_lightsail.types.instance_metadata_options.InstanceMetadataOptions"
    ]
    """<p>The metadata options for the Amazon Lightsail instance.</p>"""

add_ons instance-attribute

add_ons: NotRequired[AddOnList]

An array of objects representing the add-ons enabled on the instance.

arn instance-attribute

arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the instance (arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

blueprint_id instance-attribute

blueprint_id: NotRequired[NonEmptyString]

The blueprint ID (amazon_linux_2023).

blueprint_name instance-attribute

blueprint_name: NotRequired[NonEmptyString]

The friendly name of the blueprint (Amazon Linux 2023).

bundle_id instance-attribute

bundle_id: NotRequired[NonEmptyString]

The bundle for the instance (micro_x_x).

created_at instance-attribute

created_at: NotRequired[IsoDate]

The timestamp when the instance was created (1479734909.17) in Unix time format.

hardware instance-attribute

hardware: NotRequired[InstanceHardware]

The size of the vCPU and the amount of RAM for the instance.

ip_address_type instance-attribute

ip_address_type: NotRequired[IpAddressType]

The IP address type of the instance.

The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.

ipv6_addresses instance-attribute

ipv6_addresses: NotRequired[Ipv6AddressList]

The IPv6 addresses of the instance.

is_static_ip instance-attribute

is_static_ip: NotRequired[boolean]

A Boolean value indicating whether this instance has a static IP assigned to it.

location instance-attribute

location: NotRequired[ResourceLocation]

The region name and Availability Zone where the instance is located.

metadata_options instance-attribute

metadata_options: NotRequired[InstanceMetadataOptions]

The metadata options for the Amazon Lightsail instance.

name instance-attribute

name: NotRequired[ResourceName]

The name the user gave the instance (Amazon_Linux_2023-1).

networking instance-attribute

networking: NotRequired[InstanceNetworking]

Information about the public ports and monthly data transfer rates for the instance.

private_ip_address instance-attribute

private_ip_address: NotRequired[IpAddress]

The private IP address of the instance.

public_ip_address instance-attribute

public_ip_address: NotRequired[IpAddress]

The public IP address of the instance.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

The type of resource (usually Instance).

ssh_key_name instance-attribute

ssh_key_name: NotRequired[ResourceName]

The name of the SSH key being used to connect to the instance (LightsailDefaultKeyPair).

state instance-attribute

state: NotRequired[InstanceState]

The status code and the state (running) for the instance.

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.

username instance-attribute

username: NotRequired[NonEmptyString]

The user name for connecting to the instance (ec2-user).