Class InstanceSnapshot

java.lang.Object
software.amazon.awssdk.services.lightsail.model.InstanceSnapshot
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InstanceSnapshot.Builder,InstanceSnapshot>
@Generated("software.amazon.awssdk:codegen") public final class InstanceSnapshot extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceSnapshot.Builder,InstanceSnapshot>

Describes an instance snapshot.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the snapshot.

      Returns:
      The name of the snapshot.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the snapshot ( arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

      Returns:
      The Amazon Resource Name (ARN) of the snapshot ( arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE ).

    • supportCode

      public final String supportCode()

      The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

      Returns:
      The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

    • createdAt

      public final Instant createdAt()

      The timestamp when the snapshot was created (1479907467.024).

      Returns:
      The timestamp when the snapshot was created (1479907467.024).

    • location

      public final ResourceLocation location()

      The region name and Availability Zone where you created the snapshot.

      Returns:
      The region name and Availability Zone where you created the snapshot.

    • resourceType

      public final ResourceType resourceType()

      The type of resource (usually InstanceSnapshot).

      If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

      Returns:
      The type of resource (usually InstanceSnapshot).
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of resource (usually InstanceSnapshot).

      If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

      Returns:
      The type of resource (usually InstanceSnapshot).
      See Also:

    • 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 the isEmpty() 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

      public final List<Tag> tags()

      The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

      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 for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

    • state

      public final InstanceSnapshotState state()

      The state the snapshot is in.

      If the service returns an enum value that is not available in the current SDK version, state will return InstanceSnapshotState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state the snapshot is in.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state the snapshot is in.

      If the service returns an enum value that is not available in the current SDK version, state will return InstanceSnapshotState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state the snapshot is in.
      See Also:

    • progress

      public final String progress()

      The progress of the snapshot.

      This is populated only for disk snapshots, and is null for instance snapshots.

      Returns:
      The progress of the snapshot.

      This is populated only for disk snapshots, and is null for instance snapshots.

    • hasFromAttachedDisks

      public final boolean hasFromAttachedDisks()
      For responses, this returns true if the service returned a value for the FromAttachedDisks property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • fromAttachedDisks

      public final List<Disk> fromAttachedDisks()

      An array of disk objects containing information about all block storage disks.

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

      Returns:
      An array of disk objects containing information about all block storage disks.

    • fromInstanceName

      public final String fromInstanceName()

      The instance from which the snapshot was created.

      Returns:
      The instance from which the snapshot was created.

    • fromInstanceArn

      public final String fromInstanceArn()

      The Amazon Resource Name (ARN) of the instance from which the snapshot was created ( arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

      Returns:
      The Amazon Resource Name (ARN) of the instance from which the snapshot was created ( arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

    • fromBlueprintId

      public final String fromBlueprintId()

      The blueprint ID from which you created the snapshot (amazon_linux_2023). A blueprint is a virtual private server (or instance) image used to create instances quickly.

      Returns:
      The blueprint ID from which you created the snapshot (amazon_linux_2023). A blueprint is a virtual private server (or instance) image used to create instances quickly.

    • fromBundleId

      public final String fromBundleId()

      The bundle ID from which you created the snapshot (micro_x_x).

      Returns:
      The bundle ID from which you created the snapshot (micro_x_x).

    • isFromAutoSnapshot

      public final Boolean isFromAutoSnapshot()

      A Boolean value indicating whether the snapshot was created from an automatic snapshot.

      Returns:
      A Boolean value indicating whether the snapshot was created from an automatic snapshot.

    • sizeInGb

      public final Integer sizeInGb()

      The size in GB of the SSD.

      Returns:
      The size in GB of the SSD.

    • toBuilder

      public InstanceSnapshot.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<InstanceSnapshot.Builder,InstanceSnapshot>
      Returns:
      a builder for type T

    • builder

      public static InstanceSnapshot.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.