Instance (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lightsail.model.Instance

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Instance
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes an instance (a virtual private server).

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Instance()

Constructors
Constructor and Description
`Instance()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Instance`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the instance (e.g., `arn:aws:lightsail:us-east-1:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE`).
`String`	`getBlueprintId()` The blueprint ID (e.g., `os_amlinux_2016_03`).
`String`	`getBlueprintName()` The friendly name of the blueprint (e.g., `Amazon Linux`).
`String`	`getBundleId()` The bundle for the instance (e.g., `micro_1_0`).
`Date`	`getCreatedAt()` The timestamp when the instance was created (e.g., `1479734909.17`).
`InstanceHardware`	`getHardware()` The size of the vCPU and the amount of RAM for the instance.
`String`	`getIpv6Address()` The IPv6 address of the instance.
`Boolean`	`getIsStaticIp()` A Boolean value indicating whether this instance has a static IP assigned to it.
`ResourceLocation`	`getLocation()` The region name and availability zone where the instance is located.
`String`	`getName()` The name the user gave the instance (e.g., `Amazon_Linux-1GB-Virginia-1`).
`InstanceNetworking`	`getNetworking()` Information about the public ports and monthly data transfer rates for the instance.
`String`	`getPrivateIpAddress()` The private IP address of the instance.
`String`	`getPublicIpAddress()` The public IP address of the instance.
`String`	`getResourceType()` The type of resource (usually `Instance`).
`String`	`getSshKeyName()` The name of the SSH key being used to connect to the instance (e.g., `LightsailDefaultKeyPair`).
`InstanceState`	`getState()` The status code and the state (e.g., `running`) for the instance.
`String`	`getSupportCode()` The support code.
`String`	`getUsername()` The user name for connecting to the instance (e.g., `ec2-user`).
`int`	`hashCode()`
`Boolean`	`isStaticIp()` A Boolean value indicating whether this instance has a static IP assigned to it.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the instance (e.g., `arn:aws:lightsail:us-east-1:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE`).
`void`	`setBlueprintId(String blueprintId)` The blueprint ID (e.g., `os_amlinux_2016_03`).
`void`	`setBlueprintName(String blueprintName)` The friendly name of the blueprint (e.g., `Amazon Linux`).
`void`	`setBundleId(String bundleId)` The bundle for the instance (e.g., `micro_1_0`).
`void`	`setCreatedAt(Date createdAt)` The timestamp when the instance was created (e.g., `1479734909.17`).
`void`	`setHardware(InstanceHardware hardware)` The size of the vCPU and the amount of RAM for the instance.
`void`	`setIpv6Address(String ipv6Address)` The IPv6 address of the instance.
`void`	`setIsStaticIp(Boolean isStaticIp)` A Boolean value indicating whether this instance has a static IP assigned to it.
`void`	`setLocation(ResourceLocation location)` The region name and availability zone where the instance is located.
`void`	`setName(String name)` The name the user gave the instance (e.g., `Amazon_Linux-1GB-Virginia-1`).
`void`	`setNetworking(InstanceNetworking networking)` Information about the public ports and monthly data transfer rates for the instance.
`void`	`setPrivateIpAddress(String privateIpAddress)` The private IP address of the instance.
`void`	`setPublicIpAddress(String publicIpAddress)` The public IP address of the instance.
`void`	`setResourceType(ResourceType resourceType)` The type of resource (usually `Instance`).
`void`	`setResourceType(String resourceType)` The type of resource (usually `Instance`).
`void`	`setSshKeyName(String sshKeyName)` The name of the SSH key being used to connect to the instance (e.g., `LightsailDefaultKeyPair`).
`void`	`setState(InstanceState state)` The status code and the state (e.g., `running`) for the instance.
`void`	`setSupportCode(String supportCode)` The support code.
`void`	`setUsername(String username)` The user name for connecting to the instance (e.g., `ec2-user`).
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Instance`	`withArn(String arn)` The Amazon Resource Name (ARN) of the instance (e.g., `arn:aws:lightsail:us-east-1:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE`).
`Instance`	`withBlueprintId(String blueprintId)` The blueprint ID (e.g., `os_amlinux_2016_03`).
`Instance`	`withBlueprintName(String blueprintName)` The friendly name of the blueprint (e.g., `Amazon Linux`).
`Instance`	`withBundleId(String bundleId)` The bundle for the instance (e.g., `micro_1_0`).
`Instance`	`withCreatedAt(Date createdAt)` The timestamp when the instance was created (e.g., `1479734909.17`).
`Instance`	`withHardware(InstanceHardware hardware)` The size of the vCPU and the amount of RAM for the instance.
`Instance`	`withIpv6Address(String ipv6Address)` The IPv6 address of the instance.
`Instance`	`withIsStaticIp(Boolean isStaticIp)` A Boolean value indicating whether this instance has a static IP assigned to it.
`Instance`	`withLocation(ResourceLocation location)` The region name and availability zone where the instance is located.
`Instance`	`withName(String name)` The name the user gave the instance (e.g., `Amazon_Linux-1GB-Virginia-1`).
`Instance`	`withNetworking(InstanceNetworking networking)` Information about the public ports and monthly data transfer rates for the instance.
`Instance`	`withPrivateIpAddress(String privateIpAddress)` The private IP address of the instance.
`Instance`	`withPublicIpAddress(String publicIpAddress)` The public IP address of the instance.
`Instance`	`withResourceType(ResourceType resourceType)` The type of resource (usually `Instance`).
`Instance`	`withResourceType(String resourceType)` The type of resource (usually `Instance`).
`Instance`	`withSshKeyName(String sshKeyName)` The name of the SSH key being used to connect to the instance (e.g., `LightsailDefaultKeyPair`).
`Instance`	`withState(InstanceState state)` The status code and the state (e.g., `running`) for the instance.
`Instance`	`withSupportCode(String supportCode)` The support code.
`Instance`	`withUsername(String username)` The user name for connecting to the instance (e.g., `ec2-user`).

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Instance
```
public Instance()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name the user gave the instance (e.g., Amazon_Linux-1GB-Virginia-1).
    
    Parameters:
    
    name - The name the user gave the instance (e.g., Amazon_Linux-1GB-Virginia-1).
  - getName
```
public String getName()
```
    The name the user gave the instance (e.g., Amazon_Linux-1GB-Virginia-1).
    
    Returns:
    
    The name the user gave the instance (e.g., Amazon_Linux-1GB-Virginia-1).
  - withName
```
public Instance withName(String name)
```
    The name the user gave the instance (e.g., Amazon_Linux-1GB-Virginia-1).
    
    Parameters:
    
    name - The name the user gave the instance (e.g., Amazon_Linux-1GB-Virginia-1).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-1:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-1:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-1:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
    
    Returns:
    
    The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-1:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
  - withArn
```
public Instance withArn(String arn)
```
    The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-1:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-1:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSupportCode
```
public void setSupportCode(String 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.
    
    Parameters:
    
    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.
  - getSupportCode
```
public String getSupportCode()
```
    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.
    
    Returns:
    
    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.
  - withSupportCode
```
public Instance withSupportCode(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The timestamp when the instance was created (e.g., 1479734909.17).
    
    Parameters:
    
    createdAt - The timestamp when the instance was created (e.g., 1479734909.17).
  - getCreatedAt
```
public Date getCreatedAt()
```
    The timestamp when the instance was created (e.g., 1479734909.17).
    
    Returns:
    
    The timestamp when the instance was created (e.g., 1479734909.17).
  - withCreatedAt
```
public Instance withCreatedAt(Date createdAt)
```
    The timestamp when the instance was created (e.g., 1479734909.17).
    
    Parameters:
    
    createdAt - The timestamp when the instance was created (e.g., 1479734909.17).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocation
```
public void setLocation(ResourceLocation location)
```
    The region name and availability zone where the instance is located.
    
    Parameters:
    
    location - The region name and availability zone where the instance is located.
  - getLocation
```
public ResourceLocation getLocation()
```
    The region name and availability zone where the instance is located.
    
    Returns:
    
    The region name and availability zone where the instance is located.
  - withLocation
```
public Instance withLocation(ResourceLocation location)
```
    The region name and availability zone where the instance is located.
    
    Parameters:
    
    location - The region name and availability zone where the instance is located.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceType
```
public void setResourceType(String resourceType)
```
    The type of resource (usually Instance).
    
    Parameters:
    
    resourceType - The type of resource (usually Instance).
    
    See Also:
    
    ResourceType
  - getResourceType
```
public String getResourceType()
```
    The type of resource (usually Instance).
    
    Returns:
    
    The type of resource (usually Instance).
    
    See Also:
    
    ResourceType
  - withResourceType
```
public Instance withResourceType(String resourceType)
```
    The type of resource (usually Instance).
    
    Parameters:
    
    resourceType - The type of resource (usually Instance).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - setResourceType
```
public void setResourceType(ResourceType resourceType)
```
    The type of resource (usually Instance).
    
    Parameters:
    
    resourceType - The type of resource (usually Instance).
    
    See Also:
    
    ResourceType
  - withResourceType
```
public Instance withResourceType(ResourceType resourceType)
```
    The type of resource (usually Instance).
    
    Parameters:
    
    resourceType - The type of resource (usually Instance).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - setBlueprintId
```
public void setBlueprintId(String blueprintId)
```
    The blueprint ID (e.g., os_amlinux_2016_03).
    
    Parameters:
    
    blueprintId - The blueprint ID (e.g., os_amlinux_2016_03).
  - getBlueprintId
```
public String getBlueprintId()
```
    The blueprint ID (e.g., os_amlinux_2016_03).
    
    Returns:
    
    The blueprint ID (e.g., os_amlinux_2016_03).
  - withBlueprintId
```
public Instance withBlueprintId(String blueprintId)
```
    The blueprint ID (e.g., os_amlinux_2016_03).
    
    Parameters:
    
    blueprintId - The blueprint ID (e.g., os_amlinux_2016_03).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBlueprintName
```
public void setBlueprintName(String blueprintName)
```
    The friendly name of the blueprint (e.g., Amazon Linux).
    
    Parameters:
    
    blueprintName - The friendly name of the blueprint (e.g., Amazon Linux).
  - getBlueprintName
```
public String getBlueprintName()
```
    The friendly name of the blueprint (e.g., Amazon Linux).
    
    Returns:
    
    The friendly name of the blueprint (e.g., Amazon Linux).
  - withBlueprintName
```
public Instance withBlueprintName(String blueprintName)
```
    The friendly name of the blueprint (e.g., Amazon Linux).
    
    Parameters:
    
    blueprintName - The friendly name of the blueprint (e.g., Amazon Linux).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBundleId
```
public void setBundleId(String bundleId)
```
    The bundle for the instance (e.g., micro_1_0).
    
    Parameters:
    
    bundleId - The bundle for the instance (e.g., micro_1_0).
  - getBundleId
```
public String getBundleId()
```
    The bundle for the instance (e.g., micro_1_0).
    
    Returns:
    
    The bundle for the instance (e.g., micro_1_0).
  - withBundleId
```
public Instance withBundleId(String bundleId)
```
    The bundle for the instance (e.g., micro_1_0).
    
    Parameters:
    
    bundleId - The bundle for the instance (e.g., micro_1_0).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsStaticIp
```
public void setIsStaticIp(Boolean isStaticIp)
```
    A Boolean value indicating whether this instance has a static IP assigned to it.
    
    Parameters:
    
    isStaticIp - A Boolean value indicating whether this instance has a static IP assigned to it.
  - getIsStaticIp
```
public Boolean getIsStaticIp()
```
    A Boolean value indicating whether this instance has a static IP assigned to it.
    
    Returns:
    
    A Boolean value indicating whether this instance has a static IP assigned to it.
  - withIsStaticIp
```
public Instance withIsStaticIp(Boolean isStaticIp)
```
    A Boolean value indicating whether this instance has a static IP assigned to it.
    
    Parameters:
    
    isStaticIp - A Boolean value indicating whether this instance has a static IP assigned to it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isStaticIp
```
public Boolean isStaticIp()
```
    A Boolean value indicating whether this instance has a static IP assigned to it.
    
    Returns:
    
    A Boolean value indicating whether this instance has a static IP assigned to it.
  - setPrivateIpAddress
```
public void setPrivateIpAddress(String privateIpAddress)
```
    The private IP address of the instance.
    
    Parameters:
    
    privateIpAddress - The private IP address of the instance.
  - getPrivateIpAddress
```
public String getPrivateIpAddress()
```
    The private IP address of the instance.
    
    Returns:
    
    The private IP address of the instance.
  - withPrivateIpAddress
```
public Instance withPrivateIpAddress(String privateIpAddress)
```
    The private IP address of the instance.
    
    Parameters:
    
    privateIpAddress - The private IP address of the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPublicIpAddress
```
public void setPublicIpAddress(String publicIpAddress)
```
    The public IP address of the instance.
    
    Parameters:
    
    publicIpAddress - The public IP address of the instance.
  - getPublicIpAddress
```
public String getPublicIpAddress()
```
    The public IP address of the instance.
    
    Returns:
    
    The public IP address of the instance.
  - withPublicIpAddress
```
public Instance withPublicIpAddress(String publicIpAddress)
```
    The public IP address of the instance.
    
    Parameters:
    
    publicIpAddress - The public IP address of the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpv6Address
```
public void setIpv6Address(String ipv6Address)
```
    The IPv6 address of the instance.
    
    Parameters:
    
    ipv6Address - The IPv6 address of the instance.
  - getIpv6Address
```
public String getIpv6Address()
```
    The IPv6 address of the instance.
    
    Returns:
    
    The IPv6 address of the instance.
  - withIpv6Address
```
public Instance withIpv6Address(String ipv6Address)
```
    The IPv6 address of the instance.
    
    Parameters:
    
    ipv6Address - The IPv6 address of the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHardware
```
public void setHardware(InstanceHardware hardware)
```
    The size of the vCPU and the amount of RAM for the instance.
    
    Parameters:
    
    hardware - The size of the vCPU and the amount of RAM for the instance.
  - getHardware
```
public InstanceHardware getHardware()
```
    The size of the vCPU and the amount of RAM for the instance.
    
    Returns:
    
    The size of the vCPU and the amount of RAM for the instance.
  - withHardware
```
public Instance withHardware(InstanceHardware hardware)
```
    The size of the vCPU and the amount of RAM for the instance.
    
    Parameters:
    
    hardware - The size of the vCPU and the amount of RAM for the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNetworking
```
public void setNetworking(InstanceNetworking networking)
```
    Information about the public ports and monthly data transfer rates for the instance.
    
    Parameters:
    
    networking - Information about the public ports and monthly data transfer rates for the instance.
  - getNetworking
```
public InstanceNetworking getNetworking()
```
    Information about the public ports and monthly data transfer rates for the instance.
    
    Returns:
    
    Information about the public ports and monthly data transfer rates for the instance.
  - withNetworking
```
public Instance withNetworking(InstanceNetworking networking)
```
    Information about the public ports and monthly data transfer rates for the instance.
    
    Parameters:
    
    networking - Information about the public ports and monthly data transfer rates for the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(InstanceState state)
```
    The status code and the state (e.g., running) for the instance.
    
    Parameters:
    
    state - The status code and the state (e.g., running) for the instance.
  - getState
```
public InstanceState getState()
```
    The status code and the state (e.g., running) for the instance.
    
    Returns:
    
    The status code and the state (e.g., running) for the instance.
  - withState
```
public Instance withState(InstanceState state)
```
    The status code and the state (e.g., running) for the instance.
    
    Parameters:
    
    state - The status code and the state (e.g., running) for the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsername
```
public void setUsername(String username)
```
    The user name for connecting to the instance (e.g., ec2-user).
    
    Parameters:
    
    username - The user name for connecting to the instance (e.g., ec2-user).
  - getUsername
```
public String getUsername()
```
    The user name for connecting to the instance (e.g., ec2-user).
    
    Returns:
    
    The user name for connecting to the instance (e.g., ec2-user).
  - withUsername
```
public Instance withUsername(String username)
```
    The user name for connecting to the instance (e.g., ec2-user).
    
    Parameters:
    
    username - The user name for connecting to the instance (e.g., ec2-user).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSshKeyName
```
public void setSshKeyName(String sshKeyName)
```
    The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).
    
    Parameters:
    
    sshKeyName - The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair ).
  - getSshKeyName
```
public String getSshKeyName()
```
    The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).
    
    Returns:
    
    The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair ).
  - withSshKeyName
```
public Instance withSshKeyName(String sshKeyName)
```
    The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).
    
    Parameters:
    
    sshKeyName - The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair ).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Instance clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Instance

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Instance

Method Detail

setName

getName

withName

setArn

getArn

withArn

setSupportCode

getSupportCode

withSupportCode

setCreatedAt

getCreatedAt

withCreatedAt

setLocation

getLocation

withLocation

setResourceType

getResourceType

withResourceType

setResourceType

withResourceType

setBlueprintId

getBlueprintId

withBlueprintId

setBlueprintName

getBlueprintName

withBlueprintName

setBundleId

getBundleId

withBundleId

setIsStaticIp

getIsStaticIp

withIsStaticIp

isStaticIp

setPrivateIpAddress

getPrivateIpAddress

withPrivateIpAddress

setPublicIpAddress

getPublicIpAddress

withPublicIpAddress

setIpv6Address

getIpv6Address

withIpv6Address

setHardware

getHardware

withHardware

setNetworking

getNetworking

withNetworking

setState

getState

withState

setUsername

getUsername

withUsername

setSshKeyName

getSshKeyName

withSshKeyName

toString

equals

hashCode

clone

marshall