software.amazon.awssdk.services.lightsail.model

Class CreateInstancesFromSnapshotRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lightsail.model.LightsailRequest

software.amazon.awssdk.services.lightsail.model.CreateInstancesFromSnapshotRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateInstancesFromSnapshotRequest.Builder,CreateInstancesFromSnapshotRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateInstancesFromSnapshotRequest
extends LightsailRequest
implements ToCopyableBuilder<CreateInstancesFromSnapshotRequest.Builder,CreateInstancesFromSnapshotRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateInstancesFromSnapshotRequest.Builder

Method Summary

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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasInstanceNames

public final 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). For responses returned by the SDK, the sender is the AWS service.

instanceNames

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.

Returns:

The names for your new instances.

hasAttachedDiskMapping

public final 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). For responses returned by the SDK, the sender is the AWS service.

attachedDiskMapping

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.

Returns:

An object containing information about one or more disk mappings.

availabilityZone

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.

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 the include Availability Zones parameter to your request.

instanceSnapshotName

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.

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. The instance snapshot name and source instance name parameters are mutually exclusive.

bundleId

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).

Returns:

The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).

userData

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.

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 use apt-get, and FreeBSD uses pkg. For a complete list, see the Dev Guide.

keyPairName

public final String keyPairName()

The name for your key pair.

Returns:

The name for your key pair.

hasTags

public final 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). For responses returned by the SDK, the sender is the AWS service.

tags

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.

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()

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). For responses returned by the SDK, the sender is the AWS service.

addOns

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.

Returns:

An array of objects representing the add-ons to enable for the new instance.

ipAddressType

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().

Returns:

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.

See Also:

IpAddressType

ipAddressTypeAsString

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().

Returns:

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.

See Also:

IpAddressType

sourceInstanceName

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.

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. 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.

restoreDate

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.

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. 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.

useLatestRestorableAutoSnapshot

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.

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. 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.

toBuilder

public CreateInstancesFromSnapshotRequest.Builder 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 interface ToCopyableBuilder<CreateInstancesFromSnapshotRequest.Builder,CreateInstancesFromSnapshotRequest>

Specified by:

toBuilder in class LightsailRequest

Returns:

a builder for type T

builder

public static CreateInstancesFromSnapshotRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateInstancesFromSnapshotRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

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

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.