Class: Aws::EC2::Types::LockSnapshotRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::LockSnapshotRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cool_off_period ⇒ Integer

  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.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #expiration_date ⇒ Time

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

• #lock_duration ⇒ Integer

  The period of time for which to lock the snapshot, in days.

• #lock_mode ⇒ String

  The mode in which to lock the snapshot.

• #snapshot_id ⇒ String

  The ID of the snapshot to lock.

Instance Attribute Details

#cool_off_period ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 49701

class LockSnapshotRequest < Struct.new(
  :snapshot_id,
  :dry_run,
  :lock_mode,
  :cool_off_period,
  :lock_duration,
  :expiration_date)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

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:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 49701

class LockSnapshotRequest < Struct.new(
  :snapshot_id,
  :dry_run,
  :lock_mode,
  :cool_off_period,
  :lock_duration,
  :expiration_date)
  SENSITIVE = []
  include Aws::Structure
end

#expiration_date ⇒ Time

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:

• (Time)

# File 'lib/aws-sdk-ec2/types.rb', line 49701

class LockSnapshotRequest < Struct.new(
  :snapshot_id,
  :dry_run,
  :lock_mode,
  :cool_off_period,
  :lock_duration,
  :expiration_date)
  SENSITIVE = []
  include Aws::Structure
end

#lock_duration ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 49701

class LockSnapshotRequest < Struct.new(
  :snapshot_id,
  :dry_run,
  :lock_mode,
  :cool_off_period,
  :lock_duration,
  :expiration_date)
  SENSITIVE = []
  include Aws::Structure
end

#lock_mode ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 49701

class LockSnapshotRequest < Struct.new(
  :snapshot_id,
  :dry_run,
  :lock_mode,
  :cool_off_period,
  :lock_duration,
  :expiration_date)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_id ⇒ String

The ID of the snapshot to lock.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 49701

class LockSnapshotRequest < Struct.new(
  :snapshot_id,
  :dry_run,
  :lock_mode,
  :cool_off_period,
  :lock_duration,
  :expiration_date)
  SENSITIVE = []
  include Aws::Structure
end