Class InstanceEntry
- java.lang.Object
-
- software.amazon.awssdk.services.lightsail.model.InstanceEntry
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<InstanceEntry.Builder,InstanceEntry>
@Generated("software.amazon.awssdk:codegen") public final class InstanceEntry extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceEntry.Builder,InstanceEntry>
Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the
create cloud formation stackoperation.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceInstanceEntry.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringavailabilityZone()The Availability Zone for the new Amazon EC2 instance.static InstanceEntry.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringinstanceType()The instance type (t2.micro) to use for the new Amazon EC2 instance.PortInfoSourceTypeportInfoSource()The port configuration to use for the new Amazon EC2 instance.StringportInfoSourceAsString()The port configuration to use for the new Amazon EC2 instance.List<SdkField<?>>sdkFields()static Class<? extends InstanceEntry.Builder>serializableBuilderClass()StringsourceName()The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance.InstanceEntry.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringuserData()A launch script you can create that configures a server with additional user data.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
sourceName
public final String sourceName()
The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance.
Use the
get export snapshot recordsoperation to get a list of export snapshot records that you can use to create a CloudFormation stack.- Returns:
- The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will
be used as the source of the new Amazon EC2 instance.
Use the
get export snapshot recordsoperation to get a list of export snapshot records that you can use to create a CloudFormation stack.
-
instanceType
public final String instanceType()
The instance type (
t2.micro) to use for the new Amazon EC2 instance.- Returns:
- The instance type (
t2.micro) to use for the new Amazon EC2 instance.
-
portInfoSource
public final PortInfoSourceType portInfoSource()
The port configuration to use for the new Amazon EC2 instance.
The following configuration options are available:
-
DEFAULT- Use the default firewall settings from the Lightsail instance blueprint. If this is specified, then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. -
INSTANCE- Use the configured firewall settings from the source Lightsail instance. If this is specified, the new instance that is created in Amazon EC2 will be configured to match the configuration of the source Lightsail instance. For example, if the source instance is configured for dual-stack (IPv4 and IPv6), then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. If the source instance is configured for IPv4 only, then only IPv4 will be configured for the new instance that is created in Amazon EC2. -
NONE- Use the default Amazon EC2 security group. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2. -
CLOSED- All ports closed. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2.
If you configured
lightsail-connectas acidrListAliaseson your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to connect to your instance, that configuration is not carried over to your new Amazon EC2 instance.If the service returns an enum value that is not available in the current SDK version,
portInfoSourcewill returnPortInfoSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromportInfoSourceAsString().- Returns:
- The port configuration to use for the new Amazon EC2 instance.
The following configuration options are available:
-
DEFAULT- Use the default firewall settings from the Lightsail instance blueprint. If this is specified, then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. -
INSTANCE- Use the configured firewall settings from the source Lightsail instance. If this is specified, the new instance that is created in Amazon EC2 will be configured to match the configuration of the source Lightsail instance. For example, if the source instance is configured for dual-stack (IPv4 and IPv6), then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. If the source instance is configured for IPv4 only, then only IPv4 will be configured for the new instance that is created in Amazon EC2. -
NONE- Use the default Amazon EC2 security group. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2. -
CLOSED- All ports closed. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2.
If you configured
lightsail-connectas acidrListAliaseson your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to connect to your instance, that configuration is not carried over to your new Amazon EC2 instance. -
- See Also:
PortInfoSourceType
-
-
portInfoSourceAsString
public final String portInfoSourceAsString()
The port configuration to use for the new Amazon EC2 instance.
The following configuration options are available:
-
DEFAULT- Use the default firewall settings from the Lightsail instance blueprint. If this is specified, then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. -
INSTANCE- Use the configured firewall settings from the source Lightsail instance. If this is specified, the new instance that is created in Amazon EC2 will be configured to match the configuration of the source Lightsail instance. For example, if the source instance is configured for dual-stack (IPv4 and IPv6), then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. If the source instance is configured for IPv4 only, then only IPv4 will be configured for the new instance that is created in Amazon EC2. -
NONE- Use the default Amazon EC2 security group. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2. -
CLOSED- All ports closed. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2.
If you configured
lightsail-connectas acidrListAliaseson your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to connect to your instance, that configuration is not carried over to your new Amazon EC2 instance.If the service returns an enum value that is not available in the current SDK version,
portInfoSourcewill returnPortInfoSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromportInfoSourceAsString().- Returns:
- The port configuration to use for the new Amazon EC2 instance.
The following configuration options are available:
-
DEFAULT- Use the default firewall settings from the Lightsail instance blueprint. If this is specified, then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. -
INSTANCE- Use the configured firewall settings from the source Lightsail instance. If this is specified, the new instance that is created in Amazon EC2 will be configured to match the configuration of the source Lightsail instance. For example, if the source instance is configured for dual-stack (IPv4 and IPv6), then IPv4 and IPv6 will be configured for the new instance that is created in Amazon EC2. If the source instance is configured for IPv4 only, then only IPv4 will be configured for the new instance that is created in Amazon EC2. -
NONE- Use the default Amazon EC2 security group. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2. -
CLOSED- All ports closed. If this is specified, then only IPv4 will be configured for the new instance that is created in Amazon EC2.
If you configured
lightsail-connectas acidrListAliaseson your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to connect to your instance, that configuration is not carried over to your new Amazon EC2 instance. -
- See Also:
PortInfoSourceType
-
-
userData
public final String userData()
A launch script you can create that configures a server with additional user data. For example, you might want to run
apt-get -y update.Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use
yum, Debian and Ubuntu useapt-get, and FreeBSD usespkg.- Returns:
- A launch script you can create that configures a server with additional user data. For example, you might
want to run
apt-get -y update.Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use
yum, Debian and Ubuntu useapt-get, and FreeBSD usespkg.
-
availabilityZone
public final String availabilityZone()
The Availability Zone for the new Amazon EC2 instance.
- Returns:
- The Availability Zone for the new Amazon EC2 instance.
-
toBuilder
public InstanceEntry.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<InstanceEntry.Builder,InstanceEntry>
-
builder
public static InstanceEntry.Builder builder()
-
serializableBuilderClass
public static Class<? extends InstanceEntry.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-