Package software.amazon.awssdk.services.ec2.model

Class LockSnapshotResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.ec2.model.Ec2Response
software.amazon.awssdk.services.ec2.model.LockSnapshotResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<LockSnapshotResponse.Builder,LockSnapshotResponse>
@Generated("software.amazon.awssdk:codegen") public final class LockSnapshotResponse extends Ec2Response implements ToCopyableBuilder<LockSnapshotResponse.Builder,LockSnapshotResponse>

  • Method Details

    • snapshotId

      public final String snapshotId()

      The ID of the snapshot

      Returns:
      The ID of the snapshot

    • lockState

      public final LockState lockState()

      The state of the snapshot lock. Valid states include:

      • compliance-cooloff - The snapshot has been locked in compliance mode but it is still within the cooling-off period. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions.

      • governance - The snapshot is locked in governance mode. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions.

      • compliance - The snapshot is locked in compliance mode and the cooling-off period has expired. The snapshot can't be unlocked or deleted. The lock duration can only be increased by users with appropriate permissions.

      • expired - The snapshot was locked in compliance or governance mode but the lock duration has expired. The snapshot is not locked and can be deleted.

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

      Returns:
      The state of the snapshot lock. Valid states include:

      • compliance-cooloff - The snapshot has been locked in compliance mode but it is still within the cooling-off period. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions.

      • governance - The snapshot is locked in governance mode. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions.

      • compliance - The snapshot is locked in compliance mode and the cooling-off period has expired. The snapshot can't be unlocked or deleted. The lock duration can only be increased by users with appropriate permissions.

      • expired - The snapshot was locked in compliance or governance mode but the lock duration has expired. The snapshot is not locked and can be deleted.

      See Also:

    • lockStateAsString

      public final String lockStateAsString()

      The state of the snapshot lock. Valid states include:

      • compliance-cooloff - The snapshot has been locked in compliance mode but it is still within the cooling-off period. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions.

      • governance - The snapshot is locked in governance mode. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions.

      • compliance - The snapshot is locked in compliance mode and the cooling-off period has expired. The snapshot can't be unlocked or deleted. The lock duration can only be increased by users with appropriate permissions.

      • expired - The snapshot was locked in compliance or governance mode but the lock duration has expired. The snapshot is not locked and can be deleted.

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

      Returns:
      The state of the snapshot lock. Valid states include:

      • compliance-cooloff - The snapshot has been locked in compliance mode but it is still within the cooling-off period. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions.

      • governance - The snapshot is locked in governance mode. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions.

      • compliance - The snapshot is locked in compliance mode and the cooling-off period has expired. The snapshot can't be unlocked or deleted. The lock duration can only be increased by users with appropriate permissions.

      • expired - The snapshot was locked in compliance or governance mode but the lock duration has expired. The snapshot is not locked and can be deleted.

      See Also:

    • lockDuration

      public final Integer lockDuration()

      The period of time for which the snapshot is locked, in days.

      Returns:
      The period of time for which the snapshot is locked, in days.

    • coolOffPeriod

      public final Integer coolOffPeriod()

      The compliance mode cooling-off period, in hours.

      Returns:
      The compliance mode cooling-off period, in hours.

    • coolOffPeriodExpiresOn

      public final Instant coolOffPeriodExpiresOn()

      The date and time at which the compliance mode cooling-off period expires, in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ).

      Returns:
      The date and time at which the compliance mode cooling-off period expires, in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ).

    • lockCreatedOn

      public final Instant lockCreatedOn()

      The date and time at which the snapshot was locked, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

      Returns:
      The date and time at which the snapshot was locked, in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ).

    • lockExpiresOn

      public final Instant lockExpiresOn()

      The date and time at which the lock will expire, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

      Returns:
      The date and time at which the lock will expire, in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ).

    • lockDurationStartTime

      public final Instant lockDurationStartTime()

      The date and time at which the lock duration started, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ ).

      Returns:
      The date and time at which the lock duration started, in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ).

    • toBuilder

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

    • builder

      public static LockSnapshotResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.