---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# aws_lightsail_instance{% #aws_lightsail_instance %}

## `account_id`{% #account_id %}

**Type**: `STRING`

## `add_ons`{% #add_ons %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `addOns`**Description**: An array of objects representing the add-ons enabled on the instance.

- `duration`**Type**: `STRING`**Provider name**: `duration`**Description**: The amount of idle time in minutes after which your virtual computer will automatically stop.This add-on only applies to Lightsail for Research resources.
- `name`**Type**: `STRING`**Provider name**: `name`**Description**: The name of the add-on.
- `next_snapshot_time_of_day`**Type**: `STRING`**Provider name**: `nextSnapshotTimeOfDay`**Description**: The next daily time an automatic snapshot will be created. The time shown is in `HH:00` format, and in Coordinated Universal Time (UTC). The snapshot is automatically created between the time shown and up to 45 minutes after.
- `snapshot_time_of_day`**Type**: `STRING`**Provider name**: `snapshotTimeOfDay`**Description**: The daily time when an automatic snapshot is created. The time shown is in `HH:00` format, and in Coordinated Universal Time (UTC). The snapshot is automatically created between the time shown and up to 45 minutes after.
- `status`**Type**: `STRING`**Provider name**: `status`**Description**: The status of the add-on.
- `threshold`**Type**: `STRING`**Provider name**: `threshold`**Description**: The trigger threshold of the action.This add-on only applies to Lightsail for Research resources.

## `arn`{% #arn %}

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

## `blueprint_id`{% #blueprint_id %}

**Type**: `STRING`**Provider name**: `blueprintId`**Description**: The blueprint ID (`amazon_linux_2023`).

## `blueprint_name`{% #blueprint_name %}

**Type**: `STRING`**Provider name**: `blueprintName`**Description**: The friendly name of the blueprint (`Amazon Linux 2023`).

## `bundle_id`{% #bundle_id %}

**Type**: `STRING`**Provider name**: `bundleId`**Description**: The bundle for the instance (`micro_x_x`).

## `created_at`{% #created_at %}

**Type**: `TIMESTAMP`**Provider name**: `createdAt`**Description**: The timestamp when the instance was created (`1479734909.17`) in Unix time format.

## `hardware`{% #hardware %}

**Type**: `STRUCT`**Provider name**: `hardware`**Description**: The size of the vCPU and the amount of RAM for the instance.

