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>

  • Method Details

    • 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:

      Returns:
      The name of the source instance or disk from which the source automatic snapshot was created.

      Constraint:

    • 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:

    • 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:

    • toBuilder

      public CopySnapshotRequest.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<CopySnapshotRequest.Builder,CopySnapshotRequest>
      Specified by:
      toBuilder in class LightsailRequest
      Returns:
      a builder for type T

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