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

Class LockSnapshotRequest

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

  • Method Details

    • snapshotId

      public final String snapshotId()

      The ID of the snapshot to lock.

      Returns:
      The ID of the snapshot to lock.

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • lockMode

      public final LockMode lockMode()

      The mode in which to lock the snapshot. Specify one of the following:

      • governance - Locks the snapshot in governance mode. Snapshots locked in governance mode can't be deleted until one of the following conditions are met:

        • The lock duration expires.

        • The snapshot is unlocked by a user with the appropriate permissions.

        Users with the appropriate IAM permissions can unlock the snapshot, increase or decrease the lock duration, and change the lock mode to compliance at any time.

        If you lock a snapshot in governance mode, omit CoolOffPeriod.

      • compliance - Locks the snapshot in compliance mode. Snapshots locked in compliance mode can't be unlocked by any user. They can be deleted only after the lock duration expires. Users can't decrease the lock duration or change the lock mode to governance. However, users with appropriate IAM permissions can increase the lock duration at any time.

        If you lock a snapshot in compliance mode, you can optionally specify CoolOffPeriod.

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

      Returns:
      The mode in which to lock the snapshot. Specify one of the following:

      • governance - Locks the snapshot in governance mode. Snapshots locked in governance mode can't be deleted until one of the following conditions are met:

        • The lock duration expires.

        • The snapshot is unlocked by a user with the appropriate permissions.

        Users with the appropriate IAM permissions can unlock the snapshot, increase or decrease the lock duration, and change the lock mode to compliance at any time.

        If you lock a snapshot in governance mode, omit CoolOffPeriod.

      • compliance - Locks the snapshot in compliance mode. Snapshots locked in compliance mode can't be unlocked by any user. They can be deleted only after the lock duration expires. Users can't decrease the lock duration or change the lock mode to governance. However, users with appropriate IAM permissions can increase the lock duration at any time.

        If you lock a snapshot in compliance mode, you can optionally specify CoolOffPeriod.

      See Also:

    • lockModeAsString

      public final String lockModeAsString()

      The mode in which to lock the snapshot. Specify one of the following:

      • governance - Locks the snapshot in governance mode. Snapshots locked in governance mode can't be deleted until one of the following conditions are met:

        • The lock duration expires.

        • The snapshot is unlocked by a user with the appropriate permissions.

        Users with the appropriate IAM permissions can unlock the snapshot, increase or decrease the lock duration, and change the lock mode to compliance at any time.

        If you lock a snapshot in governance mode, omit CoolOffPeriod.

      • compliance - Locks the snapshot in compliance mode. Snapshots locked in compliance mode can't be unlocked by any user. They can be deleted only after the lock duration expires. Users can't decrease the lock duration or change the lock mode to governance. However, users with appropriate IAM permissions can increase the lock duration at any time.

        If you lock a snapshot in compliance mode, you can optionally specify CoolOffPeriod.

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

      Returns:
      The mode in which to lock the snapshot. Specify one of the following:

      • governance - Locks the snapshot in governance mode. Snapshots locked in governance mode can't be deleted until one of the following conditions are met:

        • The lock duration expires.

        • The snapshot is unlocked by a user with the appropriate permissions.

        Users with the appropriate IAM permissions can unlock the snapshot, increase or decrease the lock duration, and change the lock mode to compliance at any time.

        If you lock a snapshot in governance mode, omit CoolOffPeriod.

      • compliance - Locks the snapshot in compliance mode. Snapshots locked in compliance mode can't be unlocked by any user. They can be deleted only after the lock duration expires. Users can't decrease the lock duration or change the lock mode to governance. However, users with appropriate IAM permissions can increase the lock duration at any time.

        If you lock a snapshot in compliance mode, you can optionally specify CoolOffPeriod.

      See Also:

    • coolOffPeriod

      public final Integer coolOffPeriod()

      The cooling-off period during which you can unlock the snapshot or modify the lock settings after locking the snapshot in compliance mode, in hours. After the cooling-off period expires, you can't unlock or delete the snapshot, decrease the lock duration, or change the lock mode. You can increase the lock duration after the cooling-off period expires.

      The cooling-off period is optional when locking a snapshot in compliance mode. If you are locking the snapshot in governance mode, omit this parameter.

      To lock the snapshot in compliance mode immediately without a cooling-off period, omit this parameter.

      If you are extending the lock duration for a snapshot that is locked in compliance mode after the cooling-off period has expired, omit this parameter. If you specify a cooling-period in a such a request, the request fails.

      Allowed values: Min 1, max 72.

      Returns:
      The cooling-off period during which you can unlock the snapshot or modify the lock settings after locking the snapshot in compliance mode, in hours. After the cooling-off period expires, you can't unlock or delete the snapshot, decrease the lock duration, or change the lock mode. You can increase the lock duration after the cooling-off period expires.

      The cooling-off period is optional when locking a snapshot in compliance mode. If you are locking the snapshot in governance mode, omit this parameter.

      To lock the snapshot in compliance mode immediately without a cooling-off period, omit this parameter.

      If you are extending the lock duration for a snapshot that is locked in compliance mode after the cooling-off period has expired, omit this parameter. If you specify a cooling-period in a such a request, the request fails.

      Allowed values: Min 1, max 72.

    • lockDuration

      public final Integer lockDuration()

      The period of time for which to lock the snapshot, in days. The snapshot lock will automatically expire after this period lapses.

      You must specify either this parameter or ExpirationDate, but not both.

      Allowed values: Min: 1, max 36500

      Returns:
      The period of time for which to lock the snapshot, in days. The snapshot lock will automatically expire after this period lapses.

      You must specify either this parameter or ExpirationDate, but not both.

      Allowed values: Min: 1, max 36500

    • expirationDate

      public final Instant expirationDate()

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

      You must specify either this parameter or LockDuration, but not both.

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

      You must specify either this parameter or LockDuration, but not both.

    • toBuilder

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

    • builder

      public static LockSnapshotRequest.Builder builder()

    • serializableBuilderClass

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