@Generated(value="software.amazon.awssdk:codegen") public final class CreateInstancesFromSnapshotRequest extends LightsailRequest implements ToCopyableBuilder<CreateInstancesFromSnapshotRequest.Builder,CreateInstancesFromSnapshotRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateInstancesFromSnapshotRequest.Builder |
Modifier and Type | Method and Description |
---|---|
List<AddOnRequest> |
addOns()
An array of objects representing the add-ons to enable for the new instance.
|
Map<String,List<DiskMap>> |
attachedDiskMapping()
An object containing information about one or more disk mappings.
|
String |
availabilityZone()
The Availability Zone where you want to create your instances.
|
static CreateInstancesFromSnapshotRequest.Builder |
builder() |
String |
bundleId()
The bundle of specification information for your virtual private server (or instance), including the
pricing plan (e.g.,
micro_1_0 ). |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
boolean |
hasAddOns()
Returns true if the AddOns property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
boolean |
hasAttachedDiskMapping()
Returns true if the AttachedDiskMapping property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasInstanceNames()
Returns true if the InstanceNames property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
List<String> |
instanceNames()
The names for your new instances.
|
String |
instanceSnapshotName()
The name of the instance snapshot on which you are basing your new instances.
|
IpAddressType |
ipAddressType()
The IP address type for the instance.
|
String |
ipAddressTypeAsString()
The IP address type for the instance.
|
String |
keyPairName()
The name for your key pair.
|
String |
restoreDate()
The date of the automatic snapshot to use for the new instance.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateInstancesFromSnapshotRequest.Builder> |
serializableBuilderClass() |
String |
sourceInstanceName()
The name of the source instance from which the source automatic snapshot was created.
|
List<Tag> |
tags()
The tag keys and optional values to add to the resource during create.
|
CreateInstancesFromSnapshotRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
Boolean |
useLatestRestorableAutoSnapshot()
A Boolean value to indicate whether to use the latest available automatic snapshot.
|
String |
userData()
You can create a launch script that configures a server with additional user data.
|
overrideConfiguration
copy
public final boolean hasInstanceNames()
public final List<String> instanceNames()
The names for your new instances.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasInstanceNames()
to see if a value was sent in this field.
public final boolean hasAttachedDiskMapping()
public final Map<String,List<DiskMap>> 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.
You can use hasAttachedDiskMapping()
to see if a value was sent in this field.
public final String 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 the include Availability Zones
parameter to your request.
us-east-2a
(case sensitive). You can get a list of Availability Zones by using the get regions
operation. Be sure to add the include Availability Zones
parameter to your request.public final String 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. The
instance snapshot name
and source instance name
parameters are mutually exclusive.
Constraint:
This parameter cannot be defined together with the source instance name
parameter. The
instance snapshot name
and source instance name
parameters are mutually
exclusive.
public final String bundleId()
The bundle of specification information for your virtual private server (or instance), including the
pricing plan (e.g., micro_1_0
).
micro_1_0
).public final String 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 use apt-get
, and FreeBSD uses pkg
. For a
complete list, see the Dev Guide.
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 use apt-get
, and FreeBSD uses
pkg
. For a complete list, see the Dev Guide.
public final String keyPairName()
The name for your key pair.
public final boolean hasTags()
public final List<Tag> 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.
You can use hasTags()
to see if a value was sent in this field.
Use the TagResource
action to tag a resource after it's created.
public final boolean hasAddOns()
public final List<AddOnRequest> 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.
You can use hasAddOns()
to see if a value was sent in this field.
public final IpAddressType ipAddressType()
The IP address type for the instance.
The possible values are ipv4
for IPv4 only, and dualstack
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 return IpAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
ipAddressTypeAsString()
.
The possible values are ipv4
for IPv4 only, and dualstack
for IPv4 and IPv6.
The default value is dualstack
.
IpAddressType
public final String ipAddressTypeAsString()
The IP address type for the instance.
The possible values are ipv4
for IPv4 only, and dualstack
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 return IpAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
ipAddressTypeAsString()
.
The possible values are ipv4
for IPv4 only, and dualstack
for IPv4 and IPv6.
The default value is dualstack
.
IpAddressType
public final String 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. The
source instance name
and instance snapshot name
parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
Constraints:
This parameter cannot be defined together with the instance snapshot name
parameter. The
source instance name
and instance snapshot name
parameters are mutually
exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
public final String 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.
The restore date
and use 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 Lightsail Dev Guide.
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. The restore date
and use 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 Lightsail Dev Guide.
public final Boolean 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. The
use latest restorable auto snapshot
and restore date
parameters are mutually exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
Constraints:
This parameter cannot be defined together with the restore date
parameter. The
use latest restorable auto snapshot
and restore date
parameters are mutually
exclusive.
Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
public CreateInstancesFromSnapshotRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateInstancesFromSnapshotRequest.Builder,CreateInstancesFromSnapshotRequest>
toBuilder
in class LightsailRequest
public static CreateInstancesFromSnapshotRequest.Builder builder()
public static Class<? extends CreateInstancesFromSnapshotRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.