Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Lightsail.Types.Instance

Description

Synopsis

data Instance = Instance' {
- addOns :: Maybe [AddOn]
- arn :: Maybe Text
- blueprintId :: Maybe Text
- blueprintName :: Maybe Text
- bundleId :: Maybe Text
- createdAt :: Maybe POSIX
- hardware :: Maybe InstanceHardware
- ipAddressType :: Maybe IpAddressType
- ipv6Addresses :: Maybe [Text]
- isStaticIp :: Maybe Bool
- location :: Maybe ResourceLocation
- metadataOptions :: Maybe InstanceMetadataOptions
- name :: Maybe Text
- networking :: Maybe InstanceNetworking
- privateIpAddress :: Maybe Text
- publicIpAddress :: Maybe Text
- resourceType :: Maybe ResourceType
- sshKeyName :: Maybe Text
- state :: Maybe InstanceState
- supportCode :: Maybe Text
- tags :: Maybe [Tag]
- username :: Maybe Text
}
newInstance :: Instance
instance_addOns :: Lens' Instance (Maybe [AddOn])
instance_arn :: Lens' Instance (Maybe Text)
instance_blueprintId :: Lens' Instance (Maybe Text)
instance_blueprintName :: Lens' Instance (Maybe Text)
instance_bundleId :: Lens' Instance (Maybe Text)
instance_createdAt :: Lens' Instance (Maybe UTCTime)
instance_hardware :: Lens' Instance (Maybe InstanceHardware)
instance_ipAddressType :: Lens' Instance (Maybe IpAddressType)
instance_ipv6Addresses :: Lens' Instance (Maybe [Text])
instance_isStaticIp :: Lens' Instance (Maybe Bool)
instance_location :: Lens' Instance (Maybe ResourceLocation)
instance_metadataOptions :: Lens' Instance (Maybe InstanceMetadataOptions)
instance_name :: Lens' Instance (Maybe Text)
instance_networking :: Lens' Instance (Maybe InstanceNetworking)
instance_privateIpAddress :: Lens' Instance (Maybe Text)
instance_publicIpAddress :: Lens' Instance (Maybe Text)
instance_resourceType :: Lens' Instance (Maybe ResourceType)
instance_sshKeyName :: Lens' Instance (Maybe Text)
instance_state :: Lens' Instance (Maybe InstanceState)
instance_supportCode :: Lens' Instance (Maybe Text)
instance_tags :: Lens' Instance (Maybe [Tag])
instance_username :: Lens' Instance (Maybe Text)

Documentation

data Instance Source #

Describes an instance (a virtual private server).

See: newInstance smart constructor.

Constructors

Instance'

Fields

addOns :: Maybe [AddOn]
An array of objects representing the add-ons enabled on the instance.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
blueprintId :: Maybe Text
The blueprint ID (e.g., os_amlinux_2016_03).
blueprintName :: Maybe Text
The friendly name of the blueprint (e.g., Amazon Linux).
bundleId :: Maybe Text
The bundle for the instance (e.g., micro_1_0).
createdAt :: Maybe POSIX
The timestamp when the instance was created (e.g., 1479734909.17) in Unix time format.
hardware :: Maybe InstanceHardware
The size of the vCPU and the amount of RAM for the instance.
ipAddressType :: Maybe IpAddressType
The IP address type of the instance.
The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
ipv6Addresses :: Maybe [Text]
The IPv6 addresses of the instance.
isStaticIp :: Maybe Bool
A Boolean value indicating whether this instance has a static IP assigned to it.
location :: Maybe ResourceLocation
The region name and Availability Zone where the instance is located.
metadataOptions :: Maybe InstanceMetadataOptions
The metadata options for the Amazon Lightsail instance.
name :: Maybe Text
The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).
networking :: Maybe InstanceNetworking
Information about the public ports and monthly data transfer rates for the instance.
privateIpAddress :: Maybe Text
The private IP address of the instance.
publicIpAddress :: Maybe Text
The public IP address of the instance.
resourceType :: Maybe ResourceType
The type of resource (usually Instance).
sshKeyName :: Maybe Text
The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).
state :: Maybe InstanceState
The status code and the state (e.g., running) for the instance.
supportCode :: Maybe Text
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 :: Maybe [Tag]
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
username :: Maybe Text
The user name for connecting to the instance (e.g., ec2-user).

Instances

Instances details

FromJSON Instance Source #
Instance details Defined in Amazonka.Lightsail.Types.Instance Methods parseJSON :: Value -> Parser Instance # parseJSONList :: Value -> Parser [Instance] #
Generic Instance Source #
Instance details Defined in Amazonka.Lightsail.Types.Instance Associated Types type Rep Instance :: Type -> Type # Methods from :: Instance -> Rep Instance x # to :: Rep Instance x -> Instance #
Read Instance Source #
Instance details Defined in Amazonka.Lightsail.Types.Instance Methods readsPrec :: Int -> ReadS Instance # readList :: ReadS [Instance] # readPrec :: ReadPrec Instance # readListPrec :: ReadPrec [Instance] #
Show Instance Source #
Instance details Defined in Amazonka.Lightsail.Types.Instance Methods showsPrec :: Int -> Instance -> ShowS # show :: Instance -> String # showList :: [Instance] -> ShowS #
NFData Instance Source #
Instance details Defined in Amazonka.Lightsail.Types.Instance Methods rnf :: Instance -> () #
Eq Instance Source #
Instance details Defined in Amazonka.Lightsail.Types.Instance Methods (==) :: Instance -> Instance -> Bool # (/=) :: Instance -> Instance -> Bool #
Hashable Instance Source #
Instance details Defined in Amazonka.Lightsail.Types.Instance Methods hashWithSalt :: Int -> Instance -> Int # hash :: Instance -> Int #
type Rep Instance Source #
Instance details Defined in Amazonka.Lightsail.Types.Instance type Rep Instance = D1 ('MetaData "Instance" "Amazonka.Lightsail.Types.Instance" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "Instance'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "addOns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AddOn])) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "blueprintId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "blueprintName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "bundleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "hardware") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceHardware)) :: S1 ('MetaSel ('Just "ipAddressType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpAddressType)))) :: (S1 ('MetaSel ('Just "ipv6Addresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "isStaticIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceLocation)))))) :: (((S1 ('MetaSel ('Just "metadataOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceMetadataOptions)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "networking") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceNetworking)) :: (S1 ('MetaSel ('Just "privateIpAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "publicIpAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType)) :: (S1 ('MetaSel ('Just "sshKeyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceState)))) :: (S1 ('MetaSel ('Just "supportCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newInstance :: Instance Source #

Create a value of Instance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:addOns:Instance', instance_addOns - An array of objects representing the add-ons enabled on the instance.

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

$sel:blueprintId:Instance', instance_blueprintId - The blueprint ID (e.g., os_amlinux_2016_03).

$sel:blueprintName:Instance', instance_blueprintName - The friendly name of the blueprint (e.g., Amazon Linux).

$sel:bundleId:Instance', instance_bundleId - The bundle for the instance (e.g., micro_1_0).

$sel:createdAt:Instance', instance_createdAt - The timestamp when the instance was created (e.g., 1479734909.17) in Unix time format.

$sel:hardware:Instance', instance_hardware - The size of the vCPU and the amount of RAM for the instance.

$sel:ipAddressType:Instance', instance_ipAddressType - The IP address type of the instance.

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

$sel:ipv6Addresses:Instance', instance_ipv6Addresses - The IPv6 addresses of the instance.

$sel:isStaticIp:Instance', instance_isStaticIp - A Boolean value indicating whether this instance has a static IP assigned to it.

$sel:location:Instance', instance_location - The region name and Availability Zone where the instance is located.

$sel:metadataOptions:Instance', instance_metadataOptions - The metadata options for the Amazon Lightsail instance.

Instance, instance_name - The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).

$sel:networking:Instance', instance_networking - Information about the public ports and monthly data transfer rates for the instance.

$sel:privateIpAddress:Instance', instance_privateIpAddress - The private IP address of the instance.

$sel:publicIpAddress:Instance', instance_publicIpAddress - The public IP address of the instance.

$sel:resourceType:Instance', instance_resourceType - The type of resource (usually Instance).

$sel:sshKeyName:Instance', instance_sshKeyName - The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).

Instance, instance_state - The status code and the state (e.g., running) for the instance.

$sel:supportCode:Instance', instance_supportCode - 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.

$sel:tags:Instance', instance_tags - The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

$sel:username:Instance', instance_username - The user name for connecting to the instance (e.g., ec2-user).

instance_addOns :: Lens' Instance (Maybe [AddOn]) Source #

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

instance_arn :: Lens' Instance (Maybe Text) Source #

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

instance_blueprintId :: Lens' Instance (Maybe Text) Source #

The blueprint ID (e.g., os_amlinux_2016_03).

instance_blueprintName :: Lens' Instance (Maybe Text) Source #

The friendly name of the blueprint (e.g., Amazon Linux).

instance_bundleId :: Lens' Instance (Maybe Text) Source #

The bundle for the instance (e.g., micro_1_0).

instance_createdAt :: Lens' Instance (Maybe UTCTime) Source #

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

instance_hardware :: Lens' Instance (Maybe InstanceHardware) Source #

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

instance_ipAddressType :: Lens' Instance (Maybe IpAddressType) Source #

The IP address type of the instance.

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

instance_ipv6Addresses :: Lens' Instance (Maybe [Text]) Source #

The IPv6 addresses of the instance.

instance_isStaticIp :: Lens' Instance (Maybe Bool) Source #

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

instance_location :: Lens' Instance (Maybe ResourceLocation) Source #

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

instance_metadataOptions :: Lens' Instance (Maybe InstanceMetadataOptions) Source #

The metadata options for the Amazon Lightsail instance.

instance_name :: Lens' Instance (Maybe Text) Source #

The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).

instance_networking :: Lens' Instance (Maybe InstanceNetworking) Source #

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

instance_privateIpAddress :: Lens' Instance (Maybe Text) Source #

The private IP address of the instance.

instance_publicIpAddress :: Lens' Instance (Maybe Text) Source #

The public IP address of the instance.

instance_resourceType :: Lens' Instance (Maybe ResourceType) Source #

The type of resource (usually Instance).

instance_sshKeyName :: Lens' Instance (Maybe Text) Source #

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

instance_state :: Lens' Instance (Maybe InstanceState) Source #

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

instance_supportCode :: Lens' Instance (Maybe Text) Source #

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.

instance_tags :: Lens' Instance (Maybe [Tag]) Source #

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

instance_username :: Lens' Instance (Maybe Text) Source #

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