Class CopySnapshotRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CopySnapshotRequest.Builder,
CopySnapshotRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CopySnapshotRequest.Builder
builder()
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 int
hashCode()
final String
The date of the source automatic snapshot to copy.static Class
<? extends CopySnapshotRequest.Builder> final RegionName
The Amazon Web Services Region where the source manual or automatic snapshot is located.final String
The Amazon Web Services Region where the source manual or automatic snapshot is located.final String
The name of the source instance or disk from which the source automatic snapshot was created.final String
The name of the source manual snapshot to copy.final String
The name of the new manual snapshot to be created as a copy.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 of the specified source instance or disk.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
sourceSnapshotName
The name of the source manual snapshot to copy.
Constraint:
-
Define this parameter only when copying a manual snapshot as another manual snapshot.
- Returns:
- The name of the source manual snapshot to copy.
Constraint:
-
Define this parameter only when copying a manual snapshot as another manual snapshot.
-
-
-
sourceResourceName
The name of the source instance or disk from which the source automatic snapshot was created.
Constraint:
-
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.
- Returns:
- The name of the source instance or disk from which the source automatic snapshot was created.
Constraint:
-
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.
-
-
-
restoreDate
The date of the source automatic snapshot to copy. 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 copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.
- Returns:
- The date of the source automatic snapshot to copy. 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 copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.
-
-
-
useLatestRestorableAutoSnapshot
A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.
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 copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.
- Returns:
- A Boolean value to indicate whether to use the latest available automatic snapshot of the specified
source instance or disk.
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 copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.
-
-
-
targetSnapshotName
The name of the new manual snapshot to be created as a copy.
- Returns:
- The name of the new manual snapshot to be created as a copy.
-
sourceRegion
The Amazon Web Services Region where the source manual or automatic snapshot is located.
If the service returns an enum value that is not available in the current SDK version,
sourceRegion
will returnRegionName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceRegionAsString()
.- Returns:
- The Amazon Web Services Region where the source manual or automatic snapshot is located.
- See Also:
-
sourceRegionAsString
The Amazon Web Services Region where the source manual or automatic snapshot is located.
If the service returns an enum value that is not available in the current SDK version,
sourceRegion
will returnRegionName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceRegionAsString()
.- Returns:
- The Amazon Web Services Region where the source manual or automatic snapshot is located.
- 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<CopySnapshotRequest.Builder,
CopySnapshotRequest> - 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
-