- `cpu_count`**Type**: `INT32`**Provider name**: `cpuCount`**Description**: The number of vCPUs the instance has.
- `disks`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `disks`**Description**: The disks attached to the instance.
  - `add_ons`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `addOns`**Description**: An array of objects representing the add-ons enabled on the disk.
    - `duration`**Type**: `STRING`**Provider name**: `duration`**Description**: The amount of idle time in minutes after which your virtual computer will automatically stop.This add-on only applies to Lightsail for Research resources.
    - `name`**Type**: `STRING`**Provider name**: `name`**Description**: The name of the add-on.
    - `next_snapshot_time_of_day`**Type**: `STRING`**Provider name**: `nextSnapshotTimeOfDay`**Description**: The next daily time an automatic snapshot will be created. The time shown is in `HH:00` format, and in Coordinated Universal Time (UTC). The snapshot is automatically created between the time shown and up to 45 minutes after.
    - `snapshot_time_of_day`**Type**: `STRING`**Provider name**: `snapshotTimeOfDay`**Description**: The daily time when an automatic snapshot is created. The time shown is in `HH:00` format, and in Coordinated Universal Time (UTC). The snapshot is automatically created between the time shown and up to 45 minutes after.
    - `status`**Type**: `STRING`**Provider name**: `status`**Description**: The status of the add-on.
    - `threshold`**Type**: `STRING`**Provider name**: `threshold`**Description**: The trigger threshold of the action.This add-on only applies to Lightsail for Research resources.
  - `arn`**Type**: `STRING`**Provider name**: `arn`**Description**: The Amazon Resource Name (ARN) of the disk.
  - `attached_to`**Type**: `STRING`**Provider name**: `attachedTo`**Description**: The resources to which the disk is attached.
  - `attachment_state`**Type**: `STRING`**Provider name**: `attachmentState`**Description**: (Discontinued) The attachment state of the disk.In releases prior to November 14, 2017, this parameter returned `attached` for system disks in the API response. It is now discontinued, but still included in the response. Use `isAttached` instead.
  - `auto_mount_status`**Type**: `STRING`**Provider name**: `autoMountStatus`**Description**: The status of automatically mounting a storage disk to a virtual computer.This parameter only applies to Lightsail for Research resources.
  - `created_at`**Type**: `TIMESTAMP`**Provider name**: `createdAt`**Description**: The date when the disk was created.
  - `gb_in_use`**Type**: `INT32`**Provider name**: `gbInUse`**Description**: (Discontinued) The number of GB in use by the disk.In releases prior to November 14, 2017, this parameter was not included in the API response. It is now discontinued.
  - `iops`**Type**: `INT32`**Provider name**: `iops`**Description**: The input/output operations per second (IOPS) of the disk.
  - `is_attached`**Type**: `BOOLEAN`**Provider name**: `isAttached`**Description**: A Boolean value indicating whether the disk is attached.
  - `is_system_disk`**Type**: `BOOLEAN`**Provider name**: `isSystemDisk`**Description**: A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
  - `location`**Type**: `STRUCT`**Provider name**: `location`**Description**: The AWS Region and Availability Zone where the disk is located.
    - `availability_zone`**Type**: `STRING`**Provider name**: `availabilityZone`**Description**: The Availability Zone. Follows the format `us-east-2a` (case-sensitive).
    - `region_name`**Type**: `STRING`**Provider name**: `regionName`**Description**: The Amazon Web Services Region name.
  - `name`**Type**: `STRING`**Provider name**: `name`**Description**: The unique name of the disk.
  - `path`**Type**: `STRING`**Provider name**: `path`**Description**: The disk path.
  - `resource_type`**Type**: `STRING`**Provider name**: `resourceType`**Description**: The Lightsail resource type (`Disk`).
  - `size_in_gb`**Type**: `INT32`**Provider name**: `sizeInGb`**Description**: The size of the disk in GB.
  - `state`**Type**: `STRING`**Provider name**: `state`**Description**: Describes the status of the disk.
  - `support_code`**Type**: `STRING`**Provider name**: `supportCode`**Description**: 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.
- `ram_size_in_gb`**Type**: `FLOAT`**Provider name**: `ramSizeInGb`**Description**: The amount of RAM in GB on the instance (`1.0`).

## `ip_address_type`{% #ip_address_type %}

**Type**: `STRING`**Provider name**: `ipAddressType`**Description**: 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`{% #ipv6_addresses %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `ipv6Addresses`**Description**: The IPv6 addresses of the instance.

## `is_static_ip`{% #is_static_ip %}

**Type**: `BOOLEAN`**Provider name**: `isStaticIp`**Description**: A Boolean value indicating whether this instance has a static IP assigned to it.

## `location`{% #location %}

**Type**: `STRUCT`**Provider name**: `location`**Description**: The region name and Availability Zone where the instance is located.

- `availability_zone`**Type**: `STRING`**Provider name**: `availabilityZone`**Description**: The Availability Zone. Follows the format `us-east-2a` (case-sensitive).
- `region_name`**Type**: `STRING`**Provider name**: `regionName`**Description**: The Amazon Web Services Region name.

## `metadata_options`{% #metadata_options %}

**Type**: `STRUCT`**Provider name**: `metadataOptions`**Description**: The metadata options for the Amazon Lightsail instance.

- `http_endpoint`**Type**: `STRING`**Provider name**: `httpEndpoint`**Description**: Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled. If the value is `disabled`, you cannot access your instance metadata.
- `http_protocol_ipv6`**Type**: `STRING`**Provider name**: `httpProtocolIpv6`**Description**: Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
- `http_put_response_hop_limit`**Type**: `INT32`**Provider name**: `httpPutResponseHopLimit`**Description**: The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther.
- `http_tokens`**Type**: `STRING`**Provider name**: `httpTokens`**Description**: The state of token usage for your instance metadata requests. If the state is `optional`, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned. If the state is `required`, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.Not all instance blueprints in Lightsail support version 2.0 credentials. Use the `MetadataNoToken` instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see [Viewing instance metrics in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-health-metrics) in the Amazon Lightsail Developer Guide.
- `state`**Type**: `STRING`**Provider name**: `state`**Description**: The state of the metadata option changes. The following states are possible:
  - `pending` - The metadata options are being updated. The instance is not yet ready to process metadata traffic with the new selection.
  - `applied` - The metadata options have been successfully applied to the instance.

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: The name the user gave the instance (`Amazon_Linux_2023-1`).

## `networking`{% #networking %}

**Type**: `STRUCT`**Provider name**: `networking`**Description**: Information about the public ports and monthly data transfer rates for the instance.

- `monthly_transfer`**Type**: `STRUCT`**Provider name**: `monthlyTransfer`**Description**: The amount of data in GB allocated for monthly data transfers.
  - `gb_per_month_allocated`**Type**: `INT32`**Provider name**: `gbPerMonthAllocated`**Description**: The amount allocated per month (in GB).
- `ports`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `ports`**Description**: An array of key-value pairs containing information about the ports on the instance.
  - `access_direction`**Type**: `STRING`**Provider name**: `accessDirection`**Description**: The access direction (`inbound` or `outbound`).Lightsail currently supports only `inbound` access direction.
  - `access_from`**Type**: `STRING`**Provider name**: `accessFrom`**Description**: The location from which access is allowed. For example, `Anywhere (0.0.0.0/0)`, or `Custom` if a specific IP address or range of IP addresses is allowed.
  - `access_type`**Type**: `STRING`**Provider name**: `accessType`**Description**: The type of access (`Public` or `Private`).
  - `cidr_list_aliases`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `cidrListAliases`**Description**: An alias that defines access for a preconfigured range of IP addresses. The only alias currently supported is `lightsail-connect`, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
  - `cidrs`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `cidrs`**Description**: The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.The `ipv6Cidrs` parameter lists the IPv6 addresses that are allowed to connect to an instance.For more information about CIDR block notation, see [Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) on Wikipedia.
  - `common_name`**Type**: `STRING`**Provider name**: `commonName`**Description**: The common name of the port information.
  - `from_port`**Type**: `INT32`**Provider name**: `fromPort`**Description**: The first port in a range of open ports on an instance. Allowed ports:
    - TCP and UDP - `0` to `65535`
    - ICMP - The ICMP type for IPv4 addresses. For example, specify `8` as the `fromPort` (ICMP type), and `-1` as the `toPort` (ICMP code), to enable ICMP Ping. For more information, see [Control Messages](https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) on Wikipedia.
    - ICMPv6 - The ICMP type for IPv6 addresses. For example, specify `128` as the `fromPort` (ICMPv6 type), and `0` as `toPort` (ICMPv6 code). For more information, see [Internet Control Message Protocol for IPv6](https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6).
  - `ipv6_cidrs`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `ipv6Cidrs`**Description**: The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.The `cidrs` parameter lists the IPv4 addresses that are allowed to connect to an instance.For more information about CIDR block notation, see [Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) on Wikipedia.
  - `protocol`**Type**: `STRING`**Provider name**: `protocol`**Description**: The IP protocol name. The name can be one of the following:
    - `tcp` - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
    - `all` - All transport layer protocol types. For more general information, see [Transport layer](https://en.wikipedia.org/wiki/Transport_layer) on Wikipedia.
    - `udp` - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
    - `icmp` - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify `icmp` as the `protocol`, you must specify the ICMP type using the `fromPort` parameter, and ICMP code using the `toPort` parameter.
    - `icmp6` - Internet Control Message Protocol (ICMP) for IPv6. When you specify `icmp6` as the `protocol`, you must specify the ICMP type using the `fromPort` parameter, and ICMP code using the `toPort` parameter.
  - `to_port`**Type**: `INT32`**Provider name**: `toPort`**Description**: The last port in a range of open ports on an instance. Allowed ports:
    - TCP and UDP - `0` to `65535`
    - ICMP - The ICMP code for IPv4 addresses. For example, specify `8` as the `fromPort` (ICMP type), and `-1` as the `toPort` (ICMP code), to enable ICMP Ping. For more information, see [Control Messages](https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) on Wikipedia.
    - ICMPv6 - The ICMP code for IPv6 addresses. For example, specify `128` as the `fromPort` (ICMPv6 type), and `0` as `toPort` (ICMPv6 code). For more information, see [Internet Control Message Protocol for IPv6](https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6).

## `port_states`{% #port_states %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `portStates`**Description**: An array of objects that describe the firewall port states for the specified instance.

- `cidr_list_aliases`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `cidrListAliases`**Description**: An alias that defines access for a preconfigured range of IP addresses. The only alias currently supported is `lightsail-connect`, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
- `cidrs`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `cidrs`**Description**: The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.The `ipv6Cidrs` parameter lists the IPv6 addresses that are allowed to connect to an instance.For more information about CIDR block notation, see [Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) on Wikipedia.
- `from_port`**Type**: `INT32`**Provider name**: `fromPort`**Description**: The first port in a range of open ports on an instance. Allowed ports:
  - TCP and UDP - `0` to `65535`
  - ICMP - The ICMP type for IPv4 addresses. For example, specify `8` as the `fromPort` (ICMP type), and `-1` as the `toPort` (ICMP code), to enable ICMP Ping. For more information, see [Control Messages](https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) on Wikipedia.
  - ICMPv6 - The ICMP type for IPv6 addresses. For example, specify `128` as the `fromPort` (ICMPv6 type), and `0` as `toPort` (ICMPv6 code). For more information, see [Internet Control Message Protocol for IPv6](https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6).
- `ipv6_cidrs`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `ipv6Cidrs`**Description**: The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.The `cidrs` parameter lists the IPv4 addresses that are allowed to connect to an instance.For more information about CIDR block notation, see [Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) on Wikipedia.
- `protocol`**Type**: `STRING`**Provider name**: `protocol`**Description**: The IP protocol name. The name can be one of the following:
  - `tcp` - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
  - `all` - All transport layer protocol types. For more general information, see [Transport layer](https://en.wikipedia.org/wiki/Transport_layer) on Wikipedia.
  - `udp` - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
  - `icmp` - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify `icmp` as the `protocol`, you must specify the ICMP type using the `fromPort` parameter, and ICMP code using the `toPort` parameter.
  - `icmp6` - Internet Control Message Protocol (ICMP) for IPv6. When you specify `icmp6` as the `protocol`, you must specify the ICMP type using the `fromPort` parameter, and ICMP code using the `toPort` parameter.
- `state`**Type**: `STRING`**Provider name**: `state`**Description**: Specifies whether the instance port is `open` or `closed`.The port state for Lightsail instances is always `open`.
- `to_port`**Type**: `INT32`**Provider name**: `toPort`**Description**: The last port in a range of open ports on an instance. Allowed ports:
  - TCP and UDP - `0` to `65535`
  - ICMP - The ICMP code for IPv4 addresses. For example, specify `8` as the `fromPort` (ICMP type), and `-1` as the `toPort` (ICMP code), to enable ICMP Ping. For more information, see [Control Messages](https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages) on Wikipedia.
  - ICMPv6 - The ICMP code for IPv6 addresses. For example, specify `128` as the `fromPort` (ICMPv6 type), and `0` as `toPort` (ICMPv6 code). For more information, see [Internet Control Message Protocol for IPv6](https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6).

## `private_ip_address`{% #private_ip_address %}

**Type**: `STRING`**Provider name**: `privateIpAddress`**Description**: The private IP address of the instance.

## `public_ip_address`{% #public_ip_address %}

**Type**: `STRING`**Provider name**: `publicIpAddress`**Description**: The public IP address of the instance.

## `resource_type`{% #resource_type %}

**Type**: `STRING`**Provider name**: `resourceType`**Description**: The type of resource (usually `Instance`).

## `ssh_key_name`{% #ssh_key_name %}

**Type**: `STRING`**Provider name**: `sshKeyName`**Description**: The name of the SSH key being used to connect to the instance (`LightsailDefaultKeyPair`).

## `state`{% #state %}

**Type**: `STRUCT`**Provider name**: `state`**Description**: The status code and the state (`running`) for the instance.

- `code`**Type**: `INT32`**Provider name**: `code`**Description**: The status code for the instance.
- `name`**Type**: `STRING`**Provider name**: `name`**Description**: The state of the instance (`running` or `pending`).

## `support_code`{% #support_code %}

**Type**: `STRING`**Provider name**: `supportCode`**Description**: 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`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `username`{% #username %}

**Type**: `STRING`**Provider name**: `username`**Description**: The user name for connecting to the instance (`ec2-user`).