Package software.amazon.awssdk.services.lightsail.model

Class CopySnapshotRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CopySnapshotRequest.Builder,CopySnapshotRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CopySnapshotRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CopySnapshotRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	restoreDate()	The date of the source automatic snapshot to copy.
List<SdkField<?>>	sdkFields()
static Class<? extends CopySnapshotRequest.Builder>	serializableBuilderClass()
RegionName	sourceRegion()	The Amazon Web Services Region where the source manual or automatic snapshot is located.
String	sourceRegionAsString()	The Amazon Web Services Region where the source manual or automatic snapshot is located.
String	sourceResourceName()	The name of the source instance or disk from which the source automatic snapshot was created.
String	sourceSnapshotName()	The name of the source manual snapshot to copy.
String	targetSnapshotName()	The name of the new manual snapshot to be created as a copy.
CopySnapshotRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Boolean	useLatestRestorableAutoSnapshot()	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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

sourceSnapshotName

public final String 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

public final String 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

public final String 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. The restore date and use 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. The restore date and use 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

public final Boolean 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. The use latest restorable auto snapshot and restore 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. The use latest restorable auto snapshot and restore 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

public final String 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

public final RegionName 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 return RegionName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceRegionAsString().

Returns:

The Amazon Web Services Region where the source manual or automatic snapshot is located.

See Also:

RegionName

sourceRegionAsString

public final String 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 return RegionName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceRegionAsString().

Returns:

The Amazon Web Services Region where the source manual or automatic snapshot is located.

See Also:

RegionName

toBuilder

public CopySnapshotRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CopySnapshotRequest.Builder,CopySnapshotRequest>

Specified by:

toBuilder in class LightsailRequest

builder

public static CopySnapshotRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CopySnapshotRequest.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo