Class CreateInstancesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateInstancesRequest.Builder,
CreateInstancesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<AddOnRequest> addOns()
An array of objects representing the add-ons to enable for the new instance.final String
The Availability Zone in which to create your instance.final String
The ID for a virtual private server image (app_wordpress_4_4
orapp_lamp_7_0
).builder()
final String
bundleId()
The bundle of specification information for your virtual private server (or instance), including the pricing plan (micro_1_0
).final String
Deprecated.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AddOns property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InstanceNames property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.The names to use for your new Lightsail instances.final IpAddressType
The IP address type for the instance.final String
The IP address type for the instance.final String
The name of your key pair.static Class
<? extends CreateInstancesRequest.Builder> tags()
The tag keys and optional values to add to the resource during create.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userData()
A launch script you can create that configures a server with additional user data.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasInstanceNames
public final boolean hasInstanceNames()For responses, this returns true if the service returned a value for the InstanceNames property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
instanceNames
The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example:
["MyFirstInstance","MySecondInstance"]
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInstanceNames()
method.- Returns:
- The names to use for your new Lightsail instances. Separate multiple values using quotation marks and
commas, for example:
["MyFirstInstance","MySecondInstance"]
-
availabilityZone
The Availability Zone in which to create your instance. Use the following format:
us-east-2a
(case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add theinclude Availability Zones
parameter to your request.- Returns:
- The Availability Zone in which to create your instance. Use the following format:
us-east-2a
(case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add theinclude Availability Zones
parameter to your request.
-
customImageName
Deprecated.(Discontinued) The name for your custom image.
In releases prior to June 12, 2017, this parameter was ignored by the API. It is now discontinued.
- Returns:
- (Discontinued) The name for your custom image.
In releases prior to June 12, 2017, this parameter was ignored by the API. It is now discontinued.
-
blueprintId
The ID for a virtual private server image (
app_wordpress_4_4
orapp_lamp_7_0
). Use theget blueprints
operation to return a list of available images (or blueprints).Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
- Returns:
- The ID for a virtual private server image (
app_wordpress_4_4
orapp_lamp_7_0
). Use theget blueprints
operation to return a list of available images (or blueprints).Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
-
bundleId
The bundle of specification information for your virtual private server (or instance), including the pricing plan (
micro_1_0
).- Returns:
- The bundle of specification information for your virtual private server (or instance), including
the pricing plan (
micro_1_0
).
-
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
. For a complete list, see the Amazon Lightsail Developer Guide.- 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
. For a complete list, see the Amazon Lightsail Developer Guide.
-
keyPairName
The name of your key pair.
- Returns:
- The name of your key pair.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- The tag keys and optional values to add to the resource during create.
Use the
TagResource
action to tag a resource after it's created.
-
hasAddOns
public final boolean hasAddOns()For responses, this returns true if the service returned a value for the AddOns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
addOns
An array of objects representing the add-ons to enable for the new instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAddOns()
method.- Returns:
- An array of objects representing the add-ons to enable for the new instance.
-
ipAddressType
The IP address type for the instance.
The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6.The default value is
dualstack
.If the service returns an enum value that is not available in the current SDK version,
ipAddressType
will returnIpAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The IP address type for the instance.
The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6.The default value is
dualstack
. - See Also:
-
ipAddressTypeAsString
The IP address type for the instance.
The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6.The default value is
dualstack
.If the service returns an enum value that is not available in the current SDK version,
ipAddressType
will returnIpAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The IP address type for the instance.
The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6.The default value is
dualstack
. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateInstancesRequest.Builder,
CreateInstancesRequest> - Specified by:
toBuilder
in classLightsailRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-