Class CreateInstancesFromSnapshotRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateInstancesFromSnapshotRequest.Builder,
CreateInstancesFromSnapshotRequest>
-
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.An object containing information about one or more disk mappings.final String
The Availability Zone where you want to create your instances.builder()
final String
bundleId()
The bundle of specification information for your virtual private server (or instance), including the pricing plan (micro_1_0
).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 boolean
For responses, this returns true if the service returned a value for the AttachedDiskMapping 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 for your new instances.final String
The name of the instance snapshot on which you are basing your new instances.final IpAddressType
The IP address type for the instance.final String
The IP address type for the instance.final String
The name for your key pair.final String
The date of the automatic snapshot to use for the new instance.static Class
<? extends CreateInstancesFromSnapshotRequest.Builder> final String
The name of the source instance from which the source automatic snapshot was created.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 Boolean
A Boolean value to indicate whether to use the latest available automatic snapshot.final String
userData()
You can create a launch script 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 for your new instances.
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 for your new instances.
-
hasAttachedDiskMapping
public final boolean hasAttachedDiskMapping()For responses, this returns true if the service returned a value for the AttachedDiskMapping 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. -
attachedDiskMapping
An object containing information about one or more disk mappings.
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
hasAttachedDiskMapping()
method.- Returns:
- An object containing information about one or more disk mappings.
-
availabilityZone
The Availability Zone where you want to create your instances. Use the following formatting:
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 where you want to create your instances. Use the following formatting:
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.
-
instanceSnapshotName
The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.
Constraint:
-
This parameter cannot be defined together with the
source instance name
parameter. Theinstance snapshot name
andsource instance name
parameters are mutually exclusive.
- Returns:
- The name of the instance snapshot on which you are basing your new instances. Use the get instance
snapshots operation to return information about your existing snapshots.
Constraint:
-
This parameter cannot be defined together with the
source instance name
parameter. Theinstance snapshot name
andsource instance name
parameters are mutually exclusive.
-
-
-
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
You can create a launch script that configures a server with additional user data. For example,
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:
- You can create a launch script that configures a server with additional user data. For example,
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 for your key pair.
- Returns:
- The name for 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:
-
sourceInstanceName
The name of the source instance from which the source automatic snapshot was created.
Constraints:
-
This parameter cannot be defined together with the
instance snapshot name
parameter. Thesource instance name
andinstance snapshot name
parameters are mutually exclusive. -
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
- Returns:
- The name of the source instance from which the source automatic snapshot was created.
Constraints:
-
This parameter cannot be defined together with the
instance snapshot name
parameter. Thesource instance name
andinstance snapshot name
parameters are mutually exclusive. -
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
-
-
-
restoreDate
The date of the automatic snapshot to use for the new instance. Use the
get auto snapshots
operation to identify the dates of the available automatic snapshots.Constraints:
-
Must be specified in
YYYY-MM-DD
format. -
This parameter cannot be defined together with the
use latest restorable auto snapshot
parameter. Therestore date
anduse latest restorable auto snapshot
parameters are mutually exclusive. -
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
- Returns:
- The date of the automatic snapshot to use for the new instance. Use the
get auto snapshots
operation to identify the dates of the available automatic snapshots.Constraints:
-
Must be specified in
YYYY-MM-DD
format. -
This parameter cannot be defined together with the
use latest restorable auto snapshot
parameter. Therestore date
anduse latest restorable auto snapshot
parameters are mutually exclusive. -
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
-
-
-
useLatestRestorableAutoSnapshot
A Boolean value to indicate whether to use the latest available automatic snapshot.
Constraints:
-
This parameter cannot be defined together with the
restore date
parameter. Theuse latest restorable auto snapshot
andrestore date
parameters are mutually exclusive. -
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
- Returns:
- A Boolean value to indicate whether to use the latest available automatic snapshot.
Constraints:
-
This parameter cannot be defined together with the
restore date
parameter. Theuse latest restorable auto snapshot
andrestore date
parameters are mutually exclusive. -
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
-
-
-
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<CreateInstancesFromSnapshotRequest.Builder,
CreateInstancesFromSnapshotRequest> - Specified by:
toBuilder
in classLightsailRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends CreateInstancesFromSnapshotRequest.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
-