Class CreateDiskFromSnapshotRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDiskFromSnapshotRequest.Builder,
CreateDiskFromSnapshotRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<AddOnRequest> addOns()
An array of objects that represent the add-ons to enable for the new disk.final String
The Availability Zone where you want to create the disk (us-east-2a
).builder()
final String
diskName()
The unique Lightsail disk name (my-disk
).final String
The name of the disk snapshot (my-snapshot
) from which to create the new storage disk.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
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The date of the automatic snapshot to use for the new disk.static Class
<? extends CreateDiskFromSnapshotRequest.Builder> final Integer
sizeInGb()
The size of the disk in GB (32
).final String
The name of the source disk 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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
diskName
The unique Lightsail disk name (
my-disk
).- Returns:
- The unique Lightsail disk name (
my-disk
).
-
diskSnapshotName
The name of the disk snapshot (
my-snapshot
) from which to create the new storage disk.Constraint:
-
This parameter cannot be defined together with the
source disk name
parameter. Thedisk snapshot name
andsource disk name
parameters are mutually exclusive.
- Returns:
- The name of the disk snapshot (
my-snapshot
) from which to create the new storage disk.Constraint:
-
This parameter cannot be defined together with the
source disk name
parameter. Thedisk snapshot name
andsource disk name
parameters are mutually exclusive.
-
-
-
availabilityZone
The Availability Zone where you want to create the disk (
us-east-2a
). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
- Returns:
- The Availability Zone where you want to create the disk (
us-east-2a
). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
-
sizeInGb
The size of the disk in GB (
32
).- Returns:
- The size of the disk in GB (
32
).
-
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 that represent the add-ons to enable for the new disk.
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 that represent the add-ons to enable for the new disk.
-
sourceDiskName
The name of the source disk from which the source automatic snapshot was created.
Constraints:
-
This parameter cannot be defined together with the
disk snapshot name
parameter. Thesource disk name
anddisk snapshot name
parameters are mutually exclusive. -
Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.
- Returns:
- The name of the source disk from which the source automatic snapshot was created.
Constraints:
-
This parameter cannot be defined together with the
disk snapshot name
parameter. Thesource disk name
anddisk snapshot name
parameters are mutually exclusive. -
Define this parameter only when creating a new disk 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 disk. 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 disk 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 disk. 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 disk 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 disk 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 disk 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<CreateDiskFromSnapshotRequest.Builder,
CreateDiskFromSnapshotRequest> - 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
